View source for Script/CreatureGroup

==class CreatureGroup==
Interface to give coordinated commands to a selected group of creatures.
  
=== Class Methods ===
{| border='0' style ='border:solid 1px #eeeedd; color: black; width: 1200px;background-color: #ffffcc;' cellspacing='0' cellpadding='7'
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [constructor] 
| style='color: black; width: 90%; line-height: 0.8;' | '''CreatureGroup''' ([[../LevelReference|LevelReference]]&in ''_Level'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''create an empty creature group.''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [constructor] 
| style='color: black; width: 90%; line-height: 0.8;' | '''CreatureGroup''' ([[../LevelReference|LevelReference]]&in ''_Level'', const [[../Creature|Creature[]]]&in ''_Creatures'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''create a creature group using the given creatures.''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [constructor] 
| style='color: black; width: 90%; line-height: 0.8;' | '''CreatureGroup''' (const [[../CreatureGroup|CreatureGroup]]&in ''_Other'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''copy data from the given creature group.''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [constructor] 
| style='color: black; width: 90%; line-height: 0.8;' | '''CreatureGroup''' ()
|-
|
| style = 'color: #505050; line-height: 0.5;' |''default constructor. NEVER USE THIS! this constructor only exists because AngelScript requires it.''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|uint8]] 
| style='color: black; width: 90%; line-height: 0.8;' | '''GetFaction''' () const
|-
|
| style = 'color: #505050; line-height: 0.5;' |''get the faction of the creatures in the group. may return kMaxFactions if the group is empty.''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../Creature|Creature[]@]] 
| style='color: black; width: 90%; line-height: 0.8;' | '''GetCreatures''' () const
|-
|
| style = 'color: #505050; line-height: 0.5;' |''get a list of creatures currently in the group''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|bool]] 
| style='color: black; width: 90%; line-height: 0.8;' | '''IsMember''' (const [[../Creature|Creature]]&in ''_Creature'') const
|-
|
| style = 'color: #505050; line-height: 0.5;' |''check if the given creature is a member of this group''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 0.8;' | '''Add''' (const [[../Creature|Creature]]&in ''_Creature'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''add a creature to the selection''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 0.8;' | '''Set''' (const [[../Creature|Creature[]]]&in ''_Creatures'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''assign a new set of creatures to the selection, replacing any previous ones.''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 0.8;' | '''Remove''' (const [[../Creature|Creature]]&in ''_Creature'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''remove the given creature from the selection''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 0.8;' | '''Clear''' ()
|-
|
| style = 'color: #505050; line-height: 0.5;' |''remove all creatures from the selection''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 0.8;' | '''SetControllable''' (const [[../BasicDataTypes|bool]] ''_bControllable'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''make creatures in this group controllable by the player (or not)''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''FollowPath''' (const [[../BasicDataTypes|string]]&in ''_sPathName'', const [[../BasicDataTypes|bool]] ''_bForward'', const [[../BasicDataTypes|bool]] ''_bQueued'' = false)
|-
|
| style = 'color: #505050; line-height: 0.5;' |''make the creatures walk along the given path (will first go to the closest point on the path and then follow from there)''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''FollowPathFromBeginning''' (const [[../BasicDataTypes|string]]&in ''_sPathName'', const [[../BasicDataTypes|bool]] ''_bForward'', const [[../BasicDataTypes|bool]] ''_bQueued'' = false)
|-
|
| style = 'color: #505050; line-height: 0.5;' |''make the creature walk along the given path (will go to the first point of the path and then follow from there)''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''FollowPathWait''' (const [[../BasicDataTypes|string]]&in ''_sPathName'', const [[../BasicDataTypes|bool]] ''_bForward'', const [[../BasicDataTypes|bool]] ''_bFromBeginning'', const [[../BasicDataTypes|uint8]] ''_WaitForHeroesFaction'', const [[../LogicEnums#EFollowPathWaitMode|EFollowPathWaitMode]] ''_WaitMode'', const [[../BasicDataTypes|bool]] ''_bQueued'' = false)
|-
|
| style = 'color: #505050; line-height: 0.5;' |''make the creature walk along the given path, but wait for heroes of the given party to be nearby before continuing to the next waypoint''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 0.8;' | '''Move''' (const [[../Entity|Entity]]&in ''_Target'', const [[../BasicDataTypes|bool]] ''_bQueued'' = false)
|-
|
| style = 'color: #505050; line-height: 0.5;' |''move to the CURRENT position of the given entity''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 0.8;' | '''Move''' (const [[../Position|Position]]&in ''_Target'', const [[../BasicDataTypes|bool]] ''_bQueued'' = false)
|-
|
| style = 'color: #505050; line-height: 0.5;' |''move to the CURRENT position of the given entity''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''Teleport''' (const [[../Entity|Entity]]&in ''_Target'', const [[../BasicDataTypes|bool]] ''_bQueued'' = false)
|-
|
| style = 'color: #505050; line-height: 0.5;' |''teleport selection to the target position''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 0.8;' | '''Stop''' ()
|-
|
| style = 'color: #505050; line-height: 0.5;' |''stop whatever you are doing. for obvious reasons, this one can't be queued.''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 0.8;' | '''HoldPosition''' (const [[../BasicDataTypes|bool]] ''_bQueued'' = false)
|-
|
| style = 'color: #505050; line-height: 0.5;' |''let the creatures stop and hold their position wherever they are at the moment''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 0.8;' | '''AttackPosition''' (const [[../Entity|Entity]]&in ''_Target'', const [[../BasicDataTypes|bool]] ''_bQueued'' = false)
|-
|
| style = 'color: #505050; line-height: 0.5;' |''attack the general area around the given entity''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 0.8;' | '''AttackPosition''' (const [[../Position|Position]]&in ''_Target'', const [[../BasicDataTypes|bool]] ''_bQueued'' = false)
|-
|
| style = 'color: #505050; line-height: 0.5;' |''attack the general area around the given entity''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 0.8;' | '''AttackEntity''' (const [[../Entity|Entity]]&in ''_Target'', const [[../BasicDataTypes|bool]] ''_bQueued'' = false)
|-
|
| style = 'color: #505050; line-height: 0.5;' |''attack the given entity''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 0.8;' | '''Die''' (const [[../BasicDataTypes|bool]] ''_bQueued'' = false)
|-
|
| style = 'color: #505050; line-height: 0.5;' |''kill all creatures in the group''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 0.8;' | '''BuildSectorCenter''' (const [[../BasicDataTypes|uint16]] ''_uSectorIndex'', const [[../BasicDataTypes|bool]] ''_bQueued'' = false)
|-
|
| style = 'color: #505050; line-height: 0.5;' |''build a sector center in the given sector. may fail if there is already a sector center present. requires at least one hero to be in the selection.''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../CreatureGroup|CreatureGroup]]& 
| style='color: black; width: 90%; line-height: 0.8;' | '''operator=''' (const [[../CreatureGroup|CreatureGroup]]&in ''_Other'')
|-
|}