Update docs

This commit is contained in:
Sardelka
2022-07-02 18:32:49 +08:00
parent e0c96cc200
commit f47f0570f9
10 changed files with 29 additions and 30 deletions

View File

@ -447,8 +447,7 @@
<tr> <tr>
<td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.collections.generic.list-1">List</a>&lt;<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object">Object</a>&gt;</td> <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.collections.generic.list-1">List</a>&lt;<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object">Object</a>&gt;</td>
<td><span class="parametername">args</span></td> <td><span class="parametername">args</span></td>
<td><p>The objects conataing your data, supported types: <td><p>The objects conataing your data, see <a class="xref" href="RageCoop.Client.Scripting.CustomEventReceivedArgs.html">CustomEventReceivedArgs</a> for a list of supported types</p>
byte, short, ushort, int, uint, long, ulong, float, bool, string.</p>
</td> </td>
</tr> </tr>
</tbody> </tbody>

View File

@ -181,7 +181,7 @@
<a id="RageCoop_Client_Scripting_ClientScript_OnStart_" data-uid="RageCoop.Client.Scripting.ClientScript.OnStart*"></a> <a id="RageCoop_Client_Scripting_ClientScript_OnStart_" data-uid="RageCoop.Client.Scripting.ClientScript.OnStart*"></a>
<h4 id="RageCoop_Client_Scripting_ClientScript_OnStart" data-uid="RageCoop.Client.Scripting.ClientScript.OnStart">OnStart()</h4> <h4 id="RageCoop_Client_Scripting_ClientScript_OnStart" data-uid="RageCoop.Client.Scripting.ClientScript.OnStart">OnStart()</h4>
<div class="markdown level1 summary"><p>This method would be called from main thread shortly after all scripts have been loaded.</p> <div class="markdown level1 summary"><p>This method would be called from background thread, call <a class="xref" href="RageCoop.Client.Scripting.API.html#RageCoop_Client_Scripting_API_QueueAction_System_Action_">QueueAction(Action)</a> to dispatch it to main thread.</p>
</div> </div>
<div class="markdown level1 conceptual"></div> <div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5> <h5 class="decalaration">Declaration</h5>
@ -192,7 +192,7 @@
<a id="RageCoop_Client_Scripting_ClientScript_OnStop_" data-uid="RageCoop.Client.Scripting.ClientScript.OnStop*"></a> <a id="RageCoop_Client_Scripting_ClientScript_OnStop_" data-uid="RageCoop.Client.Scripting.ClientScript.OnStop*"></a>
<h4 id="RageCoop_Client_Scripting_ClientScript_OnStop" data-uid="RageCoop.Client.Scripting.ClientScript.OnStop">OnStop()</h4> <h4 id="RageCoop_Client_Scripting_ClientScript_OnStop" data-uid="RageCoop.Client.Scripting.ClientScript.OnStop">OnStop()</h4>
<div class="markdown level1 summary"><p>This method would be called from main thread when the client disconnected from the server, you MUST terminate all background jobs/threads in this method.</p> <div class="markdown level1 summary"><p>This method would be called from background thread when the client disconnected from the server, you MUST terminate all background jobs/threads in this method.</p>
</div> </div>
<div class="markdown level1 conceptual"></div> <div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5> <h5 class="decalaration">Declaration</h5>

View File

@ -130,7 +130,7 @@
<a id="RageCoop_Client_Scripting_CustomEventReceivedArgs_Args_" data-uid="RageCoop.Client.Scripting.CustomEventReceivedArgs.Args*"></a> <a id="RageCoop_Client_Scripting_CustomEventReceivedArgs_Args_" data-uid="RageCoop.Client.Scripting.CustomEventReceivedArgs.Args*"></a>
<h4 id="RageCoop_Client_Scripting_CustomEventReceivedArgs_Args" data-uid="RageCoop.Client.Scripting.CustomEventReceivedArgs.Args">Args</h4> <h4 id="RageCoop_Client_Scripting_CustomEventReceivedArgs_Args" data-uid="RageCoop.Client.Scripting.CustomEventReceivedArgs.Args">Args</h4>
<div class="markdown level1 summary"><p>Arguments</p> <div class="markdown level1 summary"><p>Supported types: byte, short, ushort, int, uint, long, ulong, float, bool, string, Vector3, Quaternion</p>
</div> </div>
<div class="markdown level1 conceptual"></div> <div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5> <h5 class="decalaration">Declaration</h5>

View File

@ -306,7 +306,7 @@
<tr> <tr>
<td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.action-1">Action</a>&lt;<a class="xref" href="RageCoop.Server.Scripting.CommandContext.html">CommandContext</a>&gt;</td> <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.action-1">Action</a>&lt;<a class="xref" href="RageCoop.Server.Scripting.CommandContext.html">CommandContext</a>&gt;</td>
<td><span class="parametername">callback</span></td> <td><span class="parametername">callback</span></td>
<td><p>Create a new function!</p> <td><p>A callback to invoke when the command received.</p>
</td> </td>
</tr> </tr>
</tbody> </tbody>
@ -353,7 +353,7 @@
<tr> <tr>
<td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.action-1">Action</a>&lt;<a class="xref" href="RageCoop.Server.Scripting.CommandContext.html">CommandContext</a>&gt;</td> <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.action-1">Action</a>&lt;<a class="xref" href="RageCoop.Server.Scripting.CommandContext.html">CommandContext</a>&gt;</td>
<td><span class="parametername">callback</span></td> <td><span class="parametername">callback</span></td>
<td><p>Create a new function!</p> <td><p>A callback to invoke when the command received.</p>
</td> </td>
</tr> </tr>
</tbody> </tbody>
@ -444,7 +444,7 @@
<tr> <tr>
<td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.action-1">Action</a>&lt;<a class="xref" href="RageCoop.Server.Scripting.CustomEventReceivedArgs.html">CustomEventReceivedArgs</a>&gt;</td> <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.action-1">Action</a>&lt;<a class="xref" href="RageCoop.Server.Scripting.CustomEventReceivedArgs.html">CustomEventReceivedArgs</a>&gt;</td>
<td><span class="parametername">handler</span></td> <td><span class="parametername">handler</span></td>
<td><p>An handler to be invoked when the event is received from the server. This will be invoked from main thread.</p> <td><p>An handler to be invoked when the event is received from the server.</p>
</td> </td>
</tr> </tr>
</tbody> </tbody>
@ -555,7 +555,7 @@
<tr> <tr>
<td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.collections.generic.list-1">List</a>&lt;<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object">Object</a>&gt;</td> <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.collections.generic.list-1">List</a>&lt;<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object">Object</a>&gt;</td>
<td><span class="parametername">args</span></td> <td><span class="parametername">args</span></td>
<td><p>The objects conataing your data, supported types: byte, short, ushort, int, uint, long, ulong, float, bool, string.</p> <td><p>The objects conataing your data, see <a class="xref" href="RageCoop.Server.Scripting.CustomEventReceivedArgs.html#RageCoop_Server_Scripting_CustomEventReceivedArgs_Args">Args</a> for supported types.</p>
</td> </td>
</tr> </tr>
<tr> <tr>
@ -596,7 +596,7 @@
<tr> <tr>
<td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.collections.generic.list-1">List</a>&lt;<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object">Object</a>&gt;</td> <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.collections.generic.list-1">List</a>&lt;<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object">Object</a>&gt;</td>
<td><span class="parametername">args</span></td> <td><span class="parametername">args</span></td>
<td><p>The objects conataing your data, supported types: byte, short, ushort, int, uint, long, ulong, float, bool, string.</p> <td><p>See <a class="xref" href="RageCoop.Server.Scripting.CustomEventReceivedArgs.html">CustomEventReceivedArgs</a> for a list of supported types.</p>
</td> </td>
</tr> </tr>
<tr> <tr>

View File

@ -130,7 +130,7 @@
<a id="RageCoop_Server_Scripting_CustomEventReceivedArgs_Args_" data-uid="RageCoop.Server.Scripting.CustomEventReceivedArgs.Args*"></a> <a id="RageCoop_Server_Scripting_CustomEventReceivedArgs_Args_" data-uid="RageCoop.Server.Scripting.CustomEventReceivedArgs.Args*"></a>
<h4 id="RageCoop_Server_Scripting_CustomEventReceivedArgs_Args" data-uid="RageCoop.Server.Scripting.CustomEventReceivedArgs.Args">Args</h4> <h4 id="RageCoop_Server_Scripting_CustomEventReceivedArgs_Args" data-uid="RageCoop.Server.Scripting.CustomEventReceivedArgs.Args">Args</h4>
<div class="markdown level1 summary"><p>The arguments of this event</p> <div class="markdown level1 summary"><p>Supported types: byte, short, ushort, int, uint, long, ulong, float, bool, string, Vector3, Quaternion, ServerPed, ServerVehicle, ServerProp</p>
</div> </div>
<div class="markdown level1 conceptual"></div> <div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5> <h5 class="decalaration">Declaration</h5>

View File

@ -127,7 +127,7 @@
<a id="RageCoop_Server_ServerPed_Handle_" data-uid="RageCoop.Server.ServerPed.Handle*"></a> <a id="RageCoop_Server_ServerPed_Handle_" data-uid="RageCoop.Server.ServerPed.Handle*"></a>
<h4 id="RageCoop_Server_ServerPed_Handle" data-uid="RageCoop.Server.ServerPed.Handle">Handle</h4> <h4 id="RageCoop_Server_ServerPed_Handle" data-uid="RageCoop.Server.ServerPed.Handle">Handle</h4>
<div class="markdown level1 summary"><p>Pass the value as an argument in <a class="xref" href="RageCoop.Server.Scripting.API.html#RageCoop_Server_Scripting_API_SendCustomEvent_System_Int32_System_Collections_Generic_List_System_Object__System_Collections_Generic_List_RageCoop_Server_Client__">SendCustomEvent(Int32, List&lt;Object&gt;, List&lt;Client&gt;)</a> or <a class="xref" href="RageCoop.Server.Client.html#RageCoop_Server_Client_SendCustomEvent_System_Int32_System_Object___">SendCustomEvent(Int32, Object[])</a> to convert this object to handle at client side.</p> <div class="markdown level1 summary"><p>Pass this as an argument in CustomEvent or NativeCall to convert this object to handle at client side.</p>
</div> </div>
<div class="markdown level1 conceptual"></div> <div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5> <h5 class="decalaration">Declaration</h5>

View File

@ -127,7 +127,7 @@
<a id="RageCoop_Server_ServerProp_Handle_" data-uid="RageCoop.Server.ServerProp.Handle*"></a> <a id="RageCoop_Server_ServerProp_Handle_" data-uid="RageCoop.Server.ServerProp.Handle*"></a>
<h4 id="RageCoop_Server_ServerProp_Handle" data-uid="RageCoop.Server.ServerProp.Handle">Handle</h4> <h4 id="RageCoop_Server_ServerProp_Handle" data-uid="RageCoop.Server.ServerProp.Handle">Handle</h4>
<div class="markdown level1 summary"><p>Pass the value as an argument in <a class="xref" href="RageCoop.Server.Scripting.API.html#RageCoop_Server_Scripting_API_SendCustomEvent_System_Int32_System_Collections_Generic_List_System_Object__System_Collections_Generic_List_RageCoop_Server_Client__">SendCustomEvent(Int32, List&lt;Object&gt;, List&lt;Client&gt;)</a> or <a class="xref" href="RageCoop.Server.Client.html#RageCoop_Server_Client_SendCustomEvent_System_Int32_System_Object___">SendCustomEvent(Int32, Object[])</a> to convert this object to handle at client side.</p> <div class="markdown level1 summary"><p>Pass this as an argument in CustomEvent or NativeCall to convert this object to handle at client side.</p>
</div> </div>
<div class="markdown level1 conceptual"></div> <div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5> <h5 class="decalaration">Declaration</h5>

View File

@ -127,7 +127,7 @@
<a id="RageCoop_Server_ServerVehicle_Handle_" data-uid="RageCoop.Server.ServerVehicle.Handle*"></a> <a id="RageCoop_Server_ServerVehicle_Handle_" data-uid="RageCoop.Server.ServerVehicle.Handle*"></a>
<h4 id="RageCoop_Server_ServerVehicle_Handle" data-uid="RageCoop.Server.ServerVehicle.Handle">Handle</h4> <h4 id="RageCoop_Server_ServerVehicle_Handle" data-uid="RageCoop.Server.ServerVehicle.Handle">Handle</h4>
<div class="markdown level1 summary"><p>Pass the value as an argument in <a class="xref" href="RageCoop.Server.Scripting.API.html#RageCoop_Server_Scripting_API_SendCustomEvent_System_Int32_System_Collections_Generic_List_System_Object__System_Collections_Generic_List_RageCoop_Server_Client__">SendCustomEvent(Int32, List&lt;Object&gt;, List&lt;Client&gt;)</a> or <a class="xref" href="RageCoop.Server.Client.html#RageCoop_Server_Client_SendCustomEvent_System_Int32_System_Object___">SendCustomEvent(Int32, Object[])</a> to convert this object to handle at client side.</p> <div class="markdown level1 summary"><p>Pass this as an argument in CustomEvent or NativeCall to convert this object to handle at client side.</p>
</div> </div>
<div class="markdown level1 conceptual"></div> <div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5> <h5 class="decalaration">Declaration</h5>

File diff suppressed because one or more lines are too long

View File

@ -117,7 +117,7 @@
"output": { "output": {
".html": { ".html": {
"relative_path": "api/RageCoop.Client.Scripting.API.html", "relative_path": "api/RageCoop.Client.Scripting.API.html",
"hash": "Ia+Sh3EBdepmbfJ+BGpzSBf6eKuA/n+d3gtuuWbWeFA=" "hash": "qXU3gGLs3KnRlOWHnO08E985GHx+ixSrrbB7NGAyBfM="
} }
}, },
"is_incremental": false, "is_incremental": false,
@ -141,7 +141,7 @@
"output": { "output": {
".html": { ".html": {
"relative_path": "api/RageCoop.Client.Scripting.ClientScript.html", "relative_path": "api/RageCoop.Client.Scripting.ClientScript.html",
"hash": "N73yvdl0ubXKOzOi/yGMNG8u9t/xqzSSN4Jpkk81agE=" "hash": "V8Yh0W8zbx3z/YXULlTmYhfrDWZvlxPkwLOCikAP7pc="
} }
}, },
"is_incremental": false, "is_incremental": false,
@ -153,7 +153,7 @@
"output": { "output": {
".html": { ".html": {
"relative_path": "api/RageCoop.Client.Scripting.CustomEventReceivedArgs.html", "relative_path": "api/RageCoop.Client.Scripting.CustomEventReceivedArgs.html",
"hash": "gPKV+5Ur/yanNA6H9nMpkM4POo4/XU1gjrJCY77p6dA=" "hash": "/oQtDZe9+7w9CKt/AnXoqrDu/1D6OVDLGkNXJLDr+u8="
} }
}, },
"is_incremental": false, "is_incremental": false,
@ -357,7 +357,7 @@
"output": { "output": {
".html": { ".html": {
"relative_path": "api/RageCoop.Server.Scripting.API.html", "relative_path": "api/RageCoop.Server.Scripting.API.html",
"hash": "VDClnRrNQDeUyHDlLMKHr1LRqviN0OCHiKxmJuc8fkc=" "hash": "8ybDlQGQCl50xj9srw155Cyj35PK9UuX0RpEQlTFkbQ="
} }
}, },
"is_incremental": false, "is_incremental": false,
@ -405,7 +405,7 @@
"output": { "output": {
".html": { ".html": {
"relative_path": "api/RageCoop.Server.Scripting.CustomEventReceivedArgs.html", "relative_path": "api/RageCoop.Server.Scripting.CustomEventReceivedArgs.html",
"hash": "QL/7GcZ2eBogliH8UHmn3X9BytvNlqUqAwd0qylIUCI=" "hash": "NdiRA5BPjg6z2Ry5ZEBnOg9mKqXVd1imw27AV1CdHs8="
} }
}, },
"is_incremental": false, "is_incremental": false,
@ -513,7 +513,7 @@
"output": { "output": {
".html": { ".html": {
"relative_path": "api/RageCoop.Server.ServerPed.html", "relative_path": "api/RageCoop.Server.ServerPed.html",
"hash": "PQCf8t9TCPc1tEWai7OQxm98cwLHNa9Zl654KG0Gu4c=" "hash": "QpNMMs/mGAlwPIh8YdZxF4UDgqO2Ob9gPdlc/7mNNII="
} }
}, },
"is_incremental": false, "is_incremental": false,
@ -525,7 +525,7 @@
"output": { "output": {
".html": { ".html": {
"relative_path": "api/RageCoop.Server.ServerProp.html", "relative_path": "api/RageCoop.Server.ServerProp.html",
"hash": "0UJO4Oyjocb1AmzGFELQ9EjrW+F1iPH5o5xFlX7cJpU=" "hash": "NH1CyF2tlK2ab69oAYGph5TlzRIWB1f7jLZJn4/juU4="
} }
}, },
"is_incremental": false, "is_incremental": false,
@ -549,7 +549,7 @@
"output": { "output": {
".html": { ".html": {
"relative_path": "api/RageCoop.Server.ServerVehicle.html", "relative_path": "api/RageCoop.Server.ServerVehicle.html",
"hash": "bySWfd4MWrMOM5QEncfd3fCCOieNPpIbLoXiGsKWtp8=" "hash": "097s7xTmGbr3wTX4kq9xmE0cMtZbzwkYZbnHv7iUV2o="
} }
}, },
"is_incremental": false, "is_incremental": false,