Difference between revisions of "HPL3/SOMA/Scripting/Scripting Api/Entity"
< HPL3 | SOMA | Scripting | Scripting Api
Jump to navigation
Jump to search
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
| + | <div style="padding: 8px; border: 1px solid black; margin-bottom: 20px; background: #202020"> | ||
<table style="width: 100%; border: 1px solid black; border-collapse: collapse;"> | <table style="width: 100%; border: 1px solid black; border-collapse: collapse;"> | ||
<tr style="border-bottom: 1px solid black; background: #232339"> | <tr style="border-bottom: 1px solid black; background: #232339"> | ||
| Line 27: | Line 28: | ||
</tr> | </tr> | ||
</table> | </table> | ||
| + | </div> | ||
| − | <div style="margin: | + | <div style="background: #202020; border: 1px solid black; margin-bottom: 20px;"> |
| − | <h2 style=" | + | <h2 style="border-bottom: 1px solid black; background: #232339; margin: 0; padding: 6px 20px; font-family: monospace">Entity_GetAutoSleep</h2> |
| + | <div style="padding: 0 8px 8px 8px"> | ||
<syntaxhighlight lang="c++">bool Entity_GetAutoSleep(const tString &in asName)</syntaxhighlight> | <syntaxhighlight lang="c++">bool Entity_GetAutoSleep(const tString &in asName)</syntaxhighlight> | ||
| Line 42: | Line 45: | ||
* <syntaxhighlight lang="c++" inline>bool</syntaxhighlight> — if sleeping or not. | * <syntaxhighlight lang="c++" inline>bool</syntaxhighlight> — if sleeping or not. | ||
| + | </div> | ||
</div> | </div> | ||
| + | <div style="background: #202020; border: 1px solid black; margin-bottom: 20px;"> | ||
| + | <h2 style="border-bottom: 1px solid black; background: #232339; margin: 0; padding: 6px 20px; font-family: monospace">Entity_SetIsOccluder</h2> | ||
| − | < | + | <div style="padding: 0 8px 8px 8px"> |
| + | <syntaxhighlight lang="c++">void Entity_SetIsOccluder(const tString &in asName, | ||
| + | bool abOccluder)</syntaxhighlight> | ||
Set if entity is an occluder | Set if entity is an occluder | ||
| − | |||
| − | |||
| − | |||
'''Parameters''' | '''Parameters''' | ||
| Line 60: | Line 65: | ||
* <syntaxhighlight lang="c++" inline>void</syntaxhighlight> | * <syntaxhighlight lang="c++" inline>void</syntaxhighlight> | ||
| + | </div> | ||
| + | </div> | ||
| + | |||
| + | <div style="background: #202020; border: 1px solid black; margin-bottom: 20px;"> | ||
| + | <h2 style="border-bottom: 1px solid black; background: #232339; margin: 0; padding: 6px 20px; font-family: monospace">Entity_IsOccluder</h2> | ||
| − | < | + | <div style="padding: 0 8px 8px 8px"> |
| + | <syntaxhighlight lang="c++">bool Entity_IsOccluder(const tString &in asName)</syntaxhighlight> | ||
Get if an entity is an occluder | Get if an entity is an occluder | ||
| − | |||
| − | |||
'''Parameters''' | '''Parameters''' | ||
| Line 74: | Line 83: | ||
* <syntaxhighlight lang="c++" inline>bool</syntaxhighlight> — if entity is an occluder | * <syntaxhighlight lang="c++" inline>bool</syntaxhighlight> — if entity is an occluder | ||
| + | </div> | ||
| + | </div> | ||
| + | |||
| + | <div style="background: #202020; border: 1px solid black; margin-bottom: 20px;"> | ||
| + | <h2 style="border-bottom: 1px solid black; background: #232339; margin: 0; padding: 6px 20px; font-family: monospace">Entity_IsInteractedWith</h2> | ||
| − | < | + | <div style="padding: 0 8px 8px 8px"> |
| + | <syntaxhighlight lang="c++">bool Entity_IsInteractedWith(const tString &in asName)</syntaxhighlight> | ||
Checks if the entity is being interacted with. | Checks if the entity is being interacted with. | ||
| − | |||
| − | |||
'''Parameters''' | '''Parameters''' | ||
| Line 88: | Line 101: | ||
* <syntaxhighlight lang="c++" inline>bool</syntaxhighlight> — if the entity is being interacted with | * <syntaxhighlight lang="c++" inline>bool</syntaxhighlight> — if the entity is being interacted with | ||
| + | </div> | ||
| + | </div> | ||
| − | < | + | <div style="background: #202020; border: 1px solid black; margin-bottom: 20px;"> |
| − | + | <h2 style="border-bottom: 1px solid black; background: #232339; margin: 0; padding: 6px 20px; font-family: monospace">Entity_SetVarString</h2> | |
| − | |||
| + | <div style="padding: 0 8px 8px 8px"> | ||
<syntaxhighlight lang="c++">void Entity_SetVarString(const tString &in asEntityName, | <syntaxhighlight lang="c++">void Entity_SetVarString(const tString &in asEntityName, | ||
const tString &in asVarName, | const tString &in asVarName, | ||
const tString &in asX)</syntaxhighlight> | const tString &in asX)</syntaxhighlight> | ||
| + | |||
| + | Sets the value of an entity string variable. Wildcard(s) * are supported for EntityName. * | ||
'''Parameters''' | '''Parameters''' | ||
| Line 106: | Line 123: | ||
* <syntaxhighlight lang="c++" inline>void</syntaxhighlight> | * <syntaxhighlight lang="c++" inline>void</syntaxhighlight> | ||
| + | </div> | ||
| + | </div> | ||
Revision as of 03:35, 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
(const tString &in)— 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
(const tString &in)— 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
(const tString &in)— 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
(const tString &in)— 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
- asEntityName
(const tString &in)— - asVarName
(const tString &in)— - asX
(const tString &in)—
Returns:
void