Category:Gamevar manipulation: Difference between revisions

From EDukeWiki
Jump to navigation Jump to search
→‎Gamevar Flags: Updated gamevar flag list to current information taken from source code definitions and comments. It seems to be possible to assign, for instance, the read-only flag to user-defined gamevars, so contrary to what the page stated, flags > 2 can be assigned in CON
Fox (talk | contribs)
Line 22: Line 22:
== Gamevar Flags ==
== Gamevar Flags ==


The following table shows all currently defined gamevar flags. The first 3 are the only ones needed under normal circumstances, but one can also assign higher flags to user-defined gamevars (given that you know what you are doing).
The following table shows all currently defined gamevar flags. The first 2 are the only ones needed under normal circumstances, but one can also assign higher flags to user-defined gamevars (given that you know what you are doing).


<font color="grey">
{{gamevar flags}}
{| {{prettytable}}
!<font color="black">Name</font>!!<font color="black">Number</font>!!<font color="black">Hex</font>!!<font color="black">Description</font>!!<font color="black">Page where such variables should be listed</font>
|-
|<font color="black">GAMEVAR_GLOBAL</font>||<font color="black">0</font>||0x000000||<font color="black">global variable; this is the default</font>||
|-
|<font color="black">GAMEVAR_PERPLAYER</font>||<font color="black">1</font>||0x000001||<font color="black">per-player variable</font>||
|-
|<font color="black">GAMEVAR_PERACTOR</font>||<font color="black">2</font>||0x000002||<font color="black">per-actor variable</font>||
|-
|GAMEVAR_RESET||8||0x000008|| Internal, don't use.||
|-
|GAMEVAR_DEFAULT||256||0x000100||unused, but always cleared for user-defined gamevars||
|-
|GAMEVAR_NODEFAULT||1024||0x000400||Don't reset on actor spawn||
|-
|GAMEVAR_SYSTEM||2048||0x000800||cannot change mode flags...(only default value)||
|-
|GAMEVAR_READONLY||4096||0x001000||values are read-only (no setvar allowed)||
|-
|GAMEVAR_INT32PTR||8192||0x002000||plValue is a pointer to an int32_t||[[Constantly updated gamevars]]
|-
|GAMEVAR_FLOATPTR||16384||0x004000||plValue is a pointer to a float||[[Constantly updated gamevars]]
|-
|GAMEVAR_INT16PTR||32768||0x008000||plValue is a pointer to a short (int16_t)||[[Constantly updated gamevars]]
|-
|GAMEVAR_CHARPTR||65536||0x010000||plValue is a pointer to a char||[[Constantly updated gamevars]]
|-
|GAMEVAR_NORESET||131072||0x020000||var values are not reset when restoring map state||
|-
|GAMEVAR_SPECIAL||262144||0x040000||flag for structure member shortcut vars||
|-
|GAMEVAR_NOMULTI||524288||0x080000||don't attach to multiplayer packets||
|-
|GAMEVAR_Q16PTR||1048576||0x100000|| plValues is a pointer to a q16.16 ||
|-
|GAMEVAR_SERIALIZE || 2097152 ||0x200000|| write into permasaves ||
|}</font>


[[Category:All commands]]
[[Category:All commands]]

Revision as of 18:24, 20 February 2020

Definition

gamevar <varname> <value> <flags>

var <varname> <value> <flags>

A gamevar is a variable that can be used to store numerical data which can then be referenced between actors, states and events. var is hereby semantically equivalent to gamevar.

The gamevar's flags define a bitmap that determines how the variable is treated by the game. For instance, a gamevar with flags of 0 is known as a global variable. A global variable exists once in the code, and any time a global variable is set, the new value is seen by all actors and events. A gamevar with flag bit 1 set is a per-player variable, which exists once for each player in the game. A gamevar with flag bit 2 set is a per-actor variable, which exists as many times in the code as there are sprites in the map. This means that each sprite has its own copy of a per-actor variable stored in memory. Note that a gamevar can only be defined as either global, per-player, or per-actor, but not as a combination thereof.

Gamevars are stored as signed 32-bit integers and therefore have a value range of -2.147.483.648 (-231) to 2.147.483.647 (231-1). Going above and below this range causes the value to overflow and underflow respectively.

Note that it is possible to omit the <value> and <flags> parameters entirely to define a global variable with an initial value of 0, with no other flags set. Example:

var TEMP1

It is also possible to chain flags separately at the end of the gamevar definition, instead of compiling them into a single value, as follows:

var TEMP2 10 1 4096    // This defines a per-player (1), read-only (4096) variable with initial value 10.

The following pages contain information on basic gamevar operations as well as conditional statements:

Gamevar Flags

The following table shows all currently defined gamevar flags. The first 2 are the only ones needed under normal circumstances, but one can also assign higher flags to user-defined gamevars (given that you know what you are doing).


Exposed Value Hex Label Description
Yes 1 0x00000001 GAMEVAR_PERPLAYER Per-player variable.
Yes 2 0x00000002 GAMEVAR_PERACTOR Per-actor variable.
3 0x00000003 GAMEVAR_USER_MASK Bitmask controlling what flags can be set from con; only flags less than this can.
Internal 8 0x00000008 GAMEVAR_RESET
256 0x00000100 GAMEVAR_DEFAULT Allow override (not used, but always cleared for user-defined gamevars).
512 0x00000200 GAMEVAR_FLAG_SECRET Don't dump... (no longer defined in eduke32 source code as of r10016)
Yes 1024 0x00000400 GAMEVAR_NODEFAULT Don't reset on actor spawn. Useful if you want a variable to be set once you start the game (otherwise it's reset each time you start a new game).
2048 0x00000800 GAMEVAR_SYSTEM Cannot change mode flags...(only default value)
4096 0x00001000 GAMEVAR_READONLY Values are read-only (no setvar allowed)
8192 0x00002000 GAMEVAR_INT32PTR plValues is a pointer to an int32_t
16384 0x00004000 GAMEVAR_FLAG_SYNCCHECK check event sync when translating (no longer defined in eduke32 source code as of r10016)
32768 0x00008000 GAMEVAR_INT16PTR plValues is a pointer to a short
Yes 131072 0x00020000 GAMEVAR_NORESET Variable values are not reset when restoring map state
262144 0x00040000 GAMEVAR_SPECIAL Flag for structure member shortcut vars
Yes 524288 0x00080000 GAMEVAR_NOMULTI Don't attach to multiplayer packets
1048576 0x00100000 GAMEVAR_Q16PTR plValues is a pointer to a q16.16
Yes 2097152 0x00200000 GAMEVAR_SERIALIZE Write into permasaves