🟢 «< BACK TO START
This section is a work-in-progress. Contents to be revised/corrected/expanded.
In ZScript: a function declared as action. Usually this is only useful for Weapon and CustomInventory classes. See: Weapons, overlays and PSprite.
In DECORATE: any function that can be called in an actor’s state.
A base class in GZDoom (the inheritance chain is Object→Thinker→Actor). The classes based on Actor are also referred to as “actors.” The absolute majority of objects that can be spawned in the game’s world (such as monsters, weapons, decorations) are actors. The base Actor class contains all actor logic (such as gravity, velocity, collision) and all native actor functions.
A series of commands placed inside a single code block attached to a single actor state. See: Anonymous Functions.
A type of variable that can contain a list of values rather than a single value. Arrays can be static (their contents are defined explicitly and can’t be changed at runtime) and dynamic (initially empty, but can be filled with data at runtime). Dynamic arrays can also be fixed-size (the data can be changed dynamically, but the number of indexes can’t).
A variable that is a part of a function. Also known as parameter. Arguments of a function are defined in parentheses, right after the name of the function. Arguments can be optional (in which case they have a default value that will be used unless a different value is specified) or non-optional (they don’t have a default value; the value has to be defined when the function is called). See: Custom Functions.
An integer variable that is designed to hold multiple values. The intended values are flags where each flag corresponds to a specific bit value: 2, 4, 8, 16, and so on. This provides a unique opportunity to use a single integer variable to hold multiple values. For example, if the value of the field is 12, we know that it contains flags 8 and 4 because no other combination can result in the total number of 12.
Bit fields are often used as arguments in functions. See: Flow Control - Bitwise Operators.
A value that can only be true or false (or, if expressed numerically, 1 and 0 respectively).
To call: to execute something, like a function. For example, monsters usually call the A_Chase function to walk around and chase their targets.
The object: the object (such as a class, or an actor) that is calling a function. For example, when a Rocket hits something and calls A_Explode to deal radius damage, the Rocket is the calling actor in the context of that function.
The main type of object in ZScript that can hold fields (class-scope variables), methods (class functions), constants, enums and other data. See: Defining ZScript classes.
A set of instructions (such as function calls, expressions or declaration of variables) placed within a single pair of curly braces ({ }).
A piece of data that has a fixed value that can’t be changed at runtime. Constants are used to give fixed values a nice name. Common examples of constants are flags used as function arguments are names of sound channels (such as CHAN_BODY) or PSprite layer numbers (such as PSP_Weapon). Constants can be defined within a class or on their own. See: Constants and enums.
The environment and circumstances in which something happens—for example, a specific piece of code is executed. The meaning is somewhat situational. For example, a virtual function, a weapon state, an event and such can be contexts, since they determine how specific things should be handled (e.g. the available pointers, how the code is executed, etc.).
The { and } characters. Sometimes incorrectly referred to as “brackets”, which is wrong, because brackets are [ and ]. Curly braces are used to mark the start and the end of a code block.
Aka crash, CTD. When GZDoom closes unexpectedly to a “Very Fatal Error” window showing a memory address. This means that something happened that GZDoom was not able to handle properly. This is almost always a reason to make a bug report, because no matter what kind of a mistake you might’ve made, GZDoom should be able to process it correctly and lead to a VM abort with a proper error message.
“To declare” means to create or to define something, like a variable or a function. For example, if you do int foo in your code, this means a variable foo is declared.
An Actor-specific block that contains actor properties and flags that determine the actor’s default behavior (i.e. the behavior it’ll exhibit on spawning). The definition of the block begins with a Default header.
A double is a decimal value, like 1.5, 7.842, and so on. A double is very similar to a float-point number, but the difference is that it has higher precision, which basically means that it can hold more numbers after the point.
A list of constants of the same type. See: Constants and enums.
A virtual function of an event handler class that is automatically triggered by specific things happening in the game (such as the map being loaded, the player connecting, an actor being spawned/damaged/destroyed/resurrected, and other). See: Event Handlers.
A class-scope variable (a variable that is defined at the top of the class—outside of any other code block—and is thus available anywhere in the class). See: Variables and data types.
In an Actor: A type of a boolean Actor property that can be set or unset by using +<FLAGNAME> or -<FLAGNAME> in the actor’s Default block or by setting bFLAGNAME to true or false on an actor pointer. Flags are internally defined as a bit field.
In a function: A bitfield that functions as an argument of a function so that it can combine multiple values. The flags are integer numbers that normally receive “nice names” by being defined as constants. Flags can be set, unset and combined with bitwise operators. See: Flow Control.
Flow is a generic term referring to code which describes the order in which certain things in the code are executed. Various statements (such as IF conditions) offer means to control the flow of the code. See Flow Control.
A set of instructions united under a single name that can be called by referencing that name. Functions support arguments that they can utilize. Functions can be of various types: regular, virtual, action, static. They can also be void or have a return value. See: Custom Functions.
Very literally, an instance of an object. For example, GZDoom comes with the code for the class called DoomImp. Each imp that spawns in the map and starts doing stuff is an instance of that class. Each instance of an object can be in different states (existing, destroyed, alive, dead, etc.) and be doing different things. See: Pointers and casting.
A value that contains a whole number without a decimal part, like 1, 2, 5, 100, etc.
The process of creating an instance of something. For example, actors are instantiated by being spawned in the map. See: Pointers and casting.
The process of going through a series of pieces of data, one by one, usually with the intent to do something with that data. For example, you can iterate over an array or a linked list.
Inventory class is one of the base native classes. Classes based on Inventory can function as items: they can be attached to other actors’ inventories, gaining the owner pointer to those actors. Inventory comes with a number of custom properties and flags, as well as virtual functions, such as DoEffect(), TryPickup(), HandlePickup() and others.
Actors can hold items (instances of the Inventory class) in their inventory. That inventory is a linked list that is just a list of items attached to said actor.
See: Inventory.
A simple data structure similar to arrays. In contrast to arrays, elements of a linked list don’t have indexes. Instead, each element has a pointer to the next element, so you can iterate over it to do something with its elements. See: Arrays and linked lists.
A function defined within a class. See: Custom Functions. In ZScript, all functions are either methods, or anonymous functions.
The practice of putting code blocks inside other code blocks, such as:
if (condition)
{
...
if (condition2)
{
...
if (condition3)
{
...
A large number of nested blocks makes it harder to read the function and understand its intended flow. If that happens, it may be better to move some of the instructions into a separate dedicated function.
The process of checking that something isn’t null. Most of the time it looks like if (<pointer> != null) or, a shorter version, if (<pointer>). This is used when you have a pointer to some object but that object is not guaranteed to exist. For example, you want to do something with a monster’s target, but when the code is executed, you can’t know if said monster has already acquired a target or not.
In ZScript: the most basic class. All classes inherit from Object. If you create a new class without a parent, it’ll be implicitly inherited from Object.
In a more general sense: any more or less clearly defined unit of data, such as a class, a struct, etc.
Same as argument.
A variable that points to another object—like an instance of another class. See: Pointers and casting.
Properties are variables that were made accessible in the Default block of an actor. When defined as a property, variables can be given default values with the help of the Default block. See: Turning variables into actor properties.
A concept similar to a pointer, a reference is any case where code (be it ZScript or engine code) is accessing something not directly, but through some kind of reference. For example, the functions that play sounds, like A_StartSound, cannot use sound file names directly. Instead, they refer to a sound definition made in the SNDINFO lump. That is an example of a reference.
On a purely coding level, a reference is also a way to pas a value indirectly. References are usually arguments in functios, and they can be defined with an out keyword. Compare:
// function that takes a double argument,
// multiplies it by a random value, then
// returns it:
double RandomMultiply(double val)
{
return val * frandom(0, 10);
}
//elsewhere:
double baseval = 3.5;
baseval = RandomMultiply(baseval);
In this example we pass baseval to RandomMultiply which then returns a modifier value. But the same can be done by passing a variable by reference:
// function that modifies a given value
// and doesn't return anything:
void RandomMultiply(out double val)
{
val *= frandom(0, 10);
}
//elsewhere:
double baseval = 3.5;
RandomMultiply(baseval);
// baseval has now been processed by RandomMultiply()
The second example passes baseval to the argument val by reference, and then RandomMultiply() modifies whatever variable (baseval in this example) was passed to it.
A value that can be obtained by calling a function. All functions that aren’t void have a return value.
A general context where a specific piece of data, object or function is defined and/or can be called. ZScript supports 3 scopes: play (used by any class that exists in the map, i.e. classes based on Thinker; stores and modifies data that exists in the playsim), ui (used by HUDs and menus; can read play data but not modify it) and data (used by default by all classes based on Object; can be created and modified from either play or ui scopes, but itself cannot modify anything outside of data scope). The clearscope access modifier defines the piece of data to be readable in all scopes.
In a narrower sense, “scope” can refer to the context within which specific data is available. For example, a variable defined at the top of a class (i.e. a field) can be described as a “class-scoped variable.”
An exceprt containing some code from a larger piece of code/program.
A single instruction in a States block. Only classes based on Actor can have states. A graphic, a duration and a function call can be attached to a state. See: State Control.
Not to be confused with a state label.
A header for a series of states inside a States block. State labels can converted to state pointers with FindState() and ResolveState(), and jumped to with goto. If there’s no goto, loop or another state control instruction at the end of a specific state sequence, the machine will just fall through to the next sequence. See: State Control.
State labels are often referred to as just “states”, which is incorrect: for example, a “Spawn” state label is specifically the label given to the spawn sequence, whereas a “Spawn state” would be only the first actual state of that sequence.
A piece of data, such as a number, a text string, a pointer, or any other possible data type. Values can be obtained (e.g. via functions), stored (in variables) and manually set.
A piece of data of specific type, with a specific name. The value of that data can be not only read but also changed dynamically—hence it’s “variable”. Variables can be declared at the top of a class (or, more specifically, at any place in the class outside of any code block), which makes them a field (available anywhere within the class), or within a code block like an anonymous function (which makes them a local variable, available only within that code block). See: Variables and data types.
In very simple terms, a vector is a line that points from one point in space to another point in space. In ZScript vectors are often used to express position and velocity of actors. The game’s world has a point of origin with XYZ coordinates of (0, 0, 0), and every actor’s position is offset from that point. Similarly, velocity is directed somewhere along those XYZ axes.
In ZScript most vectors are either 2-dimensional (only have X and Y components) or 3-dimensional (X, Y and Z).
AKA virtual method. A function declared as virtual. These functions can be overridden in classes based on the class where the function is declared.
A virtual machine abort or virtual machine escape. It’s when GZDoom closes to the console and shows an error message. Should not be confused with a crash (which is when GZDoom is not able to show an error message). VM abort will tell you exactly what went wrong with your code and where.
A function that is explicitly designed to call another function, usually to perform some additional setup before doing so. For example:
void A_CustomPainSound()
{
sound snd = "monsters/zombie/painlight";
if (health < GetMaxHealth()*0.5)
{
snd = "monsters/zombie/painheavy";
}
A_StartSound(snd);
}
This function is meant to be a custom replacement for A_Pain (the function that plays a monster’s painsound), which plays one of the two sounds depending on whether its health is above 50% or not. At the end it calls A_StartSound, the basic sound-playing functions. As such, A_CustomPainSound is a wrapper for A_StartSound.
🟢 «< BACK TO START