This page has been translated automatically.
Programming
Fundamentials
Setting Up Development Environment
UnigineScript
High-Level Systems
C++
C#
UUSL (Unified UNIGINE Shader Language)
File Formats
Rebuilding the Engine and Tools
GUI
Double Precision Coordinates
API
Core Library
Engine Classes
Node-Related Classes
Rendering-Related Classes
Physics-Related Classes
Bounds-Related Classes
GUI-Related Classes
Controls-Related Classes
Pathfinding-Related Classes
Utility Classes
Warning! This version of documentation is OUTDATED, as it describes an older SDK version! Please switch to the documentation for the latest SDK version.
Warning! This version of documentation describes an old SDK version which is no longer supported! Please upgrade to the latest SDK version.

ArrayMap Class (C++)

This class allows the use of UnigineScript maps.

To use this class, include the UnigineInterpreter.h file.

Unigine::ArrayMap Class

Members


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.

ArrayMap (const ArrayMap & map)

Copy constructor.

Arguments

  • const ArrayMap & map - Map.

~ArrayMap ()

Destructor.

ArrayMap & operator= (const ArrayMap & map)

Assignment operator for the map.

Arguments

  • const ArrayMap & map - Map to be assigned.

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

Map access.

Arguments

  • const Variable & key - Item key.

Return value

The item.

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.

const Variable & get (const Variable & key) const

Return an item by key.

Arguments

  • const Variable & key - Item key.

Return value

The item.

Iterator begin ()

Return an iterator referring to the first element.

Return value

Begin iterator.

Iterator back ()

Return an iterator referring to the back element.

Return value

Back iterator.

Iterator end ()

Return an iterator referring to the end element.

Return value

End iterator.

int size () const

Return map length.

Return value

Map length.

void clear () const

Clear all items of the map.

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.

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.
Last update: 2017-07-03
Build: ()