Regular API function


Description Clears a collection from all the objects it contains. An empty collection will not survive, unless you add some objects to it again with simAddObjectToCollection right after. See also simRemoveCollection.
C synopsis simInt simEmptyCollection(simInt collectionHandle)
C parameters
collectionHandle: handle of the collection to clear. sim_handle_all clears all collections from their obects.
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=simEmptyCollection(number collectionHandle)
Lua parameters
Same as C-function
Lua return values
Same as C-function

All regular API functions on one page