Regular API function

simSetCollectionName / sim.setCollectionName

Description Sets the name of a collection based on its handle. See also sim.getCollectionName.
C synopsis simInt simSetCollectionName(simInt collectionHandle,const simChar* collectionName)
C parameters
collectionHandle: handle of the collection
collectionName: new name of the collection
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.setCollectionName(number collectionHandle,string collectionName)
Lua parameters
Same as C-function
Lua return values
Same as C-function

All regular API functions on one page