doc/script-functions.txt

   1 ENGINE-PROVIDED SCRIPT FUNCTIONS
   2
   3
   4   All scripts have:
   5
   6     standard Lua functions
   7     Sound functions
   8
   9
  10   entity preMove, entity postMove, tile onEnter, and tile onLeave scripts
  11   have:
  12
  13     an Entity object
  14
  15
  16
  17
  18 TSUNAGARI FUNCTIONS
  19
  20   Scripts need to be able to interface with and manipulate the game world.
  21   Tsunagari provides access to several aspects of your world.
  22
  23
  24   the Sound functions are:
  25
  26     Sound:play(filename)
  27
  28
  29   an Entity object is:
  30
  31     entity.x
  32     entity.y
  33     entity:gotoRandomTile()
  34
  35
  36
  37
  38 STANDARD LUA FUNCTIONS
  39
  40   Lua comes with a library of functions that make it useful as a language.
  41   Tsunagari includes most, but not all of these. In particular, there is no
  42   support for coroutines, modules, loading external code, using raw get/set
  43   functions, manipulating the garbage collector, exiting, running external
  44   programs, or manipulating external files.
  45
  46   You can find complete documentation for these functions here:
  47     http://www.lua.org/manual/5.1/manual.html#5
  48
  49
  50   Basic Functions
  51     assert()
  52     error()
  53     getfenv()
  54     getmetatable()
  55     ipairs()
  56     next()
  57     pairs()
  58     pcall()
  59     print()
  60     select()
  61     setfenv()
  62     setmetatable()
  63     tonumber()
  64     tostring()
  65     type()
  66     unpack()
  67     xpcall()
  68
  69   String Manipulation
  70     string:byte()
  71     string:char()
  72     string:dump()
  73     string:find()
  74     string:format()
  75     string:gmatch()
  76     string:gsub()
  77     string:len()
  78     string:lower()
  79     string:match()
  80     string:rep()
  81     string:reverse()
  82     string:sub()
  83     string:upper()
  84
  85   Table Manipulation
  86     table:concat()
  87     table:foreach()
  88     table:foreachi()
  89     table:getn()
  90     table:maxn()
  91     table:insert()
  92     table:remove()
  93     table:sort()
  94
  95   Mathematical Functions
  96     math.abs()
  97     math.acos()
  98     math.asin()
  99     math.atan2()
 100     math.atan()
 101     math.ceil()
 102     math.cosh()
 103     math.cos()
 104     math.deg()
 105     math.exp()
 106     math.floor()
 107     math.fmod()
 108     math.frexp()
 109     math.ldexp()
 110     math.log10()
 111     math.log()
 112     math.max()
 113     math.min()
 114     math.modf()
 115     math.pow()
 116     math.rad()
 117     math.random()
 118     math.randomseed()
 119     math.sinh()
 120     math.sin()
 121     math.sqrt()
 122     math.tanh()
 123     math.tan()
 124
 125   Input and Output Facilities
 126     io.flush()
 127     io.input()
 128     io.output()
 129     io.read()
 130     io.type()
 131     io.write()
 132
 133     file:close()
 134     file:flush()
 135     file:lines()
 136     file:read()
 137     file:seek()
 138     file:setvbuf()
 139     file:write()
 140
 141   Operating System Facilities
 142     os.clock()
 143     os.date()
 144     os.difftime()
 145     os.time()
 146
 147   The Debug Library
 148     debug.debug()
 149     debug.getfenv()
 150     debug.gethook()
 151     debug.getinfo()
 152     debug.getlocal()
 153     debug.getregistry()
 154     debug.getmetatable()
 155     debug.getupvalue()
 156     debug.setfenv()
 157     debug.sethook()
 158     debug.setlocal()
 159     debug.setmetatable()
 160     debug.setupvalue()
 161     debug.traceback()
 162