Difference between revisions of "GlobalVariable Script"

From the CreationKit Wiki
Jump to navigation Jump to search
imported>Jog
imported>CraftySentinel
m (→‎Member Functions: Formatting Change)
Line 19: Line 19:


== Member Functions ==
== Member Functions ==
'''float Function [[GetValue - GlobalVariable|GetValue]]()'''
*Returns this global variable's current value.


'''int Function [[GetValueInt - GlobalVariable|GetValueInt]]()'''
{|class="wikitable" width =100%
*Returns this global variable's current value cast as an int.
!style="text-align:left;"|Function
!style="text-align:left;"|Description
|-
|[[GetValue - GlobalVariable|Float '''GetValue'''()]]
|Returns this global variable's current value.
|-


'''float Function [[Mod - GlobalVariable|Mod]](float afHowMuch)'''
|[[GetValueInt - GlobalVariable|Int '''GetValueInt'''()]]
*Modifies this global variable's value in a more thread-safe way.
|Returns this global variable's current value cast as an int.
|-


'''Function [[SetValue - GlobalVariable|SetValue]](float afNewValue)'''
|[[Mod - GlobalVariable|Float '''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)'''
|[[SetValue - GlobalVariable|'''SetValue'''(Float ''afNewValue'')]]
*Sets this global variable's current value to the specified int.
|Sets this global variable's current value.
|-
 
|[[SetValueInt - GlobalVariable|'''SetValueInt'''(Int ''aiNewValue'')]]
|Sets this global variable's current value to the specified int.
|-
 
|}


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

Revision as of 04:02, 24 October 2013


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

Function Description
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.

Events

None