Difference between revisions of "HPL3/SOMA/Scripting/Scripting Api/Meter"
< HPL3 | SOMA | Scripting | Scripting Api
Jump to navigation
Jump to search
(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...") |
(No difference)
|
Latest revision as of 21:56, 24 August 2020
 |
This page has been automatically generated, but it needs descriptions added to the various fields/functions in order to be complete. |
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 | Meter_SetShakeMul(const tString &in asName, float afShakeMul) Sets the shake multiplier of the needle object in meter |
| void | Meter_SetSpeedMul(const tString &in asName, float afSpeedMul) Sets the speed multiplier of the needle object in meter |
| void | Meter_SetState(const tString &in asName, float afState, bool abFadeToState = true) Sets the state of the needle object in meter |
Function Detail
Meter_SetShakeMul
void Meter_SetShakeMul(const tString &in asName,
float afShakeMul)
Sets the shake multiplier of the needle object in meter.
Parameters
- asName (tString) — name of meter object
- afShakeMul (float) — the shaking multiplier. capped at 10.
Returns:
- void
Meter_SetSpeedMul
void Meter_SetSpeedMul(const tString &in asName,
float afSpeedMul)
Sets the speed multiplier of the needle object in meter.
Parameters
- asName (tString) — name of meter object
- afSpeedMul (float) — the speed multiplier.
Returns:
- void
Meter_SetState
void Meter_SetState(const tString &in asName,
float afState,
bool abFadeToState = true)
Sets the state of the needle object in meter. Which then makes the needle move to the specified state.
Parameters
- asName (tString) — name of meter object
- afState (float) — percentage of where the needle should be. 0-1 (min pos - max pos).
- abFadeToState (bool) — if true then the needle will fade to state instead of skipping to it.
Returns:
- void