Regular API function


Description Handles (executes) the main script, i.e. the main simulation loop.
C synopsis simInt simHandleMainScript()
C parameters
C return value
A main script execution result. If the return value contains sim_script_main_script_not_called, then the main script was not called (e.g. because a plugin hindered it when it received the sim_message_eventcallback_mainscriptabouttobecalled message). Otherwise, the main script was called and simAdvanceSimulationByOneStep should be executed.
Lua synopsis -
Lua parameters
Lua return values

All regular API functions on one page