Globals

These functions and variables are accessible from any context.

Instance Methods

Class Handling

Object New(class typeName = ThisClass)

Typically spelled lowercase as a keyword (new.) Creates an object with the specified type. Defaults to using the class of the calling object.

Actor GetDefaultByType(class<Actor> typeName)

Unserializable — Do not use as a member unless marked as transient Returns an object containing the default values for each member of the Actor type provided as they would be set in Actor.BeginPlay. The returned object is a pseudo-object which is stored only in-memory.

Math

NumericType Abs(NumericType n)

Returns |n| (absolute of n.)

double ACos(double n)

Returns the arc-cosine of n.

double ASin(double n)

Returns the arc-sine of n.

double ATan(double n)

Returns the arc-tangent of n.

double ATan2(double y, double x)

Returns the arc-tangent of y / x using the arguments' signs to determine the correct quadrant.

double Ceil(double n)

Returns the integral portion of n, rounded up.

NumericType Clamp(NumericType n, NumericType minimum, NumericType maximum)

Returns n if n is more than minimum and less than maximum, or either of those values if it is not.

double Cos(double n)

Returns the cosine of n.

double CosH(double n)

Returns the hyperbolic cosine of n.

double Exp(double n)

Returns the natural exponent of n. Note that there is a ** binary operator for exponentation, which is generally more useful.

double Floor(double n)

Returns the integral portion of n, rounded down.

double Log(double n)

Returns the natural logarithm of n.

double Log10(double n)

Returns the common (base 10) logarithm of n. This is most useful for calculating the number of decimal digits in a number.

NumericType Max(NumericType n, NumericType maximum)

Returns n if n is less than maximum, or maximum if it is not.

NumericType Min(NumericType n, NumericType minimum)

Returns n if n is more than minimum, or minimum if it is not.

double Sin(double n)

Returns the sine of n.

double SqRt(double n)

Returns the square root of n.

double Tan(double n)

Returns the tangent of n.

double TanH(double n)

Returns the hyperbolic tangent of n.

double VectorAngle(double x, double y)

Equivalent to ATan2(y, x).

Random Number Generation

All of these functions may have [Identifier] between the function name and argument list to specify a named RNG table to use. This special syntax applies only to these functions. An example would be:

int myRandomNumber = Random[MyCoolRng](50, 100);

double FRandom(double min, double max)

Returns a random double between min and max.

double FRandomPick(double ...)

Returns one of the arguments provided randomly.

int Random(int min = 0, int max = 255)

Returns a random int between min and max.

int Random2(uint mask = uint.Max)

Returns a random int between -mask and mask. mask is used as a bit mask, so it is recommended to use a value of one less than a power of two (i.e. 3, 7, 15, 31, 63, 127, 255...)

int RandomPick(int ...)

Returns one of the arguments provided randomly.

void SetRandomSeed(uint num)

Sets the seed of the RNG table to num.

Instance Members

Definitions

readOnly array<class> AllClasses

Every class registered to the engine.

readOnly array<class<Actor> > AllActorClasses

Every Actor-derived class registered to the engine.

readOnly array<PlayerClass> PlayerClasses

Every PlayerClass registered to the engine.

readOnly array<PlayerSkin> PlayerSkins

Every PlayerSkin registered to the engine.

readOnly array<Team> Teams

Every Team registered to the engine.

Players

play PlayerInfo[MAXPLAYERS] Players

The PlayerInfo for each player. These may be invalid data if the corresponding entry in PlayerInGame is not true.

readOnly bool[MAXPLAYERS] PlayerInGame

The status of each player as a boolean. If false then the corresponding player is not in-game.

KeyBindings AutomapBindings

KeyBindings Bindings

TO-DO — This section is not finished yet

Game Information

readOnly bool MultiPlayer

Whether the game is running in multi-player or not. Does not necessarily mean there is network communication happening.

readOnly ui bool NetGame

Whether the game is running in non-local multi-player or not. Must be a networked game with more than one player to be true.

readOnly int Net_Arbitrator

In a NetGame, the number of the player that is currently arbitrating ("hosting") the game.

readOnly bool DemoPlayback

Whether the game is actually a demo playing or not.

Client State

All Data scope globals here are Nondeterministic — Do not rely on its outcome because they rely on the client despite being accessible from non-UI scope.

readOnly int ConsolePlayer

Index of the player running the client.

readOnly bool AutoMapActive

Whether the auto-map is visible for the current player.

int ValidCount

Internal — Do not use The number of line segments to be drawn in the scene.

int LocalViewPitch

Internal — Do not use The pitch angle (in degrees) of ConsolePlayer's view.

readOnly int CleanXFac

readOnly int CleanYFac

An integral scaling factor for horizontal and vertical positions to scale from 320x200 to the current virtual resolution.

readOnly int CleanXFac_1

readOnly int CleanYFac_1

Integral scaling factor for horizontal and vertical positions to scale from 320x200 to the current virtual resolution, accounting for aspect ratio differences.

readOnly int CleanWidth

readOnly int CleanHeight

The current screan size divided by (CleanXFac,CleanYFac).

readOnly int CleanWidth_1

readOnly int CleanHeight_1

The current screan size divided by (CleanXFac_1,CleanYFac_1).

ui Menu.EMenuState MenuActive

The current global menu state.

ui float BackButtonAlpha

The transparency of the back button in menus.

ui int BackButtonTime

TO-DO — This section is not finished yet The time until the back button starts fading out in menus.

ui BaseStatusBar StatusBar

The current status bar being used by the client.

Game State

readOnly EGameAction GameAction

The current game action.

readOnly EGameState GameState

The current game state.

readOnly int GameTic

The current game tic.

readOnly MusPlayingInfo MusPlaying

Information about the currently playing music.

play LevelLocals Level

The current level's local data.

deprecated("3.8") readOnly bool GlobalFreeze

Legacy — Do not use Indicates whether all actors are frozen or not.

Static Game Information

play DeHInfo DeH

Static DeHackEd information.

readOnly GameInfoStruct GameInfo

Static information from MAPINFO GameInfo.

readOnly Weapon Wp_NoChange

A non-weapon that denotes the weapon the player is holding should not be swapped for another weapon.

Static Client Information

readOnly textureId SkyFlatNum

The textureId of the sky texture.

readOnly Font SmallFont

The small font for the current game.

readOnly Font SmallFont2

The small font for strife status bars.

readOnly Font BigFont

The big font for the current game.

readOnly Font ConFont

The console font for the current game.

readOnly Font IntermissionFont

The intermission font for the current game.

readOnly Font NewConsoleFont

The universal unicode small font used by the console.

readOnly Font NewSmallFont

The universal unicode small font used by most things in the engine.

readOnly Font OriginalSmallFont

The small font defined by the IWAD.

readOnly Font OriginalBigFont

The big font defined by the IWAD.

readOnly Font AlternativeSmallFont

If Generic_Ui is true, this font will be defined as either SmallFont, OriginalSmallFont, or NewSmallFont (in that order) depending on which is complete.

readOnly bool Generic_Ui

Will be true if the language defines USE_GENERIC_FONT as a non-zero value. This indicates what the AlternativeSmallFont will be.

readOnly FOptionMenuSettings OptionMenuSettings

The settings used for option menus.

Constants

const int MAXPLAYERS

The maximum amount of players allowed in a networked game.

const int FLAG_NO_CHANGE

A constant for flag changer functions denoting that there should be no change.

Ranges

const double DEFMELEERANGE

The default melee range for monsters and the player's melee attacks.

const double SAWRANGE

The range of Doom's chainsaw.

const double MISSILERANGE

The maximum range for monster hitscan attacks.

const double PLAYERMISSILERANGE

The maximum range for player hitscan attacks.

Attenuations

Preset attenuation values for various purposes.

const double ATTN_NONE

An attenuation at which the sound can be heard from any distance.

const double ATTN_NORM

The default attenuation, which uses the distances defined in SNDINFO.

const double ATTN_IDLE

The default attenuation used by Doom.

const double ATTN_STATIC

An attenuation with which sounds fade fully at 512 map units away.