Regular API function


Description Retrieves a string that describes additional environment or object properties, mainly used by extension plugins.
C synopsis simChar* simGetExtensionString(simInt objectHandle,simInt index,const simChar* key)
C parameters
objectHandle: the handle of an object, or -1 if you wish to retrieve the extension string of the environment.
index: keep to -1, unless the object is a shape, and you wish to retrieve the extension string of a shape component (since a shape can be a compound of several other shapes).
key: an optional key indicating what value to retrieve. If none is specified, then the whole extension string will be returned. Keys should have the form of key@parentKey@...@parentKey. To retrieve the shadow enabled value of extension string "povray{ shadow {true} fadeXDist {0.00}}", specify following key: shadow@povray. The key is case sensitive.
C return value
a string if the operation was successful. The user is in charge of releasing the buffer with simReleaseBuffer.
Lua synopsis string theString=simGetExtensionString(number objectHandle,number index,string key=nil)
Lua parameters
Same as C-function
Lua return values
Same as C-function

All regular API functions on one page