HPL3/SOMA/Scripting/Scripting Api/Terminal

From Frictional Wiki
< HPL3‎ | SOMA‎ | Scripting‎ | Scripting Api
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 Terminal_FadeImGuiStateColor(const tString &in asPropName, const tString &in asVarName, cColor aGoalVal, float afTime, eEasing aType = eEasing_QuadInOut, bool abReplaceIfExist = true)
void Terminal_FadeImGuiStateFloat(const tString &in asPropName, const tString &in asVarName, float afGoalVal, float afTime, eEasing aType = eEasing_QuadInOut, bool abReplaceIfExist = true)
void Terminal_FadeImGuiStateVector3f(const tString &in asPropName, const tString &in asVarName, cVector3f avGoalVal, float afTime, eEasing aType = eEasing_QuadInOut, bool abReplaceIfExist = true)
void Terminal_ForceCacheUpdate(const tString &in asName)
Forces the terminal to update its cache
bool Terminal_GetImGuiStateBool(const tString &in asPropName, const tString &in asVarName, bool alDefault = false)
cColor Terminal_GetImGuiStateColor(const tString &in asPropName, const tString &in asVarName, const cColor &in aDefault)
float Terminal_GetImGuiStateFloat(const tString &in asPropName, const tString &in asVarName, float afDefault = 0.0f)
int Terminal_GetImGuiStateInt(const tString &in asPropName, const tString &in asVarName, int alDefault = 0)
cVector3f Terminal_GetImGuiStateVector3f(const tString &in asPropName, const tString &in asVarName, const cVector3f &in avDefault)
void Terminal_IncImGuiStateColor(const tString &in asPropName, const tString &in asVarName, const cColor &in aVal)
void Terminal_IncImGuiStateFloat(const tString &in asPropName, const tString &in asVarName, float afVal)
void Terminal_IncImGuiStateInt(const tString &in asPropName, const tString &in asVarName, int alVal)
void Terminal_IncImGuiStateVector3f(const tString &in asPropName, const tString &in asVarName, const cVector3f &in avVal)
bool Terminal_IsGuiActive(const tString &in asName)
Get if the terminal GUI is active
void Terminal_SetAllowInteraction(const tString &in asName, bool abX)
Set if the terminal should allow interaction from player
void Terminal_SetEnterCallback(const tString &in asName, const tString &in asCallback)
Set the terminal's Enter callback
void Terminal_SetFPSWhenIdle(const tString &in asName, float afFPS)
Sets the FPS of the terminal when not in focus
void Terminal_SetGuiActive(const tString &in asName, bool abX, float afFadeTime = 0.0f)
Set if the terminal should visible
void Terminal_SetImGuiStateBool(const tString &in asPropName, const tString &in asVarName, bool abVal)
void Terminal_SetImGuiStateColor(const tString &in asPropName, const tString &in asVarName, const cColor &in aVal)
void Terminal_SetImGuiStateFloat(const tString &in asPropName, const tString &in asVarName, float afVal)
void Terminal_SetImGuiStateInt(const tString &in asPropName, const tString &in asVarName, int alVal)
void Terminal_SetImGuiStateVector3f(const tString &in asPropName, const tString &in asVarName, const cVector3f &in avVal)
void Terminal_SetLeaveCallback(const tString &in asName, const tString &in asCallback)
Set the terminal's Leave callback
void Terminal_SetOnGuiFunction(const tString &in asName, const tString &in asCallback)
Set the terminal's GUI method
void Terminal_SetShowMouse(const tString &in asPropName, bool abShow)
void Terminal_SetUpdateWhenOutOfView(const tString &in asName, bool abX)
Set if the terminal should update when not visible
void Terminal_StopImGuiFade(const tString &in asPropName, const tString &in asVarName)

Function Detail

Terminal_FadeImGuiStateColor

void Terminal_FadeImGuiStateColor(const tString &in asPropName,
                                  const tString &in asVarName,
                                  cColor aGoalVal,
                                  float afTime,
                                  eEasing aType = eEasing_QuadInOut,
                                  bool abReplaceIfExist = true)


Parameters

  • asPropName (tString) —
  • asVarName (tString) —
  • aGoalVal (cColor) —
  • afTime (float) —
  • aType (eEasing) —
  • abReplaceIfExist (bool) —

Returns:

  • void

Terminal_FadeImGuiStateFloat

void Terminal_FadeImGuiStateFloat(const tString &in asPropName,
                                  const tString &in asVarName,
                                  float afGoalVal,
                                  float afTime,
                                  eEasing aType = eEasing_QuadInOut,
                                  bool abReplaceIfExist = true)


Parameters

  • asPropName (tString) —
  • asVarName (tString) —
  • afGoalVal (float) —
  • afTime (float) —
  • aType (eEasing) —
  • abReplaceIfExist (bool) —

Returns:

  • void

Terminal_FadeImGuiStateVector3f

void Terminal_FadeImGuiStateVector3f(const tString &in asPropName,
                                     const tString &in asVarName,
                                     cVector3f avGoalVal,
                                     float afTime,
                                     eEasing aType = eEasing_QuadInOut,
                                     bool abReplaceIfExist = true)


Parameters

Returns:

  • void

Terminal_ForceCacheUpdate

void Terminal_ForceCacheUpdate(const tString &in asName)

Forces the terminal to update its cache. Used to stop drastic changes to the look of a
GUI from popping into view when the terminal switches from cache to normal rendering.

Parameters

  • asName (tString) — name of terminal.

Returns:

  • void

Terminal_GetImGuiStateBool

bool Terminal_GetImGuiStateBool(const tString &in asPropName,
                                const tString &in asVarName,
                                bool alDefault = false)


Parameters

Returns:

  • bool

Terminal_GetImGuiStateColor

cColor Terminal_GetImGuiStateColor(const tString &in asPropName,
                                   const tString &in asVarName,
                                   const cColor &in aDefault)


Parameters

Returns:

  • cColor

Terminal_GetImGuiStateFloat

float Terminal_GetImGuiStateFloat(const tString &in asPropName,
                                  const tString &in asVarName,
                                  float afDefault = 0.0f)


Parameters

  • asPropName (tString) —
  • asVarName (tString) —
  • afDefault (float) —

Returns:

  • float

Terminal_GetImGuiStateInt

int Terminal_GetImGuiStateInt(const tString &in asPropName,
                              const tString &in asVarName,
                              int alDefault = 0)


Parameters

Returns:

  • int

Terminal_GetImGuiStateVector3f

cVector3f Terminal_GetImGuiStateVector3f(const tString &in asPropName,
                                         const tString &in asVarName,
                                         const cVector3f &in avDefault)


Parameters

Returns:

  • cVector3f

Terminal_IncImGuiStateColor

void Terminal_IncImGuiStateColor(const tString &in asPropName,
                                 const tString &in asVarName,
                                 const cColor &in aVal)


Parameters

Returns:

  • void

Terminal_IncImGuiStateFloat

void Terminal_IncImGuiStateFloat(const tString &in asPropName,
                                 const tString &in asVarName,
                                 float afVal)


Parameters

Returns:

  • void

Terminal_IncImGuiStateInt

void Terminal_IncImGuiStateInt(const tString &in asPropName,
                               const tString &in asVarName,
                               int alVal)


Parameters

Returns:

  • void

Terminal_IncImGuiStateVector3f

void Terminal_IncImGuiStateVector3f(const tString &in asPropName,
                                    const tString &in asVarName,
                                    const cVector3f &in avVal)


Parameters

Returns:

  • void

Terminal_IsGuiActive

bool Terminal_IsGuiActive(const tString &in asName)

Get if the terminal GUI is active.

Parameters

  • asName (tString) — name of terminal.

Returns:

  • bool

Terminal_SetAllowInteraction

void Terminal_SetAllowInteraction(const tString &in asName,
                                  bool abX)

Set if the terminal should allow interaction from player

Parameters

  • asName (tString) — name of terminal. Wildcards are allowed.
  • abX (bool) — if interactions are allowed or not

Returns:

  • void

Terminal_SetEnterCallback

void Terminal_SetEnterCallback(const tString &in asName,
                               const tString &in asCallback)

Set the terminal's Enter callback
Syntax for callback function: void FuncName(const tString&in asEntityName)

Parameters

  • asName (tString) — name of terminal.
  • asCallback (tString) — Callback called when entering terminal.

Returns:

  • void

Terminal_SetFPSWhenIdle

void Terminal_SetFPSWhenIdle(const tString &in asName,
                             float afFPS)

Sets the FPS of the terminal when not in focus.

Parameters

  • asName (tString) — name of terminal.
  • afFPS (float) — times/second to update the terminal when not in focus.

Returns:

  • void

Terminal_SetGuiActive

void Terminal_SetGuiActive(const tString &in asName,
                           bool abX,
                           float afFadeTime = 0.0f)

Set if the terminal should visible. If off, the offline color is used.

Parameters

  • asName (tString) — name of terminal. Wildcards are allowed.
  • abX (bool) — if the GUI should be active or not.
  • afFadeTime (float) — time the GUI will be fading in/out (in seconds).

Returns:

  • void

Terminal_SetImGuiStateBool

void Terminal_SetImGuiStateBool(const tString &in asPropName,
                                const tString &in asVarName,
                                bool abVal)


Parameters

Returns:

  • void

Terminal_SetImGuiStateColor

void Terminal_SetImGuiStateColor(const tString &in asPropName,
                                 const tString &in asVarName,
                                 const cColor &in aVal)


Parameters

Returns:

  • void

Terminal_SetImGuiStateFloat

void Terminal_SetImGuiStateFloat(const tString &in asPropName,
                                 const tString &in asVarName,
                                 float afVal)


Parameters

Returns:

  • void

Terminal_SetImGuiStateInt

void Terminal_SetImGuiStateInt(const tString &in asPropName,
                               const tString &in asVarName,
                               int alVal)


Parameters

Returns:

  • void

Terminal_SetImGuiStateVector3f

void Terminal_SetImGuiStateVector3f(const tString &in asPropName,
                                    const tString &in asVarName,
                                    const cVector3f &in avVal)


Parameters

Returns:

  • void

Terminal_SetLeaveCallback

void Terminal_SetLeaveCallback(const tString &in asName,
                               const tString &in asCallback)

Set the terminal's Leave callback
Syntax for callback function: void FuncName(const tString&in asEntityName)

Parameters

  • asName (tString) — name of terminal.
  • asCallback (tString) — Callback called when leaving terminal.

Returns:

  • void

Terminal_SetOnGuiFunction

void Terminal_SetOnGuiFunction(const tString &in asName,
                               const tString &in asCallback)

Set the terminal's GUI method

Parameters

  • asName (tString) — name of terminal.
  • asCallback (tString) — terminal update method, prototype void OnGUI(const tString &in asEntityName, float afTimeStep)

Returns:

  • void

Terminal_SetShowMouse

void Terminal_SetShowMouse(const tString &in asPropName,
                           bool abShow)


Parameters

  • asPropName (tString) —
  • abShow (bool) —

Returns:

  • void

Terminal_SetUpdateWhenOutOfView

void Terminal_SetUpdateWhenOutOfView(const tString &in asName,
                                     bool abX)

Set if the terminal should update when not visible. Use sparingly.

Parameters

  • asName (tString) — name of terminal.
  • abX (bool) — if it should update when not visible.

Returns:

  • void

Terminal_StopImGuiFade

void Terminal_StopImGuiFade(const tString &in asPropName,
                            const tString &in asVarName)


Parameters

Returns:

  • void