Difference between revisions of "Script/Creature"
From SF3
| Line 210: | Line 210: | ||
|- | |- | ||
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] | | style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] | ||
| − | | style='color: black; width: 90%; line-height: 1.0;' | '''FollowCreature''' ([[../LevelReference|LevelReference@]] ''_Level'', const [[../Creature|Creature]]&in ''_Target'', const [[../BasicDataTypes|uint]] '' | + | | style='color: black; width: 90%; line-height: 1.0;' | '''FollowCreature''' ([[../LevelReference|LevelReference@]] ''_Level'', const [[../Creature|Creature]]&in ''_Target'', const [[../BasicDataTypes|uint]] ''_uMaxDistance'', const [[../BasicDataTypes|uint]] ''_uMinDistance'', const [[../BasicDataTypes|bool]] ''_bQueued'') |
|- | |- | ||
| | | | ||
Revision as of 14:16, 20 December 2016
class Creature
Represents a reference to a creature in the game world. An instance of this class acts like a weak pointer to an existing creature in the game world and provides an interface to interact with it. Before interacting with the creature, you should call Exists() in order to check if the creature actually (still) exists. IMPORTANT: This class must NOT be stored as a class member. If you want to store the creature for later reference, store the id obtained by GetId instead. You can then later retrieve the creature from the LevelReference class by calling GetCreatureById.
Inherits from: Entity
Class Methods
| string | GetDescriptionName () const |
| get creature description name | |
| ECreatureType | GetCreatureType () const |
| get creature type | |
| int | GetCurrentHP () const |
| get current creature health | |
| int | GetMaxHP () const |
| get maximum creature health | |
| void | Heal (const uint _uHP) |
| heal the creature for _uHP health points | |
| void | AddAttributePoints (const uint8 _uNumPoints) |
| give the creature attribute points that the player can spend however they wish (only works for heroes) | |
| void | AddAbilityPoints (const uint8 _uNumPoints) |
| give the creature ability points that the player can spend however they wish (only works for heroes) | |
| void | ModifyBaseAttribute (const ECreatureAttribute _Attribute, const int8 _iAmount) |
| modify the creature's base attribute value by the given number of points | |
| bool | CanVisitPOIs () const |
| can the creature visit POIs? | |
| bool | IsPOIVisitingBehaviorEnabled () const |
| is the creature's POI visiting behavior currently enabled? | |
| void | EnablePOIVisitingBehavior (const bool _bEnable) |
| enable or disable POI visiting behavior (only works for creatures where CanVisitPOIs is true) | |
| bool | IsPlayerControllable () const |
| can the creature be given commands by the player? | |
| void | SetPlayerControllable (const bool _bControllable) |
| set whether the creature can be controlled by the player | |
| bool | IsImmovable () const |
| can the creature be pushed around by others while idle? | |
| void | SetImmovable (const bool _bImmovable) |
| set whether the creature can be pushed around by others while idle (only valid until the creature gets another command). | |
| bool | IsImmortal () const |
| can the creature die (this does not mean invincibility, the creature can simply never fall below 1 HP) | |
| void | SetImmortal (const bool _bImmortal) |
| set whether the creature is immortal (immortality will prevent the creature from falling below 1 HP but will still alow it to take damage) | |
| bool | AreAttacksAllowed () const |
| can the creature perform attacks? | |
| void | AllowAttacks (const bool _bAllow) |
| set whether the creature can perform attacks | |
| bool | GetEquipment (const EItemSlot _Slot, string&out _sOutItemName) const |
| get the item currently equipped in the given slot of the creature. returns false if there was no item in the given slot. | |
| bool | Equip (LevelReference@ _Level, const EItemSlot _Slot, const string&in _sItemName, const ECreatureEquipMode _Mode) |
| equip the given item in the given slot. returns true if successful. | |
| bool | Unequip (LevelReference@ _Level, const EItemSlot _Slot, const ECreatureUnequipMode _Mode) |
| unequip the item currently in the given slot. returns false if there was no item in the given slot. | |
| bool | Damage (const EDamageType _DamageType, const uint _uAmount) |
| damage the creature for _uAmount HP of the given damage type, returns true if killed | |
| void | Kill () |
| immediately kill the creature | |
| void | Revive () |
| revive the creature if it's dead and refill its health | |
| bool | HasCondition (const uint _uDescriptionId) |
| check if creature has condition with given _uDescriptionId | |
| bool | ApplyCondition (const uint _uDescriptionId, const int _iDuration) |
| try to apply condition with given _uDescriptionId to creature for the defined _uDuration in seconds (-1 for infinite) - returns true if applied | |
| bool | RemoveCondition (const uint _uDescriptionId) |
| try to remove condition with given _uDescriptionId from creature - returns true if removed | |
| void | Stop (LevelReference@ _Level) |
| stop the creature dead in its tracks immediately. cancels any pending orders. | |
| void | FollowPath (LevelReference@ _Level, const string&in _sPathName, const bool _bForward, const bool _bQueued) |
| make the creature walk along the given path (creature will go to the closest point on the given path and follow it from there) | |
| void | FollowPathFromBeginning (LevelReference@ _Level, const string&in _sPathName, const bool _bForward, const bool _bQueued) |
| make the creature walk along the given path (creature will go to the beginning of the path and follow it from there) | |
| void | FollowPathWait (LevelReference@ _Level, const string&in _sPathName, const bool _bForward, const bool _bFromBeginning, const uint8 _WaitForHeroesFaction, const EFollowPathWaitMode _WaitMode, const bool _bQueued = false) |
| 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 | |
| void | Patrol (LevelReference@ _Level, const string&in _sPathName, const bool _bPingPong, const bool _bForward, const bool _bSmooth, const bool _bQueued = false) |
| make the creature continuously patrol along the given path. if _bPingPong is true, the group will alternate between walking the path forward and backward. otherwise, it will start over from the beginning after reaching the end. | |
| void | FollowCreature (LevelReference@ _Level, const Creature&in _Target, const uint _uMaxDistance, const uint _uMinDistance, const bool _bQueued) |
| make the creature follow another creature | |
| void | GoTo (LevelReference@ _Level, const Entity&in _Target, const uint _uMinDistance, const uint _uMaxDistance, const bool _bQueued) |
| make the creature walk to the given target | |
| void | Teleport (LevelReference@ _Level, const Entity&in _Target) |
| teleport the creature next to the given target | |
| bool | Interact (LevelReference@ _Level, const Entity&in _Target, const bool _bQueued, const uint8 _uFaction = kMaxFactions, const uint8 _uControlIndex = 0) |
| make the creature interact with the given target | |
| bool | Talk (LevelReference@ _Level, const Entity&in _Target, const string&in _sContainerName, const string&in _sTopicName, const bool _bQueued, const uint8 _uFaction = kMaxFactions, const uint8 _uControlIndex = 0) |
| make the creature talk to the given target | |
| bool | Shoutout (LevelReference@ _Level, const string&in _sContainerName, const string&in _sTopicName, const bool _bQueued, const uint8 _uFaction = kMaxFactions, const uint8 _uControlIndex = 0) |
| make the creature talk to itself. | |
| void | CancelDialogue () |
| cancel whatever dialogue the creature is currently participating in | |
| void | DropItem (LevelReference@ _Level, const string&in _sItemName, const uint _uAmount) |
| drop the given item at the creature's feet | |
| Creature& | operator= (const Creature&in) |
| bool | operator== (const Creature&in) |
| bool | operator== (const Entity&in) |
| bool | Exists () const |
| does the entity actually exist? (always check this before doing anything with the entity!) | |
| uint | GetId () const |
| get persistent entity id, use this to save the entity for later reference. | |
| uint8 | GetFaction () const |
| get owner faction | |
| void | SetFaction (const uint8 _Faction) |
| set owner faction | |
| EEntityType | GetEntityType () const |
| get entity type | |
| bool | IsEnabled () const |
| whether the entity is currently enabled (i.e. is visible in the game world) | |
| void | Enable (const bool _bEnabled) |
| enabled or disable the entity | |
| bool | IsInteractive () const |
| can the entity be interacted with? | |
| void | SetInteractive (const bool _bInteractive) |
| set whether the entity can be interacted with | |
| bool | IsBusy () const |
| is the entity currently marked as busy? | |
| void | SetBusy (const bool _bBusy) |
| mark the entity as busy | |
| void | SetInspectionText (const uint _uTextId) |
| make the entity inspectable and set the text to be displayed upon inspection | |
| bool | CanBeAttacked () const |
| can the entity be attacked? | |
| void | SetAttackable (const bool _bAttackable) |
| set whether the entity can be attacked | |
| Entity | opImplConv () const |
