Regular API function
simSetScriptStringParam / sim.setScriptStringParam
Description
|
Sets a string parameter of a script. See also the other functions related to script parameters.
|
C/C++ synopsis
|
simInt simSetScriptStringParam(simInt scriptHandle,simInt parameterID,simChar* parameter,simInt parameterLength)
|
C/C++ parameters |
scriptHandle: handle of the script
parameter: parameter value (can contain embedded zeros)
parameterLength: the length of the parameter value
|
C/C++ return value
|
-1 in case of an error, 0 if the parameter could not be set, or 1 if operation was successful
|
Lua synopsis
|
sim.setScriptStringParam(int scriptHandle,int parameterID,buffer parameter) |
Lua parameters |
Similar to the C-function counterpart. Additionally, sim.handle_self may be used for scriptHandle.
|
Lua return values
|
|
Python synopsis |
sim.setScriptStringParam(int scriptHandle,int parameterID,string/bytes parameter) |
|