Script/Creature

From SF3
Revision as of 12:51, 26 August 2016 by Administrator (talk | contribs) (Created page with "==class Creature== Represents a reference to a creature in the game world. === Class Methods === {| border='0' style ='border:solid 1px #eeeedd; color: black; width: 1024px;ba...")

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

class Creature

Represents a reference to a creature in the game world.

Class Methods

Script/string GetDescriptionName () const
get creature description name
Script/string GetCreatureType () const
get creature type name
int GetCurrentHP () const
get current creature health
int GetMaxHP () const
get maximum creature health
bool IsPlayerControllable () const
can the creature be given commands by the player?
Script/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?
Script/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 Damage (const Script/string&in _sDamageTypeName, const uint _uAmount)
damage the creature for _uAmount HP of the given damage type, returns true if killed
Script/void Kill ()
immediately kill the creature
Script/void Stop (Script/LevelReference@ _Level)
stop the creature dead in its tracks immediately. cancels any pending orders.
Script/void FollowPath (Script/LevelReference@ _Level, const Script/string&in _sPathName, const bool _bForward, const bool _bQueued)
Script/void GoTo (Script/LevelReference@ _Level, const Script/Entity&in _Target, const uint _uMinDistance, const uint _uMaxDistance, const bool _bQueued)
make the creature walk to the given target
bool Interact (Script/LevelReference@ _Level, const Script/Entity&in _Target, const bool _bQueued)
make the creature interact with the given target
bool Talk (Script/LevelReference@ _Level, const Script/Entity&in _Target, const Script/string&in _sContainerName, const Script/string&in _sTopicName, const bool _bQueued)
make the creature talk to the given target
bool Shoutout (Script/LevelReference@ _Level, const Script/string&in _sContainerName, const Script/string&in _sTopicName, const bool _bQueued)
make the creature talk to itself.
Script/void DropItem (Script/LevelReference@ _Level, const Script/string&in _sItemName, const uint _uAmount)
drop the given item at the creature's feet
Script/Creature& operator= (const Script/Creature&in)
bool operator== (const Script/Creature&in)
bool operator== (const Script/Entity&in)
bool Exists () const
uint GetId () const
uint8 GetFaction () const
Script/void SetFaction (const uint8 _Faction)
Script/string GetEntityType () const
bool IsEnabled () const
Script/void Enable (const bool _bEnabled)
bool IsInteractive () const
Script/void SetInteractive (const bool _bInteractive)
bool CanBeAttacked () const
Script/void SetAttackable (const bool _bAttackable)
Script/Entity opImplConv () const

class Creature

Represents a reference to a creature in the game world.

Class Methods

Script/string GetDescriptionName () const
get creature description name
Script/string GetCreatureType () const
get creature type name
int GetCurrentHP () const
get current creature health
int GetMaxHP () const
get maximum creature health
bool IsPlayerControllable () const
can the creature be given commands by the player?
Script/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?
Script/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 Damage (const Script/string&in _sDamageTypeName, const uint _uAmount)
damage the creature for _uAmount HP of the given damage type, returns true if killed
Script/void Kill ()
immediately kill the creature
Script/void Stop (Script/LevelReference@ _Level)
stop the creature dead in its tracks immediately. cancels any pending orders.
Script/void FollowPath (Script/LevelReference@ _Level, const Script/string&in _sPathName, const bool _bForward, const bool _bQueued)
Script/void GoTo (Script/LevelReference@ _Level, const Script/Entity&in _Target, const uint _uMinDistance, const uint _uMaxDistance, const bool _bQueued)
make the creature walk to the given target
bool Interact (Script/LevelReference@ _Level, const Script/Entity&in _Target, const bool _bQueued)
make the creature interact with the given target
bool Talk (Script/LevelReference@ _Level, const Script/Entity&in _Target, const Script/string&in _sContainerName, const Script/string&in _sTopicName, const bool _bQueued)
make the creature talk to the given target
bool Shoutout (Script/LevelReference@ _Level, const Script/string&in _sContainerName, const Script/string&in _sTopicName, const bool _bQueued)
make the creature talk to itself.
Script/void DropItem (Script/LevelReference@ _Level, const Script/string&in _sItemName, const uint _uAmount)
drop the given item at the creature's feet
Script/Creature& operator= (const Script/Creature&in)
bool operator== (const Script/Creature&in)
bool operator== (const Script/Entity&in)
bool Exists () const
uint GetId () const
uint8 GetFaction () const
Script/void SetFaction (const uint8 _Faction)
Script/string GetEntityType () const
bool IsEnabled () const
Script/void Enable (const bool _bEnabled)
bool IsInteractive () const
Script/void SetInteractive (const bool _bInteractive)
bool CanBeAttacked () const
Script/void SetAttackable (const bool _bAttackable)
Script/Entity opImplConv () const