Unigine::ArrayMap Class

Header:

#include <UnigineInterpreter.h>

Allows using UnigineScript maps.

Methods:

Name	Description View: Sort by:
ArrayMap	Copy constructor.
set	Set an item by key.
get	Return a map from UnigineScript.
size	Return map length.
clear	Clear all items of the map.
append	Append an item with a given key to the map.
remove	Remove an item with a given key from the map.
back	Return an iterator referring to the back element.
begin	Return an iterator referring to the first element.
end	Return an iterator referring to the end element.
find	Find an item by a given key.
operator =	Assignment operator for the map.
operator []	Map access.

ArrayMap Class

Members

ArrayMap ( const ArrayMap & map ) #

Copy constructor.

Arguments

const ArrayMap & map - Map.

void set ( const Variable & key, const Variable & v ) const#

Set an item by key.

Arguments

const Variable & key - Item key.
const Variable & v - Item to set.

static ArrayMap get ( void * interpreter, const Variable & id ) #

Return a map from UnigineScript.

Arguments

void * interpreter - Interpreter pointer.
const Variable & id - Map ID.

Return value

The map.

const Variable & get ( const Variable & key ) const#

Return an item by key.

Arguments

const Variable & key - Item key.

Return value

The item.

int size ( ) const#

Return map length.

Return value

Map length.

void clear ( ) const#

Clear all items of the map.

void append ( const Variable & key, const Variable & v ) const#

Append an item with a given key to the map.

Arguments

const Variable & key - Item key.
const Variable & v - Item.

void remove ( const Variable & key ) const#

Remove an item with a given key from the map.

Arguments

const Variable & key - Item key.

Iterator back ( ) #

Return an iterator referring to the back element.

Return value

Back iterator.

Iterator begin ( ) #

Return an iterator referring to the first element.

Return value

Begin iterator.

Iterator end ( ) #

Return an iterator referring to the end element.

Return value

End iterator.

Iterator find ( const Variable & key ) const#

Find an item by a given key.

Arguments

const Variable & key - Item key.

Return value

Iterator to it if found; otherwise returns an iterator to end.

ArrayMap & operator= ( const ArrayMap & map ) #

Assignment operator for the map.

Arguments

const ArrayMap & map - Map to be assigned.

const Variable & operator[] ( const Variable & key ) const#

Map access.

Arguments

const Variable & key - Item key.

Return value

The item.

Last update: 2022-10-10

Help improve this article

Was this article helpful?

Report a problem related to this article

(or select a word/phrase and press Ctrl+Enter)