Skip to content
This repository was archived by the owner on Dec 29, 2024. It is now read-only.

Commit 525d1e0

Browse files
authored
Fix various typos in documentation (#189)
1 parent 4ec644e commit 525d1e0

File tree

5 files changed

+7
-7
lines changed

5 files changed

+7
-7
lines changed

doc_classes/LuaAPI.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@
3535
<param index="0" name="FilePath" type="String" />
3636
<description>
3737
Loads a file with luaL_loadfile() passing its absolute path.
38-
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.
38+
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.
3939
</description>
4040
</method>
4141
<method name="do_string">
@@ -125,7 +125,7 @@
125125
</member>
126126
<member name="use_callables" type="bool" setter="set_use_callables" getter="get_use_callables" default="true">
127127
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#
128-
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.
128+
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.
129129
</members>
130130
<constants>
131131
<constant name="GC_STOP" value="1" enum="HookMask">

doc_classes/LuaCallableExtra.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
A tuple.
55
</brief_description>
66
<description>
7-
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.
7+
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.
88
</description>
99
<tutorials>
1010
</tutorials>

doc_classes/LuaDefaultObjectMetatable.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
The default LuaObjectMetatable used by the LuaAPI class as the object_metatable value.
55
</brief_description>
66
<description>
7-
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.
7+
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.
88
This metatable also checks if the object overrides any of the metamethods, if it does it will call the overridden method.
99
</description>
1010
<tutorials>

doc_classes/LuaError.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,13 +14,13 @@
1414
<param index="0" name="Message" type="String" />
1515
<param index="1" name="Type" type="int" enum="LuaError.ErrorType" default="2" />
1616
<description>
17-
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.
17+
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.
1818
</description>
1919
</method>
2020
</methods>
2121
<members>
2222
<member name="message" type="String" setter="set_message" getter="get_message" default="&quot;&quot;">
23-
The error message. Will also contain the stack trace if apllicable.
23+
The error message. Will also contain the stack trace if applicable.
2424
</member>
2525
<member name="type" type="int" setter="set_type" getter="get_type" enum="LuaError.ErrorType" default="0">
2626
The error type.

doc_classes/LuaFunctionRef.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
<tutorials>
1010
</tutorials>
1111
<methods>
12-
<method name="inoke">
12+
<method name="invoke">
1313
<return type="Variant" />
1414
<param index="0" name="Arguments" type="Array" />
1515
<description>

0 commit comments

Comments
 (0)