Skip to content

Commit

Permalink
Fix various typos in documentation (#189)
Browse files Browse the repository at this point in the history
  • Loading branch information
sepTN authored Jan 2, 2024
1 parent 4ec644e commit 525d1e0
Show file tree
Hide file tree
Showing 5 changed files with 7 additions and 7 deletions.
4 changes: 2 additions & 2 deletions doc_classes/LuaAPI.xml
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@
<param index="0" name="FilePath" type="String" />
<description>
Loads a file with luaL_loadfile() passing its absolute path.
Similar to [code].DoString()[/code], this function loads a lua file into the LuaAPI Object and executes it as Lua. [code]FilePath[/code] must be an absolute path, and must exist or an error is reutrned.
Similar to [code].DoString()[/code], this function loads a lua file into the LuaAPI Object and executes it as Lua. [code]FilePath[/code] must be an absolute path, and must exist or an error is returned.
</description>
</method>
<method name="do_string">
Expand Down Expand Up @@ -125,7 +125,7 @@
</member>
<member name="use_callables" type="bool" setter="set_use_callables" getter="get_use_callables" default="true">
When true, Lua functions passed to Godot will use the LuaCallable type. This type is a CallableCustom which has issues currently with GDExtension and C#
When false, Lua functions passed to Godot will use the LuaFunctionRef type. This type is a RefCounted which behaves the same as a LuaCallable. But uses Inoke instead of Call.
When false, Lua functions passed to Godot will use the LuaFunctionRef type. This type is a RefCounted which behaves the same as a LuaCallable. But uses Invoke instead of Call.
</members>
<constants>
<constant name="GC_STOP" value="1" enum="HookMask">
Expand Down
2 changes: 1 addition & 1 deletion doc_classes/LuaCallableExtra.xml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
A tuple.
</brief_description>
<description>
This is a simple wrapper class to let LuaAPI know you want a little extra info. It is used to request references to the LuaAPI object as an argument and specifie your last argument is a tuple.
This is a simple wrapper class to let LuaAPI know you want a little extra info. It is used to request references to the LuaAPI object as an argument and specify your last argument is a tuple.
</description>
<tutorials>
</tutorials>
Expand Down
2 changes: 1 addition & 1 deletion doc_classes/LuaDefaultObjectMetatable.xml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
The default LuaObjectMetatable used by the LuaAPI class as the object_metatable value.
</brief_description>
<description>
This metatable by default checks if the object has a lua_fields method. If it does depending on how permissice is set. The listed fields will be allowed or disallowed.
This metatable by default checks if the object has a lua_fields method. If it does depending on how permissive is set. The listed fields will be allowed or disallowed.
This metatable also checks if the object overrides any of the metamethods, if it does it will call the overridden method.
</description>
<tutorials>
Expand Down
4 changes: 2 additions & 2 deletions doc_classes/LuaError.xml
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,13 @@
<param index="0" name="Message" type="String" />
<param index="1" name="Type" type="int" enum="LuaError.ErrorType" default="2" />
<description>
This is a static method that exists so you dont have to call LuaError.new() and err.set_info(msg, type) every time. It creates a new error and calls set_info passing msd and type.
This is a static method that exists so you don't have to call LuaError.new() and err.set_info(msg, type) every time. It creates a new error and calls set_info passing msd and type.
</description>
</method>
</methods>
<members>
<member name="message" type="String" setter="set_message" getter="get_message" default="&quot;&quot;">
The error message. Will also contain the stack trace if apllicable.
The error message. Will also contain the stack trace if applicable.
</member>
<member name="type" type="int" setter="set_type" getter="get_type" enum="LuaError.ErrorType" default="0">
The error type.
Expand Down
2 changes: 1 addition & 1 deletion doc_classes/LuaFunctionRef.xml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
<tutorials>
</tutorials>
<methods>
<method name="inoke">
<method name="invoke">
<return type="Variant" />
<param index="0" name="Arguments" type="Array" />
<description>
Expand Down

0 comments on commit 525d1e0

Please sign in to comment.