Difference between revisions of "HPL3/SOMA/Scripting/Scripting Api/Entity"

From Frictional Wiki
< HPL3‎ | SOMA‎ | Scripting‎ | Scripting Api
Jump to navigation Jump to search
Line 9: Line 9:
 
<tr style="background-color: #292929">
 
<tr style="background-color: #292929">
 
<td><span style="font-family: monospace; margin-left: 20px">bool</span></td>
 
<td><span style="font-family: monospace; margin-left: 20px">bool</span></td>
−
<td><span style="font-family: monospace; margin-bottom: 12px">[[#Entity_GetAutoSleep|Entity_GetAutoSleep]](const tString &in asName)</span><br />Get if an entity automatically falls asleep when it isnt active</td>
+
<td><span style="font-family: monospace; margin-bottom: 12px">[[#Entity_GetAutoSleep|Entity_GetAutoSleep]](const [[../../tString|tString]] &in asName)</span><br />Get if an entity automatically falls asleep when it isnt active</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
 
<td><span style="font-family: monospace; margin-left: 20px">void</span></td>
 
<td><span style="font-family: monospace; margin-left: 20px">void</span></td>
−
<td><span style="font-family: monospace; margin-bottom: 12px">[[#Entity_SetIsOccluder|Entity_SetIsOccluder]](const tString &in asName, bool abOccluder)</span><br />Set if entity is an occluder</td>
+
<td><span style="font-family: monospace; margin-bottom: 12px">[[#Entity_SetIsOccluder|Entity_SetIsOccluder]](const [[../../tString|tString]] &in asName, bool abOccluder)</span><br />Set if entity is an occluder</td>
 
</tr>
 
</tr>
 
<tr style="background-color: #292929">
 
<tr style="background-color: #292929">
 
<td><span style="font-family: monospace; margin-left: 20px">bool</span></td>
 
<td><span style="font-family: monospace; margin-left: 20px">bool</span></td>
−
<td><span style="font-family: monospace; margin-bottom: 12px">[[#Entity_IsOccluder|Entity_IsOccluder]](const tString &in asName)</span><br />Get if an entity is an occluder</td>
+
<td><span style="font-family: monospace; margin-bottom: 12px">[[#Entity_IsOccluder|Entity_IsOccluder]](const [[../../tString|tString]] &in asName)</span><br />Get if an entity is an occluder</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
 
<td><span style="font-family: monospace; margin-left: 20px">bool</span></td>
 
<td><span style="font-family: monospace; margin-left: 20px">bool</span></td>
−
<td><span style="font-family: monospace; margin-bottom: 12px">[[#Entity_IsInteractedWith|Entity_IsInteractedWith]](const tString &in asName)</span><br />Checks if the entity is being interacted with.</td>
+
<td><span style="font-family: monospace; margin-bottom: 12px">[[#Entity_IsInteractedWith|Entity_IsInteractedWith]](const [[../../tString|tString]] &in asName)</span><br />Checks if the entity is being interacted with.</td>
 
</tr>
 
</tr>
 
<tr style="background-color: #292929">
 
<tr style="background-color: #292929">
 
<td><span style="font-family: monospace; margin-left: 20px">void</span></td>
 
<td><span style="font-family: monospace; margin-left: 20px">void</span></td>
−
<td><span style="font-family: monospace; margin-bottom: 12px">[[#Entity_SetVarString|Entity_SetVarString]](const tString &in asName, const tString &in asVarName, const tString &in asX)</span><br />Sets the value of an entity string variable. Wildcard(s) * are supported for EntityName.</td>
+
<td><span style="font-family: monospace; margin-bottom: 12px">[[#Entity_SetVarString|Entity_SetVarString]](const [[../../tString|tString]] &in asName, const [[../../tString|tString]] &in asVarName, const [[../../tString|tString]] &in asX)</span><br />Sets the value of an entity string variable. Wildcard(s) * are supported for EntityName.</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
Line 40: Line 40:
 
'''Parameters'''
 
'''Parameters'''
  
−
* '''asName''' <syntaxhighlight lang="c++" inline>(const tString &in)</syntaxhighlight> — Name of the entity.
+
* '''asName''' (<span style="font-family: monospace">[[../../tString|tString]]</span>) — Name of the entity.
  
 
'''Returns:'''
 
'''Returns:'''
Line 59: Line 59:
 
'''Parameters'''
 
'''Parameters'''
  
−
* '''asName''' <syntaxhighlight lang="c++" inline>(const tString &in)</syntaxhighlight> — Name of the entity, Wildcard(s) * are supported *
+
* '''asName''' (<span style="font-family: monospace">[[../../tString|tString]]</span>) — Name of the entity, Wildcard(s) * are supported *
−
* '''abOccluder''' <syntaxhighlight lang="c++" inline>(bool)</syntaxhighlight> — true = object is occluder
+
* '''abOccluder''' (<span style="font-family: monospace">bool</span>) — true = object is occluder
  
 
'''Returns:'''
 
'''Returns:'''
Line 78: Line 78:
 
'''Parameters'''
 
'''Parameters'''
  
−
* '''asName''' <syntaxhighlight lang="c++" inline>(const tString &in)</syntaxhighlight> — Name of the entity.
+
* '''asName''' (<span style="font-family: monospace">[[../../tString|tString]]</span>) — Name of the entity.
  
 
'''Returns:'''
 
'''Returns:'''
Line 96: Line 96:
 
'''Parameters'''
 
'''Parameters'''
  
−
* '''asName''' <syntaxhighlight lang="c++" inline>(const tString &in)</syntaxhighlight> — name of the entity.
+
* '''asName''' (<span style="font-family: monospace">[[../../tString|tString]]</span>) — name of the entity.
  
 
'''Returns:'''
 
'''Returns:'''
Line 116: Line 116:
 
'''Parameters'''
 
'''Parameters'''
  
−
* '''asEntityName''' <syntaxhighlight lang="c++" inline>(const tString &in)</syntaxhighlight> —  
+
* '''asEntityName''' (<span style="font-family: monospace">[[../../tString|tString]]</span>) —  
−
* '''asVarName''' <syntaxhighlight lang="c++" inline>(const tString &in)</syntaxhighlight> —  
+
* '''asVarName''' (<span style="font-family: monospace">[[../../tString|tString]]</span>) —  
−
* '''asX''' <syntaxhighlight lang="c++" inline>(const tString &in)</syntaxhighlight> —  
+
* '''asX''' (<span style="font-family: monospace">[[../../tString|tString]]</span>) —  
  
 
'''Returns:'''
 
'''Returns:'''

Revision as of 02:40, 11 August 2020


Return Type Function and Description
bool Entity_GetAutoSleep(const tString &in asName)
Get if an entity automatically falls asleep when it isnt active
void Entity_SetIsOccluder(const tString &in asName, bool abOccluder)
Set if entity is an occluder
bool Entity_IsOccluder(const tString &in asName)
Get if an entity is an occluder
bool Entity_IsInteractedWith(const tString &in asName)
Checks if the entity is being interacted with.
void Entity_SetVarString(const tString &in asName, const tString &in asVarName, const tString &in asX)
Sets the value of an entity string variable. Wildcard(s) * are supported for EntityName.

Entity_GetAutoSleep

bool Entity_GetAutoSleep(const tString &in asName)

Get if an entity automatically falls asleep when it isnt active

Parameters

  • asName (tString) — Name of the entity.

Returns:

  • bool — if sleeping or not.

Entity_SetIsOccluder

void Entity_SetIsOccluder(const tString &in asName,
                          bool abOccluder)

Set if entity is an occluder

Parameters

  • asName (tString) — Name of the entity, Wildcard(s) * are supported *
  • abOccluder (bool) — true = object is occluder

Returns:

  • void

Entity_IsOccluder

bool Entity_IsOccluder(const tString &in asName)

Get if an entity is an occluder

Parameters

  • asName (tString) — Name of the entity.

Returns:

  • bool — if entity is an occluder

Entity_IsInteractedWith

bool Entity_IsInteractedWith(const tString &in asName)

Checks if the entity is being interacted with.

Parameters

  • asName (tString) — name of the entity.

Returns:

  • bool — if the entity is being interacted with

Entity_SetVarString

void Entity_SetVarString(const tString &in asEntityName,
                         const tString &in asVarName,
                         const tString &in asX)

Sets the value of an entity string variable. Wildcard(s) * are supported for EntityName. *

Parameters

Returns:

  • void
Retrieved from "https://wiki.frictionalgames.com/page?title=HPL3/SOMA/Scripting/Scripting_Api/Entity&oldid=4098"