Difference between revisions of "Script/CreatureGroup"
From SF3
(Created page with "==class CreatureGroup== Interface to give coordinated commands to a selected group of creatures. === Class Methods === {| border='0' style ='border:solid 1px #eeeedd; color...") |
(No difference)
|
Revision as of 12:26, 23 September 2016
class CreatureGroup
Interface to give coordinated commands to a selected group of creatures.
Class Methods
| [constructor] | CreatureGroup (LevelReference&in _Level) |
| create an empty creature group. | |
| [constructor] | CreatureGroup (LevelReference&in _Level, const Creature[]&in _Creatures) |
| create a creature group using the given creatures. | |
| [constructor] | CreatureGroup (const CreatureGroup&in _Other) |
| copy data from the given creature group. | |
| [constructor] | CreatureGroup () |
| default constructor. NEVER USE THIS! this constructor only exists because AngelScript requires it. | |
| uint8 | GetFaction () const |
| get the faction of the creatures in the group. may return kMaxFactions if the group is empty. | |
| Creature[]@ | GetCreatures () const |
| get a list of creatures currently in the group | |
| bool | IsMember (const Creature&in _Creature) const |
| check if the given creature is a member of this group | |
| void | Add (const Creature&in _Creature) |
| add a creature to the selection | |
| void | Set (const Creature[]&in _Creatures) |
| assign a new set of creatures to the selection, replacing any previous ones. | |
| void | Remove (const Creature&in _Creature) |
| remove the given creature from the selection | |
| void | Clear () |
| remove all creatures from the selection | |
| void | SetControllable (const bool _bControllable) |
| make creatures in this group controllable by the player (or not) | |
| void | FollowPath (const string&in _sPathName, const bool _bForward, const bool _bQueued = false) |
| make the creature walk along the given path | |
| void | Move (const Entity&in _Target, const bool _bQueued = false) |
| move to the CURRENT position of the given entity | |
| void | Move (const Position&in _Target, const bool _bQueued = false) |
| move to the CURRENT position of the given entity | |
| void | Stop () |
| stop whatever you are doing. for obvious reasons, this one can't be queued. | |
| void | HoldPosition (const bool _bQueued = false) |
| let the creatures stop and hold their position wherever they are at the moment | |
| void | AttackPosition (const Entity&in _Target, const bool _bQueued = false) |
| attack the general area around the given entity | |
| void | AttackPosition (const Position&in _Target, const bool _bQueued = false) |
| attack the general area around the given entity | |
| void | AttackEntity (const Entity&in _Target, const bool _bQueued = false) |
| attack the given entity | |
| void | Die (const bool _bQueued = false) |
| kill all creatures in the group | |
| void | BuildSectorCenter (const uint16 _uSectorIndex, const bool _bQueued = false) |
| build a sector center in the given sector. may fail if there is already a sector center present. | |
| CreatureGroup& | operator= (const CreatureGroup&in _Other) |
