Functions

void sleep( uint ms )

Stops thread processing for some number of milliseconds.

void openBrowser( string& url )

Open a URI in the user's configured browser.

double getExactTime( )

Returns nanosecond-accurate system time in seconds (slow).

double get_gameTime( )

Returns the current game clock, updated periodically, in seconds.

double get_frameTime( )

Returns the current frame time in seconds.

double get_frameLength( )

Returns the timespan represented by this frame in seconds.

uint get_systemTime( )

Returns millisecond-accurate system time in milliseconds.

double randomd( )

Generate a random double value. Returns double : Random value from [0.0,1.0).

double randomd( double min, double max )

Generate a random double value. Returns double : Random value from [min,max).

float randomf( )

Generate a random float value. Returns float : Random value from [0.f,1.f).

float randomf( float min, float max )

Generate a random float value. Returns float : Random value from [min,max).

uint randomi( )

Generate a random uint value. Returns uint : Random value from 0 to UINT_MAX, inclusive.

int randomi( int min, int max )

Generate a random int value. Returns int : Random value from min to max, inclusive.

double normald( double min, double max, int steps = 3 )

Generates an approximately normally distributed value within a range, within an average return at the mean of min and max. Returns double : Random value from [min,max)

vec3d random3d( double radius = 1.0 )

Generates a random 3D rotation, uniformly distributed over a sphere surface. Returns vec3d : Random rotation vector.

vec2d random2d( double radius = 1.0 )

Generates a random 2D rotation, uniformly distributed over a circle's circumference. Returns vec2d : Random rotation vector.

vec3d random3d( double minRadius, double maxRadius )

Generates a random 3D rotation, distributed evenly on the volume between minRadius and maxRadius. Returns vec3d : Random rotation vector.

vec2d random2d( double minRadius, double maxRadius )

Generates a random 2D rotation, distributed evenly on the area between minRadius and maxRadius. Returns vec2d : Random rotation vector.

double clamp( double value, double minimum, double maximum )

Clamps the value to within the specified range.

int clamp( int value, int minimum, int maximum )

Clamps the value to within the specified range.

void quarticRoots( double a, double b, double c, double d, double e, double[]& roots )

Calculates all real roots of a quartic polynomial.

vec3d toVec3d( string& str )

Parses a vec3d printed by vec3d::toString()

void addConsoleCommand( string& name, ConsoleCommand@ comm )

Registers a script console command.

string format( string& fmt, string& arg1 )

Replaces $n in fmt with the related argument. Returns string : Formatted string.

string format( string& fmt, string& arg1, string& arg2 )

Replaces $n in fmt with the related argument. Returns string : Formatted string.

string format( string& fmt, string& arg1, string& arg2, string& arg3 )

Replaces $n in fmt with the related argument. Returns string : Formatted string.

string format( string& fmt, string& arg1, string& arg2, string& arg3, string& arg4 )

Replaces $n in fmt with the related argument. Returns string : Formatted string.

string format( string& fmt, string& arg1, string& arg2, string& arg3, string& arg4, string& arg5 )

Replaces $n in fmt with the related argument. Returns string : Formatted string.

string format( string& fmt, string[]& args )

Replaces $n in fmt with the related argument. Returns string : Formatted string.

void getSkinStyles( dictionary& result )

Fill the passed dictionary with a mapping of all skin style names to their enum identifiers.

uint getSkinStyleCount( )

Returns uint : The amount of skin styles currently defined.

string getElementFlagName( uint flags )

Retrieve the string name of a combination of skin flags. Returns string : Name(s) of flags.

const Font@ getFont( string& name )

Get a font by name.

FontType getFontType( string& name )

Get a font type by name.

SkinColor getColorType( string& name )

Get a color type by name.

const Skin@ getSkin( string& name )

Get a skin by name.

void setClip( recti& clip )

Set the currently active clipping rectangle.

void clearClip( )

Clear the current clipping rectangle.

vec2i get_screenSize( )

Get the current size of the game screen.

bool get_windowFocused( )

Whether the game window is currently focused.

vec2i get_windowSize( )

Get the actual window size (independent of ui scaling).

bool get_mouseOverWindow( )

Whether the mouse is currently over the window.

vec2i get_mousePos( )

Get the current mouse position.

void set_mousePos( vec2i& arg0 )

Set the mouse position.

void set_mouseLock( bool lock )

Sets whether the cursor should be locked to the screen, if the user has enabled the feature.

double get_uiScale( )

Returns double : Global zoom factor on the entire UI.

void set_uiScale( double value )

void resetLights( )

Resets to default lighting. State of input lights is unchanged.

void applyTransform( vec3d& pos, vec3d& scale, quaterniond& rot )

Applies a transformation to the modelview matrix. Also applies the camera's position as an offset. Call undoTransform() afterwards.

void applyAbsTransform( vec3d& pos, vec3d& scale, quaterniond& rot )

Applies a transformation to the modelview matrix. Call undoTransform() afterwards.

void applyBBTransform( vec3d& pos, double width, double rot )

Applies a transformation that rotates a model in the same way a billboard would rotate. Call undoTransform() afterwards.

void undoTransform( )

Undoes a modelview transform.

void getBillboardVecs( vec3d& upLeft, vec3d& upRight, double rot = 0 )

Fetches the two cached vectors necessary to build a billboard.

void getBillboardVecs( vec3d& from, vec3d& upLeft, vec3d& upRight, double rot = 0 )

Fetches the two cached vectors necessary to build a billboard that faces the camera.

Object@ getObjectByID( int id )

Returns the Object associated with the ID. Returns Object@ : Null if the object doesn't exist.

Object@[]@ findInBox( vec3d& min, vec3d& max, uint ownerFilter = 0 )

Returns an array of objects within the specified region.

Object@ trace( line3dd& ray, uint ownerFilter = 0 )

Returns the first object located along a line. Returns Object@ : First object (if any) hit by the trace.

const SoundSource@ getSound( string& id )

Returns the sound source associated with the id. Returns const SoundSource@ : Can be null if not present.

Sound@ playTrack( string& filename, bool loop = false, bool pause = false )

Plays a streaming sound source from the beginning. Returns Sound@ : Handle to the sound.

Sound@ playTrack( string& filename, vec3d& pos, bool loop = false, bool pause = false )

Plays a streaming sound source from the beginning. Returns Sound@ : Handle to the sound.

bool get_soundEnabled( )

Returns true if the sound system is present (even at 0 volume).

float get_soundVolume( )

Returns the current volume of the sound system. Returns float : Multiplier to output volume between 0 and 1.

void set_soundVolume( float arg0 )

Sets the sound system's volume.

void set_soundScale( float arg0 )

Sets the overall scale of the sound system's world.

string get_profileRoot( )

Returns string : Path to the game's global profile folder.

string get_modProfile( )

Returns string : Path to the current mod's profile folder.

string get_modProfile( string& folder )

Get the path to a child directory in the mod's profile. Returns string : Path to the folder.

string get_baseProfile( string& folder )

Get the path to a child directory in the base profile. Returns string : Path to the folder.

string resolve( string& filename )

Resolves the filename to an absolute path to an overriden file. The top-most mod with a file in the same relative path is used.

void deleteFile( string& filename )

Deletes the specified file. Must be within the profile or game folders.

void makeDirectory( string& dirname )

Create a new directory.

bool isDirectory( string& path )

Check whether a particular path is a directory. Returns bool : Whether a directory exists at that path.

int64 getModifiedTime( string& path )

Get the timestamp a file was last modified at. Returns int64 : Last modification time of file.

bool fileExists( string& path )

Check whether a particular file exists. Returns bool : Whether a file exists at that path.

string path_join( string& first, string& second )

Concatenate two file paths. Returns string : Concatenated path.

string path_up( string& path )

Go up one directory from a path. Returns string : Parent path.

string getBasename( string& path, bool includeExtension = true )

Get the basename of a path. Returns string : Path basename.

void getWikiPage( string& title, WebData& dat )

Load the contents of a page from the wiki.