Difference between revisions of "GlobalVariable Script"

From the CreationKit Wiki
Jump to navigation Jump to search
imported>Jlundin
 
imported>Jog
Line 19: Line 19:


== Member Functions ==
== Member Functions ==
*float Function [[GetValue - GlobalVariable|GetValue]]()
'''float Function [[GetValue - GlobalVariable|GetValue]]()'''
**Returns this global variable's current value.
*Returns this global variable's current value.
*int Function [[GetValueInt - GlobalVariable|GetValueInt]]()
 
**Returns this global variable's current value cast as an int.
'''int Function [[GetValueInt - GlobalVariable|GetValueInt]]()'''
*float Function [[Mod - GlobalVariable|Mod]](float afHowMuch)
*Returns this global variable's current value cast as an int.
**Modifies this global variable's value in a more thread-safe way.
 
*Function [[SetValue - GlobalVariable|SetValue]](float afNewValue)
'''float Function [[Mod - GlobalVariable|Mod]](float afHowMuch)'''
**Sets this global variable's current value.
*Modifies this global variable's value in a more thread-safe way.
*Function [[SetValueInt - GlobalVariable|SetValueInt]](int aiNewValue)
 
**Sets this global variable's current value to the specified int.
'''Function [[SetValue - GlobalVariable|SetValue]](float afNewValue)'''
*Sets this global variable's current value.
 
'''Function [[SetValueInt - GlobalVariable|SetValueInt]](int aiNewValue)'''
*Sets this global variable's current value to the specified int.


== Events ==
== Events ==
None
None

Revision as of 12:47, 20 February 2012


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 Function GetValue()

  • Returns this global variable's current value.

int Function GetValueInt()

  • Returns this global variable's current value cast as an int.

float Function Mod(float afHowMuch)

  • Modifies this global variable's value in a more thread-safe way.

Function SetValue(float afNewValue)

  • Sets this global variable's current value.

Function SetValueInt(int aiNewValue)

  • Sets this global variable's current value to the specified int.

Events

None