Regular API function

simGetCollisionHandle / sim.getCollisionHandle

Description Retrieves the handle of a collision object. The operation of this function depends on the current name suffix settings (see sim.getNameSuffix, sim.setNameSuffix, and the section on accessing general-type objects). See also sim.isHandleValid.
C synopsis simInt simGetCollisionHandle(const simChar* collisionObjectName)
C parameters
collisionObjectName: name of the collision object. If the name is appended by a "@silentError" suffix, then no error will be output if the collision object does not exist.
C return value
handle of collision object or -1 if operation was not successful
Lua synopsis number collisionObjectHandle=simGetCollisionObject(string collisionObjectName)
Lua parameters
Same as C-function
Lua return values
Same as C-function
Remote API equiv.
B0-based remote API: simxGetCollisionHandle
Legacy remote API: simxGetCollisionHandle

All regular API functions on one page