Functions 365

creates light

add new point to decal, internally, new point is added when previous point is in some distance or the angle is more than some threshold

lmDecal

entity to add new landmark point

point

contact point

normal

normal of contact

alpha

translucency in point

Returns: true if everything was OK, false if not. In this case, the application MUST not used later the pointer to decal, it's finalized internally !

Converts <0.0, 1.0> ARGB into color

is it possible to add new point to landmark decal?

lmDecal

entity to add new landmark point

entity

entity to add new landmark point

mat

material of decal

newpoint

new point to add

Returns: LMD_ERROR = error when adding new point (invalid decal) LMD_VALID = can add new point LMD_DIFF_ENT = new point is on different entity LMD_TOO_FAR = new point is too far from previous point

Clears the key state. Call this function if you want to overcome autorepeating in reporting key state. If called, the KeyState returns pressed only after the key is released and pressed again.

Close the File

file

File handle ID of a opened file

Returns: void
usage :

FileHandle file = OpenFile("$profile:testiik.txt", FileMode.WRITE);
if (file != 0)
{
	FPrintln(file, "line1");
	FPrintln(file, "line2");
	FPrintln(file, "line3");
	CloseFile(file);
}

Triggers breakpoint in C++ in compile time(when app is running in debug enviroment)

copy file. destName must be "$profile:" or "$saves:" location

Creates single visual mark, e.g. from shots //when lifetime=0, pointer to decal is returned, that can be removed by RemoveDecal then

entity

entity where the landmark should be created

origin

first point of the decal, nothing is done now

project

projection direction (length is far clipping distance)

nearclip

near clipping distance

materialName

Material used for decal

lifetime

Lifetime in seconds

flags

Not used ATM

Returns: Decal pointer or null

Creates continous visual mark, e.g. from wheel when a car is moving on the ground

entity

entity where the landmark should be created (only terrain is supported ATM)

origin

first point of the decal, nothing is done now

normal

normal of surface

edgesize

Edge size of decal

lifetime

Lifetime in seconds

materialName

Material used for decal

prev

Previous decal, we are connecting to

alpha

translucency of point

Returns: Decal pointer or null

Dynamic MeshObject

Applies constant force on a rigidbody (origin)

Applies constant force on a position

Applies impuls on a rigidbody (origin)

Applies impuls on a pos position in world coordinates

Disables collisions between two entities

Creates RigidBody from custom made geometries. The geometries are deleted when rigid body is destroyed

centerOfMass

Offset from object-pivot to center of mass

mass

Body mass

geoms

array of custom made geometries

autoptr PhysicsGeomDef geoms[] = {PhysicsGeomDef("", dGeomCreateBox(size), "material/default", 0xffffffff)};
dBodyCreateDynamicEx(this, center, 1.0, geoms);

Creates RigidBody from custom made geometries. The geometries are deleted when rigid body is destroyed

geoms

array of custom made geometries

autoptr PhysicsGeomDef geoms[] = {PhysicsGeomDef("", dGeomCreateBox(size), "material/default", 0xffffffff)};
dBodyCreateStaticEx(this, geoms);

Destroys attached physics body

If both maxMotion and shapeCastRadius is >=0 then the continuous collision detection is enabled. If you want to disable it, use -1

maxMotion

max motion threshold when sphere-cast is performed, to find time of impact. It should be little bit less than size of the geometry to catch the situation when tunelling can happen

sphereCastRadius

The radius of the largest possible sphere, that is completelly inside the body geometry.

Gets angular velocity for a rigidbody

returns center of mass offset

Has the entity attached physics body?

Changed an angular velocity

body

Rigid body

angvel

Angular velocity, rotation around x, y and z axis (not yaw/pitch/roll)

Sets scale factor for all impulses/velocities/forces. Default is <1,1,1>. Zero any axis if you want to do 2D physics

Sets target transformation. If timeslice == dt (simulation step delta time), it will happen in next step, otherwise in time = timeslice

Triggers breakpoint in C++ in run time(when app is running in debug enviroment)

delete file. Works only on "$profile:" and "$saves:" locations

Creates box geometry

Creates capsule geometry

Creates cylinder geometry

Creates sphere geometry

Destroys geometry

Gets global gravity

- free means upper < lower, - locked means upper == lower - limited means upper > lower - axis: first 3 are linear, next 3 are angular

Prints content of variable to console/log. Should be used for critical messages so it will appear in debug log

Changes global gravity

Changes fixed time-slice. Default is 1/40, thus simulation runs on 40fps. With smaller values, there is more precise simulation

Prints current call stack (stack trace)

\verbatim Output: -- Stack trace -- SaveFile() Scripts\Entities\Modules\ModuleBase\ModuleFileHandler.c : 51 SaveConfigToFile() Scripts\Entities\Modules\ModuleBase\ModuleFileHandler\ModuleLocalProfile.c : 114 SaveParameterArray() Scripts\Entities\Modules\ModuleBase\ModuleFileHandler\ModuleLocalProfile.c : 133 SetParameterArray() Scripts\Entities\Modules\ModuleBase\ModuleFileHandler\ModuleLocalProfile.c : 231 PresetAdd() Scripts\Entities\Modules\ModuleBase\ModuleFileHandler\ModuleLocalProfile\ModuleLocalProfileUI.h : 46 OnKeyPress() Scripts/mission/missionGameplay.c : 215 OnKeyPress() Scripts/DayZGame.c : 334 ----------------- \endverbatim

Returns: void

DumpStack();

Prints current call stack (stack trace) to given output

\verbatim Output: SaveFile() Scripts\Entities\Modules\ModuleBase\ModuleFileHandler.c : 51 SaveConfigToFile() Scripts\Entities\Modules\ModuleBase\ModuleFileHandler\ModuleLocalProfile.c : 114 SaveParameterArray() Scripts\Entities\Modules\ModuleBase\ModuleFileHandler\ModuleLocalProfile.c : 133 SetParameterArray() Scripts\Entities\Modules\ModuleBase\ModuleFileHandler\ModuleLocalProfile.c : 231 PresetAdd() Scripts\Entities\Modules\ModuleBase\ModuleFileHandler\ModuleLocalProfile\ModuleLocalProfileUI.h : 46 OnKeyPress() Scripts/mission/missionGameplay.c : 215 OnKeyPress() Scripts/DayZGame.c : 334 \endverbatim

Returns: void

  string tmp;
DumpStackString(tmp);
  Print(tmp);

Don't test hearability. Valid only together with SFX_3D!

Messagebox with error message

Messagebox with error message

Get line from file, every next call of this function returns next line

file

File handle ID of a opened file

var

Value to write

Returns: int Count of chars or -1 if is not any for read (end of file is EMPTY line)
usage :

FileHandle file_handle = OpenFile("$profile:testiik.txt", FileMode.READ);
string line_content;

while ( FGets( file_handle,  line_content ) > 0 )
{
	Print(line_content);
}

CloseFile(file_handle);

Check existence of file

finalize landmark adding, e.g. when entity lose contact with ground -> the pointer to decal should have only world and entity if it has something to render, otherwise it's destroyed here

lmDecal

entity to add new landmark point

addAlpha

if to add last point with transition to zero alpha

alphaDist

distance to add last point

Write to file

file

File handle ID of a opened file

var

Value to write

Returns: void
usage :

FileHandle file = OpenFile("$profile:testiik.txt", FileMode.WRITE);
if (file != 0)
{
	FPrint(file, "A");
	FPrint(file, "B");
	FPrint(file, "C");
	CloseFile(file);
}

Write to file and add new line

file

File handle ID of a opened file

var

Value to write

Returns: void
usage :

FileHandle file = OpenFile("$profile:testiik.txt", FileMode.WRITE);
if (file != 0)
{
	FPrintln(file, "line1");
	FPrintln(file, "line2");
	FPrintln(file, "line3");
	CloseFile(file);
}

returns active entity

Returns current camera transformation

Get the CE API

Returns command line argument

name

of a command line argument

val

string value of the param or empty string if the param hasn't been found

Returns: True if param is present, False if hasn't been found

string param;
GetCLIParam("world", param); // return a value when program executed with param -world something

Returns actual fps (average in last 10 frames)

return value in gamepad axis <-1000; 1000>

return if the button is pressed or not

Returns system time

out hour

int Hour

out minute

int Minute

out second

int Second

Returns: void

int hour = 0;
int minute = 0;
int second = 0;

GetHourMinuteSecondUTC(hour, minute, second);

Print(hour);
Print(minute);
Print(second);

>> hour = 16
>> minute = 38
>> second = 7

Returns UTC system time

out hour

int Hour

out minute

int Minute

out second

int Second

Returns: void

int hour = 0;
int minute = 0;
int second = 0;

GetHourMinuteSecondUTC(hour, minute, second);

Print(hour);
Print(minute);
Print(second);

>> hour = 15
>> minute = 38
>> second = 7

return last landmark point or -65535.0 in all components

lmDecal

decal to test

Returns state of mouse button. It's combination of number of release/pressed edges and mask MB_PRESSED_MASK that is set when button is pressed. If you want just to check if button is pressed, use this: if(GetMouseState(MouseState.LEFT) & MB_PRESSED_MASK)) Print("left button pressed");

returns number of active (simulated) Entities in the world

Returns number of frames, if the object is animation

Loads object from data, or gets it from cache. Object must be released when not used

Get water ocean height at given point

worldX

world x position

worldZ

world z position

Get water ocean height and displacement at given point, returns vector(displaceX, height, displaceZ)

worldX

world x position

worldZ

world z position

Returns registred plugin by class type, better is to use global funtion GetPlugin(typename plugin_type)

module_tpye

typename class type of plugin

Returns: PluginBase

PluginRepairing plugin = GetPluginManager().GetPluginByType(PluginRepairing);

Return value from profile variable, if variable with given name is not present, default value is returned

Returns random loading background texture path

scene light multiplier (based on measured scene light levels) - pre-exposure of light

Returns linear velocity

ent

IEntity entity which origin will be set

mat

vector[4] matrix to be set

Returns: vector linear velocity

Man player = g_Game.GetPlayer();
Print( GetVelocity(player) );

>> <0,0,0>

Returns system date

out year

int Year

out month

int Month

out day

int Day

Returns: void

int year = 0;
int month = 0;
int day = 0;

GetYearMonthDay(year, month, day);

Print(year);
Print(month);
Print(day);

>> year = 2015
>> month = 3
>> day = 24

Returns UTC system date

out year

int Year

out month

int Month

out day

int Day

Returns: void

int year = 0;
int month = 0;
int day = 0;

GetYearMonthDayUTC(year, month, day);

Print(year);
Print(month);
Print(day);

>> year = 2015
>> month = 3
>> day = 24

Yiels execution to other threads and then it continues. Obsolete...

initialize sky with preset, must be called to set the global planets setting

presetName

name of preset to be set (one of presets from file loaded using LoadSkyPresets)

tests if bbox is visible according to view-frustum and PVS

flags

& 1 - test also PVS

Returns: true/false is/isn't visible

circle and cross can be swapped when license area is japan/asia

Returns if command line argument is present

name

of a command line argument

Returns: True if param is present, False if hasn't been found

if (IsCLIParam("verbose")) // Prints "something" when program executed with param -verbose
{
	Print("something");
}

return if landmark was finalized

lmDecal

decal to test

Is ocean availabled

Gets key state

key

Key code

Returns: 0 when not pressed, 15. bit set when pressed, 0.-14. bit pressed count

Kills thread.

owner

Can be NULL for global threads.

name

Name of the first function on stack

Returns: int ???

???

lerp two sky presets and set the result using day time

presetName1

name of preset1 to be set (one of presets from file loaded using LoadSkyPresets)

presetName2

name of preset2 to be set (one of presets from file loaded using LoadSkyPresets)

dayTime

day of time <0, 1>

stormy1

stormy parameter for preset1 <0, 1>

stormy2

stormy parameter for preset2 <0, 1>

lerpVal

lerp value between two presets

lerp three sky presets using barycentric coordinates and set the result using day time

presetName1

name of preset1 to be set (one of presets from file loaded using LoadSkyPresets)

presetName2

name of preset2 to be set (one of presets from file loaded using LoadSkyPresets)

presetName2

name of preset3 to be set (one of presets from file loaded using LoadSkyPresets)

dayTime

day of time <0, 1>

stormy1

stormy parameter for preset1 <0, 1>

stormy2

stormy parameter for preset2 <0, 1>

stormy3

stormy parameter for preset3 <0, 1>

w1

weight for preset1

w2

weight for preset2

w3

weight for preset3

limit function

load all sky presets from xml file

presetFile

name of XML file with presets

Creates error log (optional) from LogTemplate which are registred

template_id

LogTemplateID ID of LogTemplate which was registred in proto/Logtemplate.h -> "class LogTemplates"

message

string Error message for log

Returns: void

LogT(TEMPLATE_JINDRICH, "This is some error log message");

>> output to scriptExt.log (for GamutLogViewer)

Creates info log (optional) from LogTemplate which are registred

template_id

LogTemplateID ID of LogTemplate which was registred in proto/Logtemplate.h -> "class LogTemplates"

message

string Info message for log

Returns: void

LogInfo("This is some info log message", TEMPLATE_JINDRICH);

>> output to scriptExt.log (for GamutLogViewer)

Creates warning log (optional) from LogTemplate which are registred

template_id

LogTemplateID ID of LogTemplate which was registred in proto/Logtemplate.h -> "class LogTemplates"

message

string Warning message for log

Returns: void

LogT(TEMPLATE_JINDRICH, "This is some warning log message");

>> output to scriptExt.log (for GamutLogViewer)

no magazine configured in parent state, looking in inventory

Makes a directory

makes screenshot and stores it in to a DDS format file if the name begins with '$' the screenshot in stored in the fullpath according to the name parameter otherwise the screenshot is stored in "$profile:ScreenShotes/DATE TIME-NAME.dds" where DATE, TIME AND NAME are replaced by actual values

name

name of the screenshot

Switches memory validation (huge slowdown! Use with care only for certain section of code!)

enable

bool Enable

Returns: void

???

Overrides all the environment controllers to be muted

Opens File

name

of a file to open, (you can use filesystem prefixes ('$profile','$saves','$mission'). For accessing profile dir use '$profile', e.g. '$profile:myfilename.txt')

mode

constants FileMode.WRITE, FileMode.READ or FileMode.APPEND flag can be used

Returns: file handle ID or 0 if fails
usage :

FileHandle file = OpenFile("$profile:testiik.txt", FileMode.WRITE);
//FileHandle file = OpenFile("$profile:testiik.txt", FileMode.APPEND);
if (file != 0)
{
	FPrintln(file, "line1");
	FPrintln(file, "line2");
	FPrintln(file, "line3");
	CloseFile(file);
}

tests visibility

from

to

flags

//TraceFlags.VISTEST - //TraceFlags.DETAIL - test agains detail brushes //TraceFlags.ENT - test against brush entities //TraceFlags.NOTRACE - doesn't test geometry (has meaning in conjuction with s TraceFlags.VISTEST)

Returns: true is visible/false not visibel

Parses string into array of tokens returns number of tokens

input

string String for parse

out tokens

array[] Parsed string in array

Returns: int Number of tokens

string token[2];
int result = ParseString("Hello World", token);

for( int i = 0; i < 2; i++ )
{
	Print(token[i]);
}

>> 'Hello'
>> 'World'

Parses one token from input string. Result is put into token string, and type of token is returned. Input string is left-truncated by the resulting token length.

[in,out] input string String for parse\ Output is without founded token

out token

string Founded string token

Returns: int Type of token \verbatim Token types: 0 - error, no token 1 - defined token (special characters etc. . / * ) 2 - quoted string. Quotes are removed -> TODO 3 - alphabetic string 4 - number 5 - end of line -> TODO \endverbatim

string input = "Hello*World";
string token1;
string token2;

int result1 = ParseStringEx(input, token1);
int result2 = ParseStringEx(input, token2);

Print( String( "Token1 = '" + token1 + "' Type = " + result1.ToString() ) );
Print( String( "Token2 = '" + token2 + "' Type = " + result2.ToString() ) );
Print( input );

>> 'Toke1 = 'Hello' Type = 3'
>> 'Toke1 = '*' Type = 1'

Prints content of variable to console/log

Prints formated text to console/log

string c = "Peter";
PrintFormat("Hello %1, how are you?", c); // prints "Hello 'Peter', how are you?"

Prints content of variable to RPT file (performance warning - each write means fflush! use with care)

Reads raw data from file.

param_array

Receiving array for the data. Valid types are int[] or string

length

Length of data

Returns: number of read bytes

Release object. When there are not any other references, object is stored into cache and ready to be victed if necessary.

object

Object handle

flag

If RF_RELEASE is used, the object is evicted immediatelly, if not used by anyone else

removes light

Removes all the previously set overrides of sound controllers

Changes camera position

cam

Index of camera

origin

position

angle

orientation

Changes camera matrix

default 160000 units

default 5 units

set postprocess effect to camera To disable effect in some prioroty ppEffect, just set effectName or name to NULL

cam

number of camera

priority

priority of effect

type

type of effect

materialPath

material

Sets current world. It allows to work with entities outside world processing // return previous world

set global parameters for landmark generation

minSegmentLength

minimum length segment, when new point is added (4 default), when is less, just the end position is on the fly updated

maxSegmentLength

maximum segment length, when length is bigger, the path is finished

degAngle

angle in degrees, when is more, the path is finished

sets Widget typu RTTextureWidgetTypeID, to which it is possible to reference in shader as $rendertarget it is posible to use only after object selection. When selecting another object, it is necessary to set GUI widget again

Sets light cone in degrees (for LightType.SPOT).

sets lookup texture for projection lights

sets which camera will be a listener (for sound engine)

night sky layer rotation matrix

mat

rotation matrix

Writes bool variable to profile, after write don't forget to call CGame::SaveProfile() to save profile to storage!

update of stars

update

true = automatic stars update, false = update is on user by SetStarsRotMatrix

set planet position

index

index of planet, 0 = sun usually

azimuthDeg

azimuth position in degrees

zenithDeg

zenith position in degrees

set planet size in degrees

index

index of planet, 0 = sun usually

angleDeg

angle size in degrees

set sky preset to day time and stormy parameter

presetName

name of preset to be set (one of presets from file loaded using LoadSkyPresets)

stormy

stormy parameter <0, 1>

dayTime

day of time <0, 1>

user can set planets to its own positions on skydome using SetSkyPresetPlanet function, if disabled, the planets are positioned automatically using sky preset setting

enabled

enable/disable

set observer position

latitudeDeg

latitude in degrees

longitudeDeg

longitude in degrees

set UTC time for real time stars

year

month

day

hour

minute

sec

offsetSec

to take into account time difference between Greenwich and local time (position dependency, summer/winter time)

stars rotation matrix, is different from night rotation matrix because we don't know the time when night layers was captured

mat

rotation matrix

Sets linear velocity (for Rigid bodies)

ent

entity which velocity will be set

vel

velocity vector to be set

direct mouse cursor visibility control

Sorts static array of integers(ascendically) / floats(ascendically) / strings(alphabetically)

param_array

array Array to sort

num

int How many items will be sorted in array

Returns: void

string	arrStr[3] = {"Dog", "Car", "Apple"};
Sort(arrStr, 2)
for ( int x = 0; x < 3; x++ )
{
	Print( arrStr[x] );
}

>> 'Car'
>> 'Dog'
>> 'Apple'

Spawns entity in known inventory location

in object_name

string Name of item class

in inv_loc

Inventory Location of the spawned item

Returns: created entity in case of success, null otherwise

finds all entities in a radius

developer tool - start video grabber

developer tool - stop video grabber

Helper for passing string expression to functions with void parameter. Example: Print(String("Hello " + var));

Debug function. Returns current function on stack of the thread

owner

Can be NULL for global threads

name

Name of the first function on stack

backtrace

???

linenumber

???

Returns: string ???

???

performance counter. Returns number of CPU ticks between 'prev' and 'now'

traces line start->end, return 0..1 if trace was sucessfull. // It take bboux from ent // flag like in P2PVisibilityEx will be added //OUTPUT:

cent

[out] traced entity

plane

[out] traced polygon plane (X,Y,Z,D)

surfparm

[out] traced surface parameters

Returns: value 0...1, percentage of a path traveled

Vector constructor from components

x

float x component

y

float y component

z

float z component

Returns: vector resulting vector

Print( Vector(1, 2, 3) );

>> <1,2,3>

finds all visible entities (rought, according to a visibility. It is convinient for entitie selection where we want to do more precise visibility test)

origin

- position it is looked from

look

- look direction

angle

- view angle (usuably 90). -1 if we do not care about the view angle

ents

- array to which entities will be stored

maxents

- length of the array (prevents overflowing the array)

fmask

- flag mask (SetFlags()). Entity must have all flags set. it is possible to use reserved flags like EntityFlags.USER1, EntityFlags.USER2, EntityFlags.USER6 for fast finding of entities in custom categories

Returns name of visual object

creates animation system events