GetObjApiDescriptor()

grandMA3 ユーザマニュアル » プラグイン » Lua 関数 - Object-Free API » GetObjApiDescriptor()

Version 2.2

説明

The GetObjApiDescriptor Lua function returns a table with a description of all the object Lua functions. These are descriptions only. The function does not have any actual functions. The table is not sorted.

引数

この関数は、引数を受け取りません。

戻り値

table:
The returned table contains elements with three values.
- string:
  This is the API function name.
- string:
  This is the description of the API arguments.
- string:
  This is the description of the API returns.

例

This example prints the content of the returned table.

Copy Code

Lua

return function ()
  -- This returns information about all the Lua "object" functions.
  -- GetObjApiDescriptor() returns a table with all the functions. 
  -- Each table element is another table with the name, argument description, and return description.
    for key,value in ipairs(GetObjApiDescriptor()) do
      if value[1] ~= nil then
        Printf("Api " .. key .. " is: " .. value[1])
      end
      if value[2] ~= nil then
        Printf("Arguments: " .. value[2])
      end
      if value[3] ~= nil then
        Printf("Returns: " .. value[3])
      end
      Printf("---------------------------------------")
      end
end