Regular API function

simRemoveScript / sim.removeScript

Description Removes a script. Not all script types can be removed, and it will also depend on whether simulation is running or not. See also sim.addScript.
C synopsis simInt simRemoveScript(simInt scriptHandle)
C parameters
scriptHandle: handle of the script to remove or sim_handle_all to remove all scripts
C return value
-1 if operation was not successful. In a future release, a more differentiated return value might be available
Lua synopsis number result=sim.removeScript(number scriptHandle)
Lua parameters
Same as C-function. Additionally you can specify sim.handle_self to have the script remove itself.
Lua return values
Same as C-function

All regular API functions on one page