HPL3/Amnesia: Rebirth/Scripting/Scripting Api/Billboard

From Frictional Wiki
< HPL3‎ | Amnesia: Rebirth‎ | Scripting‎ | Scripting Api
Revision as of 23:56, 15 November 2020 by Abion47 (talk | contribs) (Created page with "{{ScriptingStub}} Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki! ==Summary== {{CodeDocSummaryTop}} {{CodeDocSummaryIte...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

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_SetRenderLayer(const tString &in asBillboardName, int alLayer)
Sets the layer to render the billboard on
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) —
  • afBrightness (float) —

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) —
  • afRangeStart (float) —
  • afRangeEnd (float) —

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) —
  • afRangeStart (float) —
  • afRangeEnd (float) —

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) —
  • abVisibleInReflection (bool) —
  • abVisibleInWorld (bool) —

Returns:

  • void

Billboard_SetRenderLayer

void Billboard_SetRenderLayer(const tString &in asBillboardName,
                              int alLayer)

Sets the layer to render the billboard on

Parameters

  • asBillboardName (tString) —
  • alLayer (int) —

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) —
  • abVisible (bool) —

Returns:

  • void