Drag[en]gine Script Module DragonScript  1.23
Dragengine.Utils.StringIDList Class Reference

Ordered list of unique StringID. More...

Inheritance diagram for Dragengine.Utils.StringIDList:

Public Member Functions

void add (StringID id)
 Add ID to list. More...
 
void addAll (StringIDList list)
 Add all IDs to list. More...
 
void addAllIfAbsent (StringIDList list)
 Add all absent IDs to list . More...
 
void addIfAbsent (StringID id)
 Add ID to list if absent. More...
 
void forEach (Block ablock)
 Visit IDs with block with parameter StringID. More...
 
StringID getAt (int index)
 ID at index. More...
 
int getCount ()
 Number of IDs. More...
 
bool has (StringID id)
 ID is present. More...
 
bool hasAll (StringIDList list)
 All IDs are present. More...
 
bool hasAny (StringIDList list)
 One or more IDs are present. More...
 
bool hasNone (StringIDList list)
 All IDs are absent. More...
 
bool hasNot (StringIDList list)
 One or more IDs are absent. More...
 
StringIDList new ()
 Create list. More...
 
StringIDList new (StringIDList list)
 Create copy of list. More...
 
void remove (StringID id)
 Remove ID. More...
 
void removeAll ()
 Remove all IDs. More...
 
void removeAll (StringIDList list)
 Remove all IDs from list. More...
 
void removeAllIfPresent (StringIDList list)
 Remove present IDs from list. More...
 
void removeIfPresent (StringID id)
 Remove ID if present. More...
 

Detailed Description

Ordered list of unique StringID.

Member Function Documentation

◆ add()

void Dragengine.Utils.StringIDList.add ( StringID  id)

Add ID to list.

Exceptions
EInvalidParamID is null.
EInvalidParamID is present.

◆ addAll()

void Dragengine.Utils.StringIDList.addAll ( StringIDList  list)

Add all IDs to list.

Exceptions
EInvalidParamOne or more IDs are present.

◆ addAllIfAbsent()

void Dragengine.Utils.StringIDList.addAllIfAbsent ( StringIDList  list)

Add all absent IDs to list .

◆ addIfAbsent()

void Dragengine.Utils.StringIDList.addIfAbsent ( StringID  id)

Add ID to list if absent.

Exceptions
EInvalidParamID is null.

◆ forEach()

void Dragengine.Utils.StringIDList.forEach ( Block  ablock)

Visit IDs with block with parameter StringID.

◆ getAt()

StringID Dragengine.Utils.StringIDList.getAt ( int  index)

ID at index.

◆ getCount()

int Dragengine.Utils.StringIDList.getCount ( )

Number of IDs.

◆ has()

bool Dragengine.Utils.StringIDList.has ( StringID  id)

ID is present.

◆ hasAll()

bool Dragengine.Utils.StringIDList.hasAll ( StringIDList  list)

All IDs are present.

If list is empty returns true.

◆ hasAny()

bool Dragengine.Utils.StringIDList.hasAny ( StringIDList  list)

One or more IDs are present.

If list is empty returns false.

◆ hasNone()

bool Dragengine.Utils.StringIDList.hasNone ( StringIDList  list)

All IDs are absent.

If list is empty returns true.

◆ hasNot()

bool Dragengine.Utils.StringIDList.hasNot ( StringIDList  list)

One or more IDs are absent.

If list is empty returns false.

◆ new() [1/2]

StringIDList Dragengine.Utils.StringIDList.new ( )

Create list.

◆ new() [2/2]

StringIDList Dragengine.Utils.StringIDList.new ( StringIDList  list)

Create copy of list.

◆ remove()

void Dragengine.Utils.StringIDList.remove ( StringID  id)

Remove ID.

Exceptions
EInvalidParamID is absent.

◆ removeAll() [1/2]

void Dragengine.Utils.StringIDList.removeAll ( )

Remove all IDs.

◆ removeAll() [2/2]

void Dragengine.Utils.StringIDList.removeAll ( StringIDList  list)

Remove all IDs from list.

Exceptions
EInvalidParamOne or more IDs are absent.

◆ removeAllIfPresent()

void Dragengine.Utils.StringIDList.removeAllIfPresent ( StringIDList  list)

Remove present IDs from list.

◆ removeIfPresent()

void Dragengine.Utils.StringIDList.removeIfPresent ( StringID  id)

Remove ID if present.


The documentation for this class was generated from the following file: