Regular API function

simSetNameSuffix

Description
Sets the name suffix adjustment number (for detailed information on this, read also the section on accessing general-type objects). In V-REP, all objects are identified by a name and a handle. When an object (scene object or general-type object) is copied at the same time as a child script, the newly created object's name will become "oldName#0", should the same object be pasted another time, the next name will be "oldName#1", etc.

From within a child script, retrieving object handles is performed by automatically appending a name suffix to the object name (each script gets initialized with the name suffix number of the object it is attached to). This allows to copy-paste objects and scripts without having to manually adjust the scripts (the scripts will automatically know which object they have to access based on the set name suffix). From within a script, most of the time you won't need to set the name suffix, but in some special cases you might want to temporarily disable it (e.g. "myChildScript#42" (which has its name suffix automatically set to 42) copied itself together with its attached robot ("myRobot#42") and now from within "myChildScript#42" you want to shift "myRobot#43" to avoid collision. In that case set the name suffix to 43, shift "myRobot" (retrieve its handle with simGetObjectHandle("myRobot") then set the suffix back to 42). From within a script, the simSetNameSuffix command is influencing only current script.

When accessing the API from outside of a script however, the name adjustment mechanism needs to be adjusted manually (make sure you reset the name suffix to its initial state after you are done retrieving handles). Imagine you have one robot in your scene that is named "robot". You can access the robot from a C/C++ application with simGetObjectHandle("robot"). If the robot is duplicated, the second robot's name will be "robot#0", the third will be "robot#1", etc. From within you C/C++ application you can now access all robots with the same code, you just need to adjust the name suffix number. E.g. simSetNameSuffix(42), then simGetObjectHandle("robot") will retrieve the handle of "robot#42". Once you are done accessing objects, reset the name suffix number to -1 (simSetNameSuffix(-1)).

Setting the name suffix to -1 disables the name adjustment mechanism (default when accessing the API from outside of a script)

See also the simGetNameSuffix function.
C synopsis simInt simSetNameSuffix(simInt nameSuffixNumber)
C parameters
nameSuffixNumber: a number starting from -1 (-1 is for no suffix, 0 is for the 0 suffix, etc.)
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 simSetNameSuffix(number nameSuffixNumber)
Lua parameters
Same as C-function
Lua return values
Same as C-function

All regular API functions on one page