Difference between revisions of "HPL3/SOMA/Scripting/Scripting Api/Entity"
< HPL3 | SOMA | Scripting | Scripting Api
Jump to navigation
Jump to search
| Line 8: | Line 8: | ||
<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(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 &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(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 &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(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 &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(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 &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(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 &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> | </tr> | ||
</table> | </table> | ||
Revision as of 02:23, 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