rework hooks, proper arg conversion for luacall from ts, fix+rename bl.addServerCmd/addClientCmd, remove 'bool' from ts.type (only use 'boolean'), more dedefault typedefs, support typedefs on named objects, typedef inheritance, reorganize libts

readme.md

@@ -40,24 +40,36 @@ Lua scripting for Blockland
 ### Advanced
 `sched = bl.schedule(timeMs, function, args...)` - Schedule a Lua function to be called later, similar to schedule in Torque  
 `sched:cancel()` - Cancel a previously scheduled timer  
+
+### Raycasts and Searches
 `hitObject, hitPos, hitNormal = bl.raycast(vector{startPosX,y,z}, vector{endPosX,y,z}, 'objtype'/{'objtypes',...}, ignoreObjects...?)` - Cast a ray in the world over objects of the specified type(s) (possibly excluding some objects), and return the object hit, the position of the hit, and the normal vector to the surface hit. See the Types section for a list of valid object types.
 `for object in bl.boxSearch(vector{centerX,y,z}, vector{sizeX,y,z}, 'objtype'/{'objtypes',...}) do` - Find all objects in the world of the specified type(s) whose bounding box overlaps with the specified box. See the Types section for a list of valid object types.  
 `for object in bl.radiusSearch(vector{centerX,y,z}, radius, 'objtype'/{'objtypes',...}) do` - Find all objects of the specified type(s) whose bounding box overlaps with the specified sphere. See the Types section for a list of valid object types.  
-`bl.serverCmd('commandName', function(client, args...) code() end)` - Register a /-command on the server  
-`bl.clientCmd('commandName', function(args...) code() end)` - Register a client command on the client  
+
+### Server-Client Communication
+`bl.addServerCmd('commandName', function(client, args...) code() end)` - Register a /-command on the server  
+`bl.addClientCmd('commandName', function(args...) code() end)` - Register a client command on the client  
+`bl.commandToServer('commandName', args...)` - Execute a server command as a client  
+`bl.commandToClient('commandName', args...)` - As the server, execute a client command on a specific client
+`bl.commandToAll('commandName', args...)` - As the server, execute a client command on all clients  
 
 ### Packages/Hooks
-`bl.hook('packageName', 'functionName', 'before'/'after'/'override', function(args...) code() end)` - Hook a Torque function with a Lua function  
-`bl.unhook('packageName', 'functionName', 'before'/'after'/'override')` - Remove a previously defined hook  
+`bl.hook('packageName', 'functionName', 'before'/'after', function(args) code() end)` - Hook a Torque function with a Lua function.  
+`args` is an array containing the arguments provided to the function. If the hook is `before`, these can be modified before being passed to the parent function.  
+If `args._return` is set to anything other than nil by a `before` hook, the parent function will not be called, and the function will simply return that value. Also in this case, any `after` hook will not be executed.  
+In an `after` hook, `args._return` is set to the value returned by the parent function, and can be modified.  
+`bl.unhook('packageName', 'functionName', 'before'/'after')` - Remove a previously defined hook  
+`bl.unhook('packageName', 'functionName')` - Remove any previously defined hooks on the function within the package 
+`bl.unhook('packageName')` - Remove any previously defined hooks within the package  
 
 ### Classes and Types
-`bl.bool(thing)` - Convert a Torque boolean (0 or 1) into a Lua boolean. Done automatically for all built-in functions that return bools.  
-`bl.object(thing)` - Convert a Torque object reference (object ID or name) into a Lua object. Done automatically for all built-in functions that return objects.  
-`bl.type('varName', 'type')` - Register the type of a Torque global variable, for conversion when accessing from Lua. Valid types are 'bool', 'object', and nil - all other conversion is automatic.  
-`bl.type('funcName', 'type')` - Register the return type of a Torque function, for conversion when calling from Lua. Valid types are 'bool', 'object', and nil - all other conversion is automatic. Already done for all built-in functions that return objects.  
+`bl.type('varName', 'type')` - Register the type of a Torque global variable, for conversion when accessing from Lua. Valid types are 'boolean', 'object', and nil (default is nil, which applies automatic conversion).  
+`bl.type('funcName', 'type')` - Register the return type of a Torque function, for conversion when calling from Lua. Valid types are 'bool', 'object', and nil - all other conversion is automatic. Already done for all default functions.  
 `bl.type('className::funcName', 'type')` - Register the return type of a Torque object method.  
 `bl.class('className')` - Register a Torque class to be used from Lua (Already done for all built-in classes)  
 `bl.class('className', 'parentClassName')` - Same as above, with inheritance  
+`bl.bool(thing)` - Manually convert a Torque boolean (0 or 1) into a Lua boolean.
+`bl.object(thing)` - Manually convert a Torque object reference (object ID or name) into a Lua object.
 
 ### File I/O
 Lua's builtin file I/O is emulated, and is confined to the same directories as TorqueScript file I/O.  
@@ -95,7 +107,7 @@ Like in standard Lua, modules loaded using `require` are only executed the first
 When a TorqueScript function is called from Lua or vice-versa, the arguments and return value must be converted between the two languages' type systems.  
 TorqueScript stores no type information; all values in TorqueScript are strings. So it's necessary to make some inferences when converting values between the two languages.  
 ### From TorqueScript to Lua
-- Any numeric value becomes a Lua `number`, except as specified with `ts.type`, which may convert a value into a `boolean` or a Torque object container.  
+- Any numeric value becomes a Lua `number`, except as specified with `bl.type`, which may convert a value into a `boolean` or a Torque object container.  
 - The empty string "" becomes `nil`  
 - A string containing three numbers separated by spaces becomes a `vector`  
 - A string containing six numbers separated by spaces becomes a table of two vectors