Description
|
Retrieves a floating-point parameter of a scene object or calculation object. See also sim.setObjectFloatParameter, sim.getObjectInt32Parameter and sim.getObjectStringParameter
|
C synopsis
|
simInt simGetObjectFloatParameter(simInt objectHandle,simInt parameterID,simFloat* parameter)
|
C parameters |
objectHandle: handle of the object
parameter: retrieved parameter
|
C return value
|
-1 in case of an error, 0 if the parameter could not be retrieved (e.g. because the parameterID doesn't exist, or because the specified object doesn't correspond to the correct type), or 1 if the operation was successful
|
Lua synopsis
|
number result,number parameter=sim.getObjectFloatParameter(number objectHandle,number parameterID)
|
Lua parameters |
Same as C-function
|
Lua return values
|
result: -1 in case of an error, 0 if the parameter could not be retrieved (e.g. because the parameterID doesn't exist, or because the specified object doesn't correspond to the correct type), or 1 if the operation was successful
parameter: retrieved parameter
|
Remote API equiv.
|
|