Hook Question
#9
(08-08-2013, 05:56 AM)bearbin Wrote: Also - is there any way to get a full list of all the api functions with parameters and return values, and hopefully a description?

Unfortunately, no, Lua only knows the function names. It would be even impossible, because Lua doesn't really care about the number or types of parameters to functions, whatever you throw at the function, Lua just happily calls that function and it's the function's responsibility to check its parameters' types and count.

There's a non-automatic (human-only) way, though. Have a look at Bindings.cpp and ManualBindings.cpp, each has a function at their bottom registering the Lua API functions; find whatever function you want to know about and see how it's implemented. All our functions have the type and count checks in place, so it should be pretty obvious to know the parameter types and count. Heck, perhaps there's even a way to automate this (on Bindings.cpp only, since that is machine-generated) and produce some kind of minidocumentation.

As for the description, you need to see the appropriate .h file. Let's say, for example, that you want to know what cWorld:TryGetHeight() does. So you open up World.h and search for TryGetHeight, you will find line 131 - 132:
/// Retrieves the world height at the specified coords; returns false if chunk not loaded / generated
bool TryGetHeight(int a_BlockX, int a_BlockZ, int & a_Height);  // Exported in ManualBindings.cpp
I'd say that's pretty explanatory as for the purpose, but "Exported in ManualBindings" tells you that the Lua parameters are probably a bit different, so you still need to look at ManualBindings for implementation for details on the params / return values.
Reply
Thanks given by:


Messages In This Thread
Hook Question - by bearbin - 12-29-2012, 04:04 AM
RE: Hook Question - by xoft - 12-29-2012, 06:14 AM
RE: Hook Question - by bearbin - 12-29-2012, 06:53 AM
RE: Hook Question - by NiLSPACE - 08-08-2013, 04:14 AM
RE: Hook Question - by xoft - 08-08-2013, 05:54 AM
RE: Hook Question - by bearbin - 08-08-2013, 05:56 AM
RE: Hook Question - by xoft - 08-08-2013, 06:24 AM
RE: Hook Question - by NiLSPACE - 08-08-2013, 05:57 AM
RE: Hook Question - by bearbin - 08-08-2013, 05:58 AM
RE: Hook Question - by NiLSPACE - 08-08-2013, 08:08 PM
RE: Hook Question - by xoft - 08-08-2013, 08:43 PM
RE: Hook Question - by NiLSPACE - 08-08-2013, 08:44 PM
RE: Hook Question - by NiLSPACE - 08-08-2013, 11:43 PM
RE: Hook Question - by xoft - 08-09-2013, 12:21 AM
RE: Hook Question - by NiLSPACE - 08-09-2013, 08:08 PM
RE: Hook Question - by xoft - 08-10-2013, 04:25 AM
RE: Hook Question - by xoft - 08-11-2013, 08:26 PM
RE: Hook Question - by NiLSPACE - 11-22-2013, 06:29 AM
RE: Hook Question - by xoft - 11-22-2013, 07:18 AM
RE: Hook Question - by FakeTruth - 11-22-2013, 08:14 AM
RE: Hook Question - by xoft - 11-22-2013, 03:51 PM
RE: Hook Question - by FakeTruth - 11-22-2013, 09:47 PM
RE: Hook Question - by NiLSPACE - 11-22-2013, 07:38 AM
RE: Hook Question - by xoft - 11-22-2013, 07:52 AM
RE: Hook Question - by xoft - 11-22-2013, 09:54 PM
RE: Hook Question - by FakeTruth - 11-23-2013, 06:51 AM
RE: Hook Question - by tigerw - 11-23-2013, 06:33 AM
RE: Hook Question - by NiLSPACE - 11-23-2013, 06:44 AM
RE: Hook Question - by tigerw - 11-23-2013, 07:12 AM
RE: Hook Question - by NiLSPACE - 11-23-2013, 07:17 AM
RE: Hook Question - by xoft - 11-23-2013, 07:19 AM
RE: Hook Question - by FakeTruth - 11-23-2013, 07:37 AM
RE: Hook Question - by tonibm19 - 12-31-2013, 05:11 AM
RE: Hook Question - by NiLSPACE - 12-31-2013, 05:20 AM
RE: Hook Question - by tonibm19 - 12-31-2013, 06:53 AM
RE: Hook Question - by xoft - 12-31-2013, 07:04 AM
RE: Hook Question - by NiLSPACE - 12-31-2013, 07:12 AM
RE: Hook Question - by NiLSPACE - 01-02-2014, 12:35 AM
RE: Hook Question - by tonibm19 - 02-03-2014, 03:28 AM
RE: Hook Question - by xoft - 02-03-2014, 05:16 AM
RE: Hook Question - by tonibm19 - 02-03-2014, 05:19 AM
RE: Hook Question - by xoft - 02-03-2014, 07:11 AM
RE: Hook Question - by NiLSPACE - 08-17-2014, 09:12 PM
RE: Hook Question - by ThuGie - 08-17-2014, 10:24 PM
RE: Hook Question - by xoft - 08-18-2014, 06:14 AM
RE: Hook Question - by NiLSPACE - 08-18-2014, 06:20 AM
RE: Hook Question - by xoft - 08-18-2014, 06:30 AM
RE: Hook Question - by NiLSPACE - 08-18-2014, 06:32 AM
RE: Hook Question - by NiLSPACE - 12-04-2014, 04:36 AM
RE: Hook Question - by xoft - 12-04-2014, 06:34 PM



Users browsing this thread: 2 Guest(s)