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: | ||
==Summary== | ==Summary== | ||
| + | |||
| + | Raw HTML | ||
<div style="padding: 8px; border: 1px solid black; margin-bottom: 20px; background: #202020"> | <div style="padding: 8px; border: 1px solid black; margin-bottom: 20px; background: #202020"> | ||
| Line 29: | Line 31: | ||
</table> | </table> | ||
</div> | </div> | ||
| + | |||
| + | Template | ||
| + | |||
| + | {{CodeDocSummaryTop}} | ||
| + | {{CodeDocSummaryItem|bool|[[#Entity_GetAutoSleep|Entity_GetAutoSleep]](const [[../../tString|tString]] &in asName)|Get if an entity automatically falls asleep when it isnt active}} | ||
| + | {{CodeDocSummaryItem|void|[[#Entity_SetIsOccluder|Entity_SetIsOccluder]](const [[../../tString|tString]] &in asName, bool abOccluder)|Set if entity is an occluder}} | ||
| + | {{CodeDocSummaryItem|bool|[[#Entity_IsOccluder|Entity_IsOccluder]](const [[../../tString|tString]] &in asName)|Get if an entity is an occluder}} | ||
| + | {{CodeDocSummaryItem|bool|[[#Entity_IsInteractedWith|Entity_IsInteractedWith]](const [[../../tString|tString]] &in asName)|Checks if the entity is being interacted with.}} | ||
| + | {{CodeDocSummaryItem|void|[[#Entity_SetVarString|Entity_SetVarString]](const [[../../tString|tString]] &in asName, const [[../../tString|tString]] &in asVarName, const [[../../tString|tString]] &in asX)|Sets the value of an entity string variable. Wildcard(s) * are supported for EntityName.}} | ||
| + | {{CodeDocSummaryBottom}} | ||
==Function Detail== | ==Function Detail== | ||
Revision as of 17:54, 11 August 2020
Summary
Raw HTML
| 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. |
Template
| 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. |
Function Detail
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