RigsofRods
Soft-body Physics Simulation
Namespaces | Data Structures | Functions
Script-to-script

^AngelScript^ Documents built-in scripts of the game. More...

+ Collaboration diagram for Script-to-script:

Namespaces

 Script2Script
 Pseudo-namespace; it doesn't exist in code or script runtime, only in this documentation.
 

Data Structures

class  Script2Script::racesManager
 This class allows you to organize races. More...
 
class  Script2Script::raceBuilder
 This class manages a race (singular!) You should only use this directly if the racesManager doesn't suit your needs. More...
 

Functions

funcdef void Script2Script::RACE_EVENT_CALLBACK (dictionary@)
 A function signature for the callback pointers. More...
 
void Script2Script::raceEvent (int trigger_type, string inst, string box, int nodeid)
 called when the user drives through a checkpoint More...
 
void Script2Script::raceCancelPointHandler (int trigger_type, string inst, string box, int nodeid)
 called when the user drives through a cancel point More...
 

Detailed Description

^AngelScript^ Documents built-in scripts of the game.

Function Documentation

◆ RACE_EVENT_CALLBACK()

funcdef void Script2Script::RACE_EVENT_CALLBACK ( dictionary@  )

A function signature for the callback pointers.

When you need to use a RACE_EVENT_CALLBACK as parameter, then you should create a function that receives a dictionary@ as parameter. Example:

// example
void myCallback(dictionary@ d)
{
// ...
}

◆ raceCancelPointHandler()

void Script2Script::raceCancelPointHandler ( int  trigger_type,
string  inst,
string  box,
int  nodeid 
)

called when the user drives through a cancel point

Remarks
Do not call this function directly!

◆ raceEvent()

void Script2Script::raceEvent ( int  trigger_type,
string  inst,
string  box,
int  nodeid 
)

called when the user drives through a checkpoint

Remarks
Do not call this function directly!