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: | ||
| − | <h2 style="border-top: 0.5px solid #a2a9b1; border-bottom: 0.5px solid #a2a9b1; background: # | + | __NOTOC__ |
| + | |||
| + | <table style="width: 100%; border: 1px solid black; border-collapse: collapse;"> | ||
| + | <tr style="border-bottom: 1px solid black; background: #232339"> | ||
| + | <th style="text-align: left; padding: 4px 0 4px 12px">Return Type</th> | ||
| + | <th style="text-align: left">Function and Description</th> | ||
| + | </tr> | ||
| + | <tr style="background-color: #292929"> | ||
| + | <td><span style="font-family: monospace; margin-left: 20px">bool</span></td> | ||
| + | <td><span style="font-family: monospace; margin-bottom: 12px">Entity_GetAutoSleep(const tString &in asName)</span><br />Get if an entity automatically falls asleep when it isnt active</td> | ||
| + | </tr> | ||
| + | <tr> | ||
| + | <td><span style="font-family: monospace; margin-left: 20px">void</span></td> | ||
| + | <td><span style="font-family: monospace; margin-bottom: 12px">Entity_SetIsOccluder(const tString &in asName, bool abOccluder)</span><br />Set if entity is an occluder</td> | ||
| + | </tr> | ||
| + | <tr style="background-color: #292929"> | ||
| + | <td><span style="font-family: monospace; margin-left: 20px">bool</span></td> | ||
| + | <td><span style="font-family: monospace; margin-bottom: 12px">Entity_IsOccluder(const tString &in asName)</span><br />Get if an entity is an occluder</td> | ||
| + | </tr> | ||
| + | <tr> | ||
| + | <td><span style="font-family: monospace; margin-left: 20px">bool</span></td> | ||
| + | <td><span style="font-family: monospace; margin-bottom: 12px">Entity_IsInteractedWith(const tString &in asName)</span><br />Checks if the entity is being interacted with.</td> | ||
| + | </tr> | ||
| + | <tr style="background-color: #292929"> | ||
| + | <td><span style="font-family: monospace; margin-left: 20px">void</span></td> | ||
| + | <td><span style="font-family: monospace; margin-bottom: 12px">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> | ||
| + | </tr> | ||
| + | </table> | ||
| + | |||
| + | <h2 style="border-top: 0.5px solid #a2a9b1; border-bottom: 0.5px solid #a2a9b1; background: #232339; margin: 40px 0 16px; padding: 8px 20px; font-family: monospace">Entity_GetAutoSleep</h2> | ||
Get if an entity automatically falls asleep when it isnt active | Get if an entity automatically falls asleep when it isnt active | ||
| Line 13: | Line 42: | ||
* <syntaxhighlight lang="c++" inline>bool</syntaxhighlight> — if sleeping or not. | * <syntaxhighlight lang="c++" inline>bool</syntaxhighlight> — if sleeping or not. | ||
| − | <h2 style="border-top: 0.5px solid #a2a9b1; border-bottom: 0.5px solid #a2a9b1; background: # | + | <h2 style="border-top: 0.5px solid #a2a9b1; border-bottom: 0.5px solid #a2a9b1; background: #232339; margin: 40px 0 16px; padding: 8px 20px; font-family: monospace">Entity_SetIsOccluder</h2> |
Set if entity is an occluder | Set if entity is an occluder | ||
| Line 29: | Line 58: | ||
* <syntaxhighlight lang="c++" inline>void</syntaxhighlight> | * <syntaxhighlight lang="c++" inline>void</syntaxhighlight> | ||
| − | <h2 style="border-top: 0.5px solid #a2a9b1; border-bottom: 0.5px solid #a2a9b1; background: # | + | <h2 style="border-top: 0.5px solid #a2a9b1; border-bottom: 0.5px solid #a2a9b1; background: #232339; margin: 40px 0 16px; padding: 8px 20px; font-family: monospace">Entity_IsOccluder</h2> |
Get if an entity is an occluder | Get if an entity is an occluder | ||
| Line 43: | Line 72: | ||
* <syntaxhighlight lang="c++" inline>bool</syntaxhighlight> — if entity is an occluder | * <syntaxhighlight lang="c++" inline>bool</syntaxhighlight> — if entity is an occluder | ||
| − | <h2 style="border-top: 0.5px solid #a2a9b1; border-bottom: 0.5px solid #a2a9b1; background: # | + | <h2 style="border-top: 0.5px solid #a2a9b1; border-bottom: 0.5px solid #a2a9b1; background: #232339; margin: 40px 0 16px; padding: 8px 20px; font-family: monospace">Entity_IsInteractedWith</h2> |
Checks if the entity is being interacted with. | Checks if the entity is being interacted with. | ||
| Line 57: | Line 86: | ||
* <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 | ||
| − | <h2 style="border-top: 0.5px solid #a2a9b1; border-bottom: 0.5px solid #a2a9b1; background: # | + | <h2 style="border-top: 0.5px solid #a2a9b1; border-bottom: 0.5px solid #a2a9b1; background: #232339; margin: 40px 0 16px; padding: 8px 20px; font-family: monospace">Entity_SetVarString</h2> |
Sets the value of an entity string variable. Wildcard(s) * are supported for EntityName. * | Sets the value of an entity string variable. Wildcard(s) * are supported for EntityName. * | ||
| Line 74: | Line 103: | ||
* <syntaxhighlight lang="c++" inline>void</syntaxhighlight> | * <syntaxhighlight lang="c++" inline>void</syntaxhighlight> | ||
| − | |||
| − | |||
Revision as of 03:21, 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
Get if an entity automatically falls asleep when it isnt active
bool Entity_GetAutoSleep(const tString &in asName)
Parameters
- asName
(const tString &in)— Name of the entity.
Returns:
bool— if sleeping or not.
Entity_SetIsOccluder
Set if entity is an occluder
void Entity_SetIsOccluder(const tString &in asName,
bool abOccluder)
Parameters
- asName
(const tString &in)— Name of the entity, Wildcard(s) * are supported * - abOccluder
(bool)— true = object is occluder
Returns:
void
Entity_IsOccluder
Get if an entity is an occluder
bool Entity_IsOccluder(const tString &in asName)
Parameters
- asName
(const tString &in)— Name of the entity.
Returns:
bool— if entity is an occluder
Entity_IsInteractedWith
Checks if the entity is being interacted with.
bool Entity_IsInteractedWith(const tString &in asName)
Parameters
- asName
(const tString &in)— name of the entity.
Returns:
bool— if the entity is being interacted with
Entity_SetVarString
Sets the value of an entity string variable. Wildcard(s) * are supported for EntityName. *
void Entity_SetVarString(const tString &in asEntityName,
const tString &in asVarName,
const tString &in asX)
Parameters
- asEntityName
(const tString &in)— - asVarName
(const tString &in)— - asX
(const tString &in)—
Returns:
void