sim.getApiInfo

Returns the call tip (or info text) for an API function

Synopsis

string info = sim.getApiInfo(int scriptHandle, string apiWord) string info = sim.getApiInfo(int scriptHandle, string apiWord)

Arguments

  • scriptHandle: handle of the script. Can be -1 to be script agnostic
  • apiWord: API functions or variable to retrieve the info for, e.g. "sim.getObject"

Return values

  • info: information related to the API function or variable


See also: