Difference between revisions of "Special variables"

From the Oblivion ConstructionSet Wiki
Jump to navigation Jump to search
imported>JOG
m (Gameplay variables moved to Special variables)
imported>JOG
(Changed to table, added predefined local variables)
Line 1: Line 1:
== Globals ==
Some [[Globals|global]] variables are predefined and handled and/or updated by the game-engine itself.  
Some [[Globals|global]] variables are predefined and handled and/or updated by the game-engine itself.  


<pre>
{|border="1" cellpadding="5" cellspacing="0"
short GameYear       The current year
|-
 
! style="background:#efefef;" | Type
short GameMonth       The current month
! style="background:#efefef;" | Name
! style="background:#efefef;" | Description
|-
|short
|GameYear
|The current year
|-
|short
|GameMonth
|The current month
|-
|short
|GameDay
|The current day
|-
|float
|GameHour
|The current hour (0-24 hours)
|-
|short
|TimeScale
|Minutes that pass in-game within one minute of real-life
|-
|short
|GameDaysPassed
|Days that have passed since the beginning of the game
|-
|}


short GameDay        The current day


float GameHour        The current hour (0-24 hours)


== Locals ==


short TimeScale      Minutes that pass in-game within one minute of real-life
There are also local variables with special functions:
{|border="1" cellpadding="5" cellspacing="0"
|-
! style="background:#efefef;" | Script-Type
! style="background:#efefef;" | Variable-Type
! style="background:#efefef;" | Name
! style="background:#efefef;" | Description
|-
|[[quest script|Quest]]
|float
|fQuestDelayTime 
|Determines how long (in real-time seconds) the game will wait between two runs of a [[quest script]]  (Exception: 0 = game default: 5 secs)
|-
|[[Object_scripts|Object]][[TrapUpdate|(Trap)]]
|float
|fTrapDamage
|Amount of damage to do each time the trap affects an actor.
|-
|[[Object_scripts|Object]][[TrapUpdate|(Trap)]]
|float
|fTrapPushBack
|Amount of push back force to apply each time a trap effects an actor.  This should range from 0 to 1000.
|-
|[[Object_scripts|Object]][[TrapUpdate|(Trap)]]
|float
|fTrapMinVelocity
|Minimum velocity a trap must be moving at relative to the actor to do damage (combination of actor and traps respective velocities).  This value is in BSUnits (128 = 6ft).
|-
|[[Object_scripts|Object]][[TrapUpdate|(Trap)]]
|float
|bTrapContinuous
|0 = Only deal damage on first contact with trap.
1 = Continously subtract damage as long as actor is in contact with trap.
|}




short GameDaysPassed  Days that passed since the beginning of the game
</pre>
[[Category:Variables]]
[[Category:Variables]]

Revision as of 10:38, 14 May 2006

Globals

Some global variables are predefined and handled and/or updated by the game-engine itself.

Type Name Description
short GameYear The current year
short GameMonth The current month
short GameDay The current day
float GameHour The current hour (0-24 hours)
short TimeScale Minutes that pass in-game within one minute of real-life
short GameDaysPassed Days that have passed since the beginning of the game


Locals

There are also local variables with special functions:

Script-Type Variable-Type Name Description
Quest float fQuestDelayTime Determines how long (in real-time seconds) the game will wait between two runs of a quest script (Exception: 0 = game default: 5 secs)
Object(Trap) float fTrapDamage Amount of damage to do each time the trap affects an actor.
Object(Trap) float fTrapPushBack Amount of push back force to apply each time a trap effects an actor. This should range from 0 to 1000.
Object(Trap) float fTrapMinVelocity Minimum velocity a trap must be moving at relative to the actor to do damage (combination of actor and traps respective velocities). This value is in BSUnits (128 = 6ft).
Object(Trap) float bTrapContinuous 0 = Only deal damage on first contact with trap.

1 = Continously subtract damage as long as actor is in contact with trap.