Regular API function

simRemoveCollection / sim.removeCollection

Description Removes a collection from the scene, including the objects it contains. If you just want to remove the collection, but not the objects it contains, call sim.emptyCollection beforehand. See also sim.createCollection and sim.addObjectToCollection.
C synopsis simInt simRemoveCollection(simInt collectionHandle)
C parameters
collectionHandle: handle of the collection to remove. sim_handle_all removes all collections from the scene
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.removeCollection(number collectionHandle)
Lua parameters
Same as C-function
Lua return values
Same as C-function

All regular API functions on one page