View source for Script/Creature

==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|Entity]]
=== 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;' | [[../BasicDataTypes|string]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''GetDescriptionName''' () const
|-
|
| style = 'color: #505050; line-height: 0.5;' |''get creature description name''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../LogicEnums#ECreatureType|ECreatureType]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''GetCreatureType''' () const
|-
|
| style = 'color: #505050; line-height: 0.5;' |''get creature type''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|int]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''GetCurrentHP''' () const
|-
|
| style = 'color: #505050; line-height: 0.5;' |''get current creature health''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|int]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''GetMaxHP''' () const
|-
|
| style = 'color: #505050; line-height: 0.5;' |''get maximum creature health''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''Heal''' (const [[../BasicDataTypes|uint]] ''_uHP'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''heal the creature for _uHP health points''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|bool]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''CanVisitPOIs''' () const
|-
|
| style = 'color: #505050; line-height: 0.5;' |''can the creature visit POIs?''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|bool]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''IsPOIVisitingBehaviorEnabled''' () const
|-
|
| style = 'color: #505050; line-height: 0.5;' |''is the creature's POI visiting behavior currently enabled?''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''EnablePOIVisitingBehavior''' (const [[../BasicDataTypes|bool]] ''_bEnable'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''enable or disable POI visiting behavior (only works for creatures where CanVisitPOIs is true)''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|bool]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''IsPlayerControllable''' () const
|-
|
| style = 'color: #505050; line-height: 0.5;' |''can the creature be given commands by the player?''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''SetPlayerControllable''' (const [[../BasicDataTypes|bool]] ''_bControllable'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''set whether the creature can be controlled by the player''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|bool]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''IsImmovable''' () const
|-
|
| style = 'color: #505050; line-height: 0.5;' |''can the creature be pushed around by others while idle?''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''SetImmovable''' (const [[../BasicDataTypes|bool]] ''_bImmovable'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''set whether the creature can be pushed around by others while idle (only valid until the creature gets another command).''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|bool]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''AreAttacksAllowed''' () const
|-
|
| style = 'color: #505050; line-height: 0.5;' |''can the creature perform attacks?''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''AllowAttacks''' (const [[../BasicDataTypes|bool]] ''_bAllow'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''set whether the creature can perform attacks''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|bool]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''GetEquipment''' (const [[../LogicEnums#EItemSlot|EItemSlot]] ''_Slot'', [[../BasicDataTypes|string]]&out ''_sOutItemName'') const
|-
|
| style = 'color: #505050; line-height: 0.5;' |''get the item currently equipped in the given slot of the creature. returns false if there was no item in the given slot.''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|bool]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''Equip''' ([[../LevelReference|LevelReference@]] ''_Level'', const [[../LogicEnums#EItemSlot|EItemSlot]] ''_Slot'', const [[../BasicDataTypes|string]]&in ''_sItemName'', const [[../LogicEnums#ECreatureEquipMode|ECreatureEquipMode]] ''_Mode'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''equip the given item in the given slot. returns true if successful.''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|bool]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''Unequip''' ([[../LevelReference|LevelReference@]] ''_Level'', const [[../LogicEnums#EItemSlot|EItemSlot]] ''_Slot'', const [[../LogicEnums#ECreatureUnequipMode|ECreatureUnequipMode]] ''_Mode'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''unequip the item currently in the given slot. returns false if there was no item in the given slot.''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|bool]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''Damage''' (const [[../LogicEnums#EDamageType|EDamageType]] ''_DamageType'', const [[../BasicDataTypes|uint]] ''_uAmount'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''damage the creature for _uAmount HP of the given damage type, returns true if killed''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''Kill''' ()
|-
|
| style = 'color: #505050; line-height: 0.5;' |''immediately kill the creature''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''Revive''' ()
|-
|
| style = 'color: #505050; line-height: 0.5;' |''revive the creature if it's dead and refill its health''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|bool]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''HasCondition''' (const [[../BasicDataTypes|uint]] ''_uDescriptionId'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''check if creature has condition with given _uDescriptionId''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|bool]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''ApplyCondition''' (const [[../BasicDataTypes|uint]] ''_uDescriptionId'', const [[../BasicDataTypes|int]] ''_iDuration'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''try to apply condition with given _uDescriptionId to creature for the defined _uDuration in seconds (-1 for infinite) - returns true if applied''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|bool]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''RemoveCondition''' (const [[../BasicDataTypes|uint]] ''_uDescriptionId'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''try to remove condition with given _uDescriptionId from creature - returns true if removed''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''Stop''' ([[../LevelReference|LevelReference@]] ''_Level'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''stop the creature dead in its tracks immediately. cancels any pending orders.''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''FollowPath''' ([[../LevelReference|LevelReference@]] ''_Level'', const [[../BasicDataTypes|string]]&in ''_sPathName'', const [[../BasicDataTypes|bool]] ''_bForward'', const [[../BasicDataTypes|bool]] ''_bQueued'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''make the creature walk along the given path (creature will go to the closest point on the given path and follow it 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''' ([[../LevelReference|LevelReference@]] ''_Level'', const [[../BasicDataTypes|string]]&in ''_sPathName'', const [[../BasicDataTypes|bool]] ''_bForward'', const [[../BasicDataTypes|bool]] ''_bQueued'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''make the creature walk along the given path (creature will go to the beginning of the path and follow it 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''' ([[../LevelReference|LevelReference@]] ''_Level'', 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: 1.0;' | '''FollowCreature''' ([[../LevelReference|LevelReference@]] ''_Level'', const [[../Creature|Creature]]&in ''_Target'', const [[../BasicDataTypes|uint]] ''_uMinDistance'', const [[../BasicDataTypes|uint]] ''_uMaxDistance'', const [[../BasicDataTypes|bool]] ''_bQueued'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''make the creature follow another creature''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''GoTo''' ([[../LevelReference|LevelReference@]] ''_Level'', const [[../Entity|Entity]]&in ''_Target'', const [[../BasicDataTypes|uint]] ''_uMinDistance'', const [[../BasicDataTypes|uint]] ''_uMaxDistance'', const [[../BasicDataTypes|bool]] ''_bQueued'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''make the creature walk to the given target''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''Teleport''' ([[../LevelReference|LevelReference@]] ''_Level'', const [[../Entity|Entity]]&in ''_Target'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''teleport the creature next to the given target''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|bool]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''Interact''' ([[../LevelReference|LevelReference@]] ''_Level'', const [[../Entity|Entity]]&in ''_Target'', const [[../BasicDataTypes|bool]] ''_bQueued'', const [[../BasicDataTypes|uint8]] ''_uFaction'' = kMaxFactions, const [[../BasicDataTypes|uint8]] ''_uControlIndex'' = 0)
|-
|
| style = 'color: #505050; line-height: 0.5;' |''make the creature interact with the given target''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|bool]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''Talk''' ([[../LevelReference|LevelReference@]] ''_Level'', const [[../Entity|Entity]]&in ''_Target'', const [[../BasicDataTypes|string]]&in ''_sContainerName'', const [[../BasicDataTypes|string]]&in ''_sTopicName'', const [[../BasicDataTypes|bool]] ''_bQueued'', const [[../BasicDataTypes|uint8]] ''_uFaction'' = kMaxFactions, const [[../BasicDataTypes|uint8]] ''_uControlIndex'' = 0)
|-
|
| style = 'color: #505050; line-height: 0.5;' |''make the creature talk to the given target''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|bool]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''Shoutout''' ([[../LevelReference|LevelReference@]] ''_Level'', const [[../BasicDataTypes|string]]&in ''_sContainerName'', const [[../BasicDataTypes|string]]&in ''_sTopicName'', const [[../BasicDataTypes|bool]] ''_bQueued'', const [[../BasicDataTypes|uint8]] ''_uFaction'' = kMaxFactions, const [[../BasicDataTypes|uint8]] ''_uControlIndex'' = 0)
|-
|
| style = 'color: #505050; line-height: 0.5;' |''make the creature talk to itself.''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''DropItem''' ([[../LevelReference|LevelReference@]] ''_Level'', const [[../BasicDataTypes|string]]&in ''_sItemName'', const [[../BasicDataTypes|uint]] ''_uAmount'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''drop the given item at the creature's feet''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../Creature|Creature]]& 
| style='color: black; width: 90%; line-height: 1.0;' | '''operator=''' (const [[../Creature|Creature]]&in)
|-
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|bool]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''operator==''' (const [[../Creature|Creature]]&in)
|-
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|bool]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''operator==''' (const [[../Entity|Entity]]&in)
|-
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|bool]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''Exists''' () const
|-
|
| style = 'color: #505050; line-height: 0.5;' |''does the entity actually exist? (always check this before doing anything with the entity!)''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|uint]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''GetId''' () const
|-
|
| style = 'color: #505050; line-height: 0.5;' |''get persistent entity id, use this to save the entity for later reference.''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|uint8]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''GetFaction''' () const
|-
|
| style = 'color: #505050; line-height: 0.5;' |''get owner faction''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''SetFaction''' (const [[../BasicDataTypes|uint8]] ''_Faction'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''set owner faction''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../LogicEnums#EEntityType|EEntityType]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''GetEntityType''' () const
|-
|
| style = 'color: #505050; line-height: 0.5;' |''get entity type''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|bool]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''IsEnabled''' () const
|-
|
| style = 'color: #505050; line-height: 0.5;' |''whether the entity is currently enabled (i.e. is visible in the game world)''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''Enable''' (const [[../BasicDataTypes|bool]] ''_bEnabled'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''enabled or disable the entity''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|bool]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''IsInteractive''' () const
|-
|
| style = 'color: #505050; line-height: 0.5;' |''can the entity be interacted with?''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''SetInteractive''' (const [[../BasicDataTypes|bool]] ''_bInteractive'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''set whether the entity can be interacted with''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|bool]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''IsBusy''' () const
|-
|
| style = 'color: #505050; line-height: 0.5;' |''is the entity currently marked as busy?''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''SetBusy''' (const [[../BasicDataTypes|bool]] ''_bBusy'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''mark the entity as busy''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|bool]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''CanBeAttacked''' () const
|-
|
| style = 'color: #505050; line-height: 0.5;' |''can the entity be attacked?''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''SetAttackable''' (const [[../BasicDataTypes|bool]] ''_bAttackable'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''set whether the entity can be attacked''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../Entity|Entity]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''opImplConv''' () const
|-
|}