HPL3/SOMA/Scripting/Scripting Api/Billboard

Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki!

Summary

Return Type	Function and Description
void	Billboard_SetBrightness(const tString &in asBillboardName, float afBrightness) Sets the brightness of a billboard
void	Billboard_SetRangeMax(const tString &in asBillboardName, float afRangeStart, float afRangeEnd) Sets the max range of a billboard, getting far away will cause the billboard to fade out
void	Billboard_SetRangeMin(const tString &in asBillboardName, float afRangeStart, float afRangeEnd) Sets the minimum range of a billboard, getting closer will cause the billboard to fade out
void	Billboard_SetReflectionVisibility(const tString &in asBillboardName, bool abVisibleInReflection, bool abVisibleInWorld) Sets whether the billboard is drawn in reflections or not, and the real world or not
void	Billboard_SetVisible(const tString &in asBillboardName, bool abVisible) Sets if a billboard should be rendered or not

Function Detail

Billboard_SetBrightness

void Billboard_SetBrightness(const tString &in asBillboardName,
                             float afBrightness)

Sets the brightness of a billboard

Parameters

• asBillboardName (tString) — name of billboard. Can contain wildcards.
• afBrightness (float) — new brightness

Returns:

• void

Billboard_SetRangeMax

void Billboard_SetRangeMax(const tString &in asBillboardName,
                           float afRangeStart,
                           float afRangeEnd)

Sets the max range of a billboard, getting far away will cause the billboard to fade out

Parameters

• asBillboardName (tString) — name of billboard. Can contain wildcards.
• afRangeStart (float) — distance the object should start to fade, -1 = no fade
• afRangeEnd (float) — distance the object fade is complete, -1 = no fade

Returns:

• void

Billboard_SetRangeMin

void Billboard_SetRangeMin(const tString &in asBillboardName,
                           float afRangeStart,
                           float afRangeEnd)

Sets the minimum range of a billboard, getting closer will cause the billboard to fade out

Parameters

• asBillboardName (tString) — name of billboard. Can contain wildcards.
• afRangeStart (float) — distance the object should start to fade, -1 = no fade
• afRangeEnd (float) — distance the object fade is complete, -1 = no fade

Returns:

• void

Billboard_SetReflectionVisibility

void Billboard_SetReflectionVisibility(const tString &in asBillboardName,
                                       bool abVisibleInReflection,
                                       bool abVisibleInWorld)

Sets whether the billboard is drawn in reflections or not, and the real world or not.

Parameters

• asBillboardName (tString) — name of billboard. Can contain wildcards.
• abVisibleInReflection (bool) — whether the entity is drawn in reflections
• abVisibleInWorld (bool) — whether the entity is drawn in the real world

Returns:

• void

Billboard_SetVisible

void Billboard_SetVisible(const tString &in asBillboardName,
                          bool abVisible)

Sets if a billboard should be rendered or not.

Parameters

• asBillboardName (tString) — name of billboard. Can contain wildcards.
• abVisible (bool) — if the billboard should be visible or not.

Returns:

• void