HPL3/SOMA/Scripting/Scripting Api/Entity

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

• 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

• 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

• 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.

• 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. *

• asEntityName (tString) —
• asVarName (tString) —
• asX (tString) —

Returns:

• void