class CGameSource

Called when some system event occur.

eventTypeId

event type.

params

Param object, cast to specific param class to get parameters for particular event.

Called after creating of CGame instance

Called when recieving focus (windows)

Called when loosing focus (windows)

Called once before game update loop starts, ret value indicates if init was done in scripts, otherwise it is done in the engine

Called when inputs is not possible (Steam overlay active or something), all internal script variables should be reset here!

Called on World update

doSim

False when simulation is paused, True otherwise

timeslice

time elapsed from last call

Called on World update after simulation of entities

doSim

False when simulation is paused, True otherwise

timeslice

time elapsed from last call

Called when key is pressed

key

direct input key code (DIK)

Called when key is released

key

direct input key code (DIK)

Called when mouse button is pressed

button

- number of button \ref Mouse

Called when mouse button is released

button

- number of button \ref Mouse

create custom main menu part (submenu)

create custom window part

Called after remote procedure call is recieved for this object

target

object on which remote procedure is called, when NULL, RPC is evaluated by CGame as global

rpc_type

user defined identification of RPC

ctx

read context for params

Sets exit code and quits in the right moment

Sets exit code and restart in the right moment

Returns if the application is focused on PC, returns true always on console

Gets the server address. (from client)

Gets the server name. (from client)

Gets the server data. (from client)

Connects to IsServer

IpAddress

of the server

port

of the server set to 0 for default port

password

of the server

Returns: 0 on success, error code from ErrorModuleHandler on not success

Connects to last success network session

Returns: 0 on success, error code from ErrorModuleHandler on not success

Disconnects from current multiplayer session

Forces disconnect from current multiplayer session even if not yet in the game

Gets array of strings from profile variable

name

of the variable

values

output values
usage:

TStringArray lastInventoryArray = new TStringArray;
g_Game.GetProfileStringList("lastInventory", lastInventoryArray);

Gets string from profile variable

name

of the variable

value

output value

Returns: true when successful

Sets array of strings to profile variable

name

of the variable

values

to set

Sets string to profile variable

name

of the variable

value

to set

Saves profile on disk.

Gets current player name

name

output value

Gets current player name. If length of player name is grater than maxLength, then it is omitted and append ellipsis

maxLength

- max chars in name

name

- output value of player name with 'maxLength' characters and then ellipsis "..."

Sets current player name

name

Assign player entity to client (in multiplayer)

name

Selects player's controlled object

identity

identity used in MP (use NULL in singleplayer)

player

object which should be controlled by player

returns player's network id from identity id in out parameters

identity

PlayerIdentity.id used in MP (use NULL in singleplayer)

networkIdLowBits

lower bits of 64bit network id

networkIdHighBits

higher bits of 64bit network id

Returns entity identified by network id

networkIdLowBits

identity used in MP (use NULL in singleplayer)

networkIdHighBits

object which should be controlled by player

Static objects cannot be replicated by default (there are too many objects on the map). Use this method when you want to replicate some scripted variables. Cannot be called in object's constructor, because networking is not initialized yet

object

static object to replicate

Returns: false, if registration wasn't successful or when object is already registered

Returns the state of the buffer for network inputs (UAInterface)

Returns: true, if the buffer is filled and client simulation must stop

Creates spectator object (mostly cameras)

identity

identity used in MP (use NULL in singleplayer)

spectatorObjType

classname for spectator object (like cameras)

position

where to create spectator instance

Updates spectator position on server = position of network bubble

position

Inform client about logout time (creates logout screen on specified client)

player

object which is logging out

time

length of logout

Destroy player info and disconnect

Add player to reconnect cache to be able to rejoin character still existing in the world

identity

of player

Remove player from reconnect cache

uid

of the player

Remove all player from reconnect cache

Set actual storage version - for next save

Returns actual storage version - loading

Returns actual storage version - saving

Returns current daytime on server

Get string value from config on path.

path

of value, classes are delimited by empty space. You can specify config file by using "configFile" or "missionConfigFile" as a first class name.

value

output

Returns: true on success

Get raw string value from config on path.

path

of value, classes are delimited by empty space. You can specify config file by using "configFile" or "missionConfigFile" as a first class name.

value

output in raw format (localization keys '$STR_' are not translated)

Returns: true on success

Get string value from config on path.

path

of value, classes are delimited by empty space. You can specify config file by using "configFile" or "missionConfigFile" as a first class name.

Returns: value output string

Changes localization key format to script-friendly format.

original

config string.

Returns: value output string with '$' substituted to script-friendly '#'. If not found, does nothing.

Get name of the p3d file of the given class name.

class

name of the desired object

Returns: Name of the object's p3d file (without the '.p3d' suffix)

Get float value from config on path.

path

of value, classes are delimited by empty space. You can specify config file by using "configFile" or "missionConfigFile" as a first class name.

Returns: value

Get vector value from config on path.

path

of value, classes are delimited by empty space. You can specify config file by using "configFile" or "missionConfigFile" as a first class name.

Returns: value

Get int value from config on path.

path

of value, classes are delimited by empty space. You can specify config file by using "configFile" or "missionConfigFile" as a first class name.

Returns: value

Returns type of config value

path

of value, classes are delimited by empty space. You can specify config file by using "configFile" or "missionConfigFile" as a first class name.

Returns: one of constants CT_INT, CT_FLOAT, CT_STRING, CT_ARRAY, CT_CLASS, CT_OTHER

Get array of strings from config on path.

path

of value, classes are delimited by empty space. You can specify config file by using "configFile" or "missionConfigFile" as a first class name.

value

output
usage :

TStringArray characterAnimations = new TStringArray;
g_Game.ConfigGetTextArray("CfgMovesMaleSdr2 States menu_idleUnarmed0 variantsPlayer", characterAnimations);

Get array of raw strings from config on path.

path

of value, classes are delimited by empty space. You can specify config file by using "configFile" or "missionConfigFile" as a first class name.

value

output in raw format (localization keys '$STR_' are not translated)
usage :

TStringArray characterAnimations = new TStringArray;
g_Game.ConfigGetTextArrayRaw("CfgMovesMaleSdr2 States menu_idleUnarmed0 variantsPlayer", characterAnimations);

Get array of floats from config on path.

path

of value, classes are delimited by empty space. You can specify config file by using "configFile" or "missionConfigFile" as a first class name.

value

output

Get array of integers from config on path.

path

of value, classes are delimited by empty space. You can specify config file by using "configFile" or "missionConfigFile" as a first class name.

value

output

Get name of subclass in config class on path.

path

of value, classes are delimited by empty space. You can specify config file by using "configFile" or "missionConfigFile" as a first class name.

index

of subclass in class

name

output

Returns: true on success, false if path or child is not found

Get name of base class of config class on path.

path

of value, classes are delimited by empty space. You can specify config file by using "configFile" or "missionConfigFile" as a first class name.

name

output

Returns: true on success, false if path or base is not exists

Get count of subclasses in config class on path.

path

of value, classes are delimited by empty space. You can specify config file by using "configFile" or "missionConfigFile" as a first class name.

index

of parameter in class

name

output

Returns: true on success, false if path or child is not found

Converts array of strings into single string.

Array

of strings like {"All", "AllVehicles", "Land"}

Returns: Converts given array into something lile "All AllVehicles Land".

???

Get command line parameter value.

name

of parameter

value

output

Returns: true when parameter exists, false otherwise
usage :

// you run e.g.: DayZInt.exe -scriptDebug=true
string value;
if (g_Game.CommandlineGetParam("scriptDebug", value) && value == "true")
{
	Print("Script debugging on!");
}

Preload objects with certain type in certain distance from camera.

type

of objects which should be preloaded

distance

from camera in which objects should be preloaded

Returns: true on success

Creates object of certain type

type

of objects to create

pos

position where to create object

create_local

if True, object is not spawned on clients only on server

init_ai

if creating object is LightAI class, by this param is initialised AI or not

Returns: new Object

Creates object of certain type

type

of objects to create

pos

position where to create object

iFlags

are used to setup object and/ or spawn behavior

iRotation

are used to setup object rotation on spawn (or default if not specified)

Returns: new Object

RemoteObjectDelete - deletes only remote object (unregisters from network). do not use if not sure what you do

RemoteObjectDelete - deletes only remote object tree (unregisters from network). do not use if not sure what you do

RemoteObjectCreate - postponed registration of network object (and creation of remote object). do not use if not sure what you do

RemoteObjectTreeCreate - postponed registration of network object tree (and creation of remote objects). do not use if not sure what you do

returns true if player can access item's cargo/attachments (check only distance)

Delevoper only: Executes Enforce Script expression, if there is an error, is printed into the script console

Delevoper only: Dump all script allocations

Get list of all debug modes

Set specific debug mode

Gets state of specific debug mode

Get list of all debug draw modes

Set debug draw mode

Gets current debug draw mode

If physics extrapolation is enabled, always true on retail release builds

Return the number of gizmos

Return the instance passed in for the gizmo

Return the tracker passed in for the gizmo

Returned index is invalid if any other Gizmo function is called

Clear the gizmo

Clear all gizmos

Applies impulses to set the position when dynamic, otherwise sets the transform in the physics scene

Tracker for 'GizmoFind' is the passed in object

Applies impulses to set the position when dynamic, otherwise sets the transform in the physics scene. Doesn't work in multiplayer

Tracker for 'GizmoFind' is the owned Entity

Note: Currently, GizmoGetInstance doesn't work due to Script Error: 'Physics' can't be compared against 'Class'

Scripted controls, requires the following methods to be implemented in the class void Gizmo_SetWorldTransform(vector[4] transform, bool finalize) void Gizmo_GetWorldTransform(vector[4] transform)

Tracker for 'GizmoFind' is the passed in instance

Returns average FPS of last 16 frames

Returns: fps in milliseconds

Returns current framerate.

Returns: Current framerate as frames per second.

Returns average framerate over last n frames.

nFrames

The number of frames to compute average of, up to 64.

Returns: Average frames per second over last n frames.

Returns minimum framerate over last n frames.

nFrames

The number of frames to find minimum of, up to 64.

Returns: Minimum frames per second over last 64 frames.

Returns maximum framerate over last n frames.

nFrames

The number of frames to find maximum of, up to 64.

Returns: Maximum frames per second over last n frames.

Outputs framerate statistics.

min

Outputs minimum framerate over last n frames in frames per second.

max

Outputs maximum framerate over last n frames in frames per second.

avg

Outputs average framerate over last n frames in frames per second.

nFrames

The number of frames to take into account, up to 64.

Returns current time from start of the game

Returns: time in seconds

Returns list of all objects in circle "radius" around position "pos"

pos

radius

objects

output array

Returns list of all objects in sphere "radius" around position "pos"

pos

radius

objects

output array

Stores login userdata as parameters which are sent to server

Returns the direction where the mouse points, from the camera view

Transforms position in world to position in screen in pixels as x, y component of vector, z parameter represents distance between camera and world_pos

Transforms position in world to position in screen in pixels as x, y component of vector, z parameter represents distance between camera and world_pos

Transforms position in world to position in screen in percentage (0.0 - 1.0) as x, y component of vector, z parameter represents distance between camera and world_pos

Return singleton of MenuData class - at main menu contains characters played with current profile.

Initiate remote procedure call. When called on client, RPC is evaluated on server; When called on server, RPC is executed on all clients

target

object on which remote procedure is called, when NULL, RPC is evaluated by CGame as global

rpc_type

user defined identification of RPC

params

custom params array

recipient

specified client to send RPC to. If NULL, RPC will be send to all clients (specifying recipient increase security and decrease network traffic)

const int RPC_LOW_BLOOD_PRESSURE_EFFECT = 0;
...
// on server side, after blood pressure of player is low...
Param1<float> p = new Param1<float>(m_blood_pressure);
array<param> params = new array<param>;
params.Insert(p);
g_Game.RPC(player, RPC_LOW_BLOOD_PRESSURE_EFFECT, params);
// or shortcut
g_Game.RPCSingleParam(player, RPC_LOW_BLOOD_PRESSURE_EFFECT, p);
...
// on client
class PlayerBase
{
	// override OnRPC function
	void OnRPC(PlayerIdentity sender, int rpc_type, ParamsReadContext ctx)
	{
		// dont forget to propagate this call trough class hierarchy!
		super.OnRPC(rpc_type, ctx);

		switch(rpc_type)
		{
			case RPC_LOW_BLOOD_PRESSURE_EFFECT:
				Param1<float> p = Param1<float>(0);
				if (ctx.Read(p))
				{
					float blood_pressure = p.param1;
					float effect_intensity = 1.0 - blood_pressure;
					ShowFancyScreenEffect(effect_intensity);
				}
			break;
		}
	}
}

see CGame.RPC

Not actually an RPC, as it will send it only to yourself

Use for profiling code from start to stop, they must match have same name, look wiki pages for more info: https://confluence.bistudio.com/display/EN/Profiler

Use for profiling code from start to stop, they must match have same name, look wiki pages for more info: https://confluence.bistudio.com/display/EN/Profiler

Prints text into game chat.

text

to print

colorClass

??
usage :

g_Game.Chat("Item splitted", "colorAction");

Mutes voice of source player to target player

muteUID

uid of player you want to mute

playerUID

uid of player that (doesnt't) want to hear muteUID

Mute all players for listenerId

listenerId

uid of player

mute

true, if player can not listen anybody. Otherwise false.

Enable/disable VoN for target player

player

in question

enable

sets if player can use VoN

Enable/disable VoN effect (only on server)

player

in question

voice

effect (VoiceEffectMumbling = 1, VoiceEffectExtortion = 2, VoiceEffectObstruction = 4)

enable

or disable effect

Set voice level of VoN (only on client) (VoiceLevelWhisper = 0, VoiceLevelNormal = 1, VoiceLevelShout = 2)

level

of voice

Get voice level of VoN (on both client and server) (VoiceLevelWhisper = 0, VoiceLevelNormal = 1, VoiceLevelShout = 2)

Enable microphone to locally capture audio from user. Audio heard does NOT automatically get transmitted over network

enable

enables or disabled listening

Returns whether mic is currently capturing audio from user

Returns whether user is currently in a voice party (currently only supported on xbox)

Starts intro

Starts mission (equivalent for SQF playMission). You MUST use double slash \\

Create only enforce script mission, used for mission script reloading

Returns to main menu, leave world empty for using last mission world

Logout methods

Robust check which is preferred than the above, as it is valid much sooner

Server config parsing. Returns 0 if not found.

API for surface detection

Returns: Y position the surface was found

Y input: Maximum Y to trace down from; Returns: Y position the surface was found

Get max sea wave height

Get current sea wave height

Get the nearest water or object surface under a point, ignoring land (without the fake wave that's on top of the real wave)

Get the nearest water or object surface under a point, ignoring land (with the fake wave that's on top of the real wave)

Returns the largest height difference between the given positions

Returns tilt of the ground on the given position in degrees, so you can use this value to rotate any item according to terrain.

Checks if the surface is digable

Checks if the surface is fertile

Finds all objects that are in choosen oriented bounding box (OBB)

center

vector, center of OBB

orientation

vector, direction (front vector), used for calculation of OBB rotation

edgeLength

vector, sizes of whole box

excludeObjects

array<Object>, objects that should be excluded from collision check

collidedObjects

array<Object>, out parameter, objects that collided with OBB

Returns: bool, true if at least one object collided with OBB, false otherwise

vector pos = GetPosition();
vector orientation = GetOrientation();
vector size = "10 4 8";
array<Object> excluded_objects = new array<Object>;
excluded_objects.Insert(this);
array<Object> nearby_objects = new array<Object>;

if(g_Game.IsBoxColliding( pos, orientation, size, excluded_objects, nearby_objects))
{
	for (int i = 0, c = nearby_objects.Count(); i < c; ++i)
	{
		PrintString("object " + i.ToString());
	}
}

Finds all objects with geometry iType that are in choosen oriented bounding box (OBB)

center

vector, center of OBB

orientation

vector, direction (front vector), used for calculation of OBB rotation

edgeLength

vector, sizes of whole box

iPrimaryType

int, type of intersection, possible values ObjIntersectFire(0), ObjIntersectView(1), ObjIntersectGeom(2), ObjIntersectIFire(3), ObjIntersectNone(4)

iSecondaryType

int, type of intersection, possible values ObjIntersectFire(0), ObjIntersectView(1), ObjIntersectGeom(2), ObjIntersectIFire(3), ObjIntersectNone(4)

excludeObjects

array<Object>, objects that should be excluded from collision check

collidedObjects

array<Object>, out parameter, objects that collided with OBB

Returns: bool, true if at least one object collided with OBB, false otherwise

vector pos = GetPosition();
vector orientation = GetOrientation();
vector size = "10 4 8";
array<Object> excluded_objects = new array<Object>;
excluded_objects.Insert(this);
array<Object> nearby_objects = new array<Object>;

if(g_Game.IsBoxCollidingGeometry( pos, orientation, size, ObjIntersectView, ObjIntersectGeom, excluded_objects, nearby_objects))
{
	for (int i = 0, c = nearby_objects.Count(); i < c; ++i)
	{
		PrintString("object " + i.ToString());
	}
}

Returns weather controller object.

Sets custom camera camera EV. range: -50.0..50.0? //TODO

override inventory light

diffuse

directional light

ambient

ambient light

ground

ground light

dir

direction of light, Vector(0,0,1) is from camera

set night vission parameters (set to zero when to disable it)

lightIntensityMul

multiplicator of lights intensity

noiseIntensity

intensity of noise PP

Initialization of damage effects

This function returns valid data only inside AfterLoad event. Do not use this in anywhere else.

Its main purpose is only for keep track on object connections after server restarts, all data related to this function are deleted when server initialization is done.

Returns is class name inherited from parent class name

cfg_class_name

Config Class name ("Animal_CervusElaphus")

cfg_parent_name

Parent Config Class name ("DZ_LightAI")

Returns: bool is class name inherited from parent class name

bool is_kind = g_Game.IsKindOf( "Animal_CervusElaphus", "DZ_LightAI");
PrintString(ToString(is_kind));

>> 1

Returns is object inherited from parent class name

object

Object

cfg_parent_name

Parent Config Class name ("DZ_LightAI")

Returns: bool is object inherited from parent class name

bool is_kind = g_Game.IsKindOf( my_animal, "DZ_LightAI");
PrintString(ToString(is_kind));

>> 1

Searches given config path (config_path) for the given member (searched_member) and returns its index. \nReturns -1 if not found.
usage:

int skinning_class_index = g_Game.ConfigFindClassIndex(cfgPath_animal, "Skinning");

returns mission time in milliseconds

Returns CallQueue for certain category

call_category

call category, valid values are:
CALL_CATEGORY_SYSTEM - calls & timers in this queue are processed every time without any restrictions
CALL_CATEGORY_GUI - calls & timers in this queue are processed when GUI is enabled (even during pase game)
CALL_CATEGORY_GAMEPLAY - calls & timers in this queue are processed only during mission, when game is not paused
usage:

g_Game.GetCallQueue(CALL_CATEGORY_GUI).Call(this, "Refresh"); // calls "Refresh" function on "this" with no arguments
g_Game.GetCallQueue(CALL_CATEGORY_GUI).Call(this, "Show", new Param1<bool>(true)); // calls "Show" function on "this" with one bool argument
g_Game.GetCallQueue(CALL_CATEGORY_GUI).Call(this, "SetPos", new Param2<float, float>(0.2, 0.5)); // calls "SetPos" function on "this" with two float arguments

Returns TimerQueue for certain category

call_category

call category, valid values are:
CALL_CATEGORY_SYSTEM - calls & timers in this queue are processed every time without any restrictions
CALL_CATEGORY_GUI - calls & timers in this queue are processed when GUI is enabled (even during pase game)
CALL_CATEGORY_GAMEPLAY - calls & timers in this queue are processed only during mission, when game is not paused

Returns DragQueue. Callbacks are called on mouse move until mouse button is released, then the queue is cleaned.

returns class name of first valid survivor (TODO address confusing naming?)

returns class name of random survivor (TODO address confusing naming?)

outputs array of all valid survivor class names

Return DLC service (service for entitlement keys for unlock content)

Returns true when current mission is Main Menu