Difference between revisions of "GlobalVariable Script"
Jump to navigation
Jump to search
imported>CraftySentinel m (Reverted To List) |
imported>OpusGlass (Corrected the manner for traditionally casting the SetValue function with an int argument.) |
||
| (One intermediate revision by one other user not shown) | |||
| Line 31: | Line 31: | ||
:*Sets this global variable's current value to the specified int. | :*Sets this global variable's current value to the specified int. | ||
== Notes == | |||
*For SetValueInt(), and GetValueInt(), it is better and faster to use traditional cast methods. As is the compiler will auto-cast them which is slower. Use GetValue() as int, and SetValue(MyInt as float) instead. | |||
== Events == | == Events == | ||
None | None | ||
Latest revision as of 23:39, 7 October 2018
Extends: Form Script
Script for the manipulation of global variable objects.
Definition[edit | edit source]
ScriptName GlobalVariable extends FormProperties[edit | edit source]
- float Value [read-write]: The current value of this global variable object.
Global Functions[edit | edit source]
None
Member Functions[edit | edit source]
- Float GetValue()
- Returns this global variable's current value.
- Int GetValueInt()
- Returns this global variable's current value cast as an int.
- Float Mod(Float afHowMuch)
- Modifies this global variable's value in a more thread-safe way.
- SetValue(Float afNewValue)
- Sets this global variable's current value.
- SetValueInt(Int aiNewValue)
- Sets this global variable's current value to the specified int.
Notes[edit | edit source]
- For SetValueInt(), and GetValueInt(), it is better and faster to use traditional cast methods. As is the compiler will auto-cast them which is slower. Use GetValue() as int, and SetValue(MyInt as float) instead.
Events[edit | edit source]
None