GlobalVariable Script

From Creation Kit
Jump to: navigation, search

Extends: Form Script

Script for the manipulation of global variable objects.

Definition

ScriptName GlobalVariable extends Form

Properties

  • float Value [read-write]: The current value of this global variable object.

Global Functions

None

Member Functions

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

  • 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

None