View source for Script/LogicObject

==class LogicObject==
Represents a reference to a logic object in the game world.
A logic object may be e.g. a switch, loot container, etc.
Yes, it is kind of inconsequent to call this one LogicObject in the script but LevelObject in the native code, but that's what our
dear scripters wanted.
An instance of this class acts like a weak pointer to an existing logic object in the game world and provides an interface to interact
with it.
Before interacting with the object, you should call Exists() in order to check if the object actually (still) exists.
IMPORTANT: This class must NOT be stored as a class member. If you want to store the object for later reference, store the id
obtained by GetId instead. You can then later retrieve the object from the LevelReference class by calling GetLogicObjectById.  

'''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;' | [[../LogicEnums#ELogicObjectType|ELogicObjectType]] 
| style='color: black; width: 90%; line-height: 0.8;' | '''GetLogicObjectType''' () const
|-
|
| style = 'color: #505050; line-height: 0.5;' |''get logic object type''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|bool]] 
| style='color: black; width: 90%; line-height: 0.8;' | '''GetToggleState''' () const
|-
|
| style = 'color: #505050; line-height: 0.5;' |''get toggle state of the logic object''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 0.8;' | '''SetToggleState''' (const [[../BasicDataTypes|bool]] ''_bToggled'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''set toggle state of the logic object (e.g. position of a switch, whether a nav blocker is enabled or disabled, whether a chest is open or closed)''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|int]] 
| style='color: black; width: 90%; line-height: 0.8;' | '''GetSightRange''' () const
|-
|
| style = 'color: #505050; line-height: 0.5;' |''get sight range of the logic object''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 0.8;' | '''SetSightRange''' (const [[../BasicDataTypes|int]] ''_iSightRange'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''set sight range of the logic object''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|bool]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''IsSightBlocking''' () const
|-
|
| style = 'color: #505050; line-height: 0.5;' |''does the object block line of sight?''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''SetSightBlocking''' (const [[../BasicDataTypes|bool]] ''_bBlocking'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''set whether the object should block line of sight''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|bool]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''IsLocked''' () const
|-
|
| style = 'color: #505050; line-height: 0.5;' |''is this object currently locked?''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|bool]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''RequiresKey''' () const
|-
|
| style = 'color: #505050; line-height: 0.5;' |''can this object be unlocked using a key?''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''Lock''' ([[../LevelReference|const LevelReference@]] ''_Level'', const [[../BasicDataTypes|string]]&in ''_sKeyName'' = "")
|-
|
| style = 'color: #505050; line-height: 0.5;' |''lock the object with the given key (leave _sKeyName empty if the object should not be unlockable manually)''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''Unlock''' ()
|-
|
| style = 'color: #505050; line-height: 0.5;' |''remove the lock from this object''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''AddContainerItem''' ([[../constLevelReference|const LevelReference@]] ''_Level'', const [[../BasicDataTypes|string]]&in ''_sItemName'', const [[../BasicDataTypes|uint]] ''_uAmount'' = 1)
|-
|
| style = 'color: #505050; line-height: 0.5;' |''add the given item to this container (only valid if the object is an item container)''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''RemoveContainerItem''' ([[../constLevelReference|const LevelReference@]] ''_Level'', const [[../BasicDataTypes|string]]&in ''_sItemName'', const [[../BasicDataTypes|uint]] ''_uAmount'' = 1)
|-
|
| style = 'color: #505050; line-height: 0.5;' |''remove the given item from this container (only valid if the object is an item container)''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../LogicObject|LogicObject]]& 
| style='color: black; width: 90%; line-height: 0.8;' | '''operator=''' (const [[../LogicObject|LogicObject]]&in)
|-
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|bool]] 
| style='color: black; width: 90%; line-height: 0.8;' | '''operator==''' (const [[../LogicObject|LogicObject]]&in)
|-
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|bool]] 
| style='color: black; width: 90%; line-height: 0.8;' | '''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: 0.8;' | '''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: 0.8;' | '''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: 0.8;' | '''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: 0.8;' | '''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: 0.8;' | '''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: 0.8;' | '''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: 0.8;' | '''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: 0.8;' | '''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: 0.8;' | '''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;' | '''IsSelectable''' () const
|-
|
| style = 'color: #505050; line-height: 0.5;' |''can the entity (theoretically) be selected 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;' | '''SetSelectable''' (const [[../BasicDataTypes|bool]] ''_bSelectable'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''set whether the entity can be selected by the player
(note that depending on the type of entity, there may be additional checks preventing the entity from being selected)''
|-
| 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;' | '''HasInspectionText''' () const
|-
|
| style = 'color: #505050; line-height: 0.5;' |''check whether the entity currently has an inspection text''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''SetInspectionText''' (const [[../BasicDataTypes|uint]] ''_uTextId'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''make the entity inspectable and set the text to be displayed upon inspection''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|bool]] 
| style='color: black; width: 90%; line-height: 0.8;' | '''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: 0.8;' | '''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: 0.8;' | '''opImplConv''' () const
|-
|}