expvintl/RAGECOOP-V
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

update docs

Browse Source
This commit is contained in:
Sardelka 2022-07-02 11:23:12 +08:00
parent eb5b23ae17
commit 8ee188cf19
32 changed files with 1964 additions and 340 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
RageCoop.Client/Scripting/API.cs
View File

@ -148,9 +148,12 @@ namespace RageCoop.Client.Scripting
/// Get a <see cref="Core.Logger"/> that RAGECOOP is currently using.
/// </summary>
/// <returns></returns>
public static Logger GetLogger()
public static Logger Logger
{
return Main.Logger;
get
{
return Main.Logger;
}
}
/// <summary>
/// Queue an action to be executed on next tick.

5
RageCoop.Client/Scripting/ClientScript.cs
View File

@ -22,5 +22,10 @@ namespace RageCoop.Client.Scripting
/// </summary>
public ResourceFile CurrentFile { get; internal set; }
/// <summary>
/// Get the <see cref="ClientResource"/> that this script belongs to.
/// </summary>
public ClientResource CurrentResource { get; internal set; }
}
}

41
RageCoop.Client/Scripting/Resources.cs
View File

@ -202,6 +202,7 @@ namespace RageCoop.Client.Scripting
var script = constructor.Invoke(null) as ClientScript;
// script.CurrentResource = toload;
script.CurrentFile=rfile;
script.CurrentResource=toload;
toload.Scripts.Add(script);
count++;
}
@ -287,46 +288,6 @@ namespace RageCoop.Client.Scripting
return true;
return false;
}
/*
/// <summary>
/// Load a resource from a directory.
/// </summary>
/// <param name="path">Path of the directory.</param>
private void LoadResource(string path, string dataFolderRoot)
{
var r = new ClientResource()
{
Scripts = new List<ClientScript>(),
Name=Path.GetFileName(path),
DataFolder=Path.Combine(dataFolderRoot, Path.GetFileName(path))
};
Directory.CreateDirectory(r.DataFolder);
foreach (var dir in Directory.GetDirectories(path, "*", SearchOption.AllDirectories))
{
r.Files.Add(dir, new ResourceFile()
{
IsDirectory=true,
Name=dir.Substring(path.Length+1)
});
}
foreach (var file in Directory.GetFiles(path, "*", SearchOption.AllDirectories))
{
var relativeName = file.Substring(path.Length+1);
var rfile = new ResourceFile()
{
GetStream=() => { return new FileStream(file, FileMode.Open, FileAccess.Read); },
IsDirectory=false,
Name=relativeName
};
if (file.EndsWith(".dll"))
{
LoadScriptsFromAssembly(rfile, file, r);
}
r.Files.Add(relativeName, rfile);
}
LoadedResources.Add(r);
}
*/
}
}

2
RageCoop.Server/Client.cs
View File

@ -66,7 +66,7 @@ namespace RageCoop.Server
/// </summary>
public ServerPed Player { get; internal set; }
/// <summary>
/// The client's latncy in seconds.
/// The client's latency in seconds.
/// </summary>
public float Latency { get; internal set; }
private PlayerConfig _config { get; set; }=new PlayerConfig();

9
RageCoop.Server/Scripting/API.cs
View File

@ -14,10 +14,10 @@ namespace RageCoop.Server.Scripting
/// <summary>
///
/// </summary>
public class APIEvents
public class ServerEvents
{
private readonly Server Server;
internal APIEvents(Server server)
internal ServerEvents(Server server)
{
Server = server;
}
@ -143,12 +143,13 @@ namespace RageCoop.Server.Scripting
/// <summary>
/// Server side events
/// </summary>
public readonly APIEvents Events;
public readonly ServerEvents Events;
/// <summary>
/// All synchronized entities on this server.
/// </summary>
public ServerEntities Entities { get { return Server.Entities; } }
#region FUNCTIONS
/// <summary>
/// Get a list of all Clients
@ -310,7 +311,7 @@ namespace RageCoop.Server.Scripting
RegisterCustomEventHandler(CustomEvents.Hash(name), handler);
}
/// <summary>
/// Get a <see cref="Logger"/> that the server is currently using, you should use <see cref="ServerResource.Logger"/> to display resource-specific information.
/// Get a <see cref="Core.Logger"/> that the server is currently using, you should use <see cref="ServerResource.Logger"/> to display resource-specific information.
/// </summary>
public Logger Logger { get { return Server.Logger; } }
#endregion

4
RageCoop.Server/Scripting/ServerScript.cs
View File

@ -19,12 +19,12 @@ namespace RageCoop.Server.Scripting
public abstract void OnStop();
/// <summary>
/// Get the <see cref="API"/> instance that can be used to control the server.
/// Get the <see cref="Scripting.API"/> instance that can be used to control the server.
/// </summary>
public API API { get; set; }
/// <summary>
/// Get the <see cref="ServerResource"/> object this script belongs to, this property will be initiated before <see cref="OnStart"/> (will be null if you access it in the constructor).
/// Get the <see cref="ServerResource"/> this script belongs to, this property won't be initiated before <see cref="OnStart"/>.
/// </summary>
public ServerResource CurrentResource { get; internal set; }
/// <summary>

7
build.cmd Normal file
View File

@ -0,0 +1,7 @@
rmdir /s /q obj
docfx
dotnet build RageCoop.Client/RageCoop.Client.csproj --no-restore --configuration Release -o RageCoop.Client/bin/RageCoop
dotnet publish RageCoop.Server/RageCoop.Server.csproj --self-contained -p:PublishSingleFile=true -p:PublishTrimmed=true -r win-x64 -o RageCoop.Server/bin/win-x64 -c Release
dotnet publish RageCoop.Server/RageCoop.Server.csproj --self-contained -p:PublishSingleFile=true -p:PublishTrimmed=true -r linux-x64 -o RageCoop.Server/bin/linux-x64 -c Release
dotnet publish RageCoop.Server/RageCoop.Server.csproj --self-contained -p:PublishSingleFile=true -p:PublishTrimmed=true -r linux-arm -o RageCoop.Server/bin/linux-arm -c Release
rmdir /s /q obj

1
docfx.json
View File

@ -21,7 +21,6 @@
"files": [ "*.md", "toc.yml" ]
}
],
"overwrite": "specs/*.md",
"globalMetadata": {
"_appTitle": "RageCoop resource documentation",
"_enableSearch": true

18
docs/api/RageCoop.Client.CoopMap.html → docs/api/RageCoop.Client.Map.html
View File

@ -5,10 +5,10 @@
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Class CoopMap
<title>Class Map
| RageCoop resource documentation </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class CoopMap
<meta name="title" content="Class Map
| RageCoop resource documentation ">
<meta name="generator" content="docfx 2.59.2.0">
@ -78,17 +78,17 @@
</div>
<div class="article row grid-right">
<div class="col-md-10">
<article class="content wrap" id="_content" data-uid="RageCoop.Client.CoopMap">
<article class="content wrap" id="_content" data-uid="RageCoop.Client.Map">
<h1 id="RageCoop_Client_CoopMap" data-uid="RageCoop.Client.CoopMap" class="text-break">Class CoopMap
<h1 id="RageCoop_Client_Map" data-uid="RageCoop.Client.Map" class="text-break">Class Map
</h1>
<div class="markdown level0 summary"></div>
<div class="markdown level0 conceptual"></div>
<div class="inheritance">
<h5>Inheritance</h5>
<div class="level0"><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object">Object</a></div>
<div class="level1"><span class="xref">CoopMap</span></div>
<div class="level1"><span class="xref">Map</span></div>
</div>
<div class="inheritedMembers">
<h5>Inherited Members</h5>
@ -116,16 +116,16 @@
</div>
<h6><strong>Namespace</strong>: <a class="xref" href="RageCoop.Client.html">RageCoop.Client</a></h6>
<h6><strong>Assembly</strong>: RageCoop.Client.dll</h6>
<h5 id="RageCoop_Client_CoopMap_syntax">Syntax</h5>
<h5 id="RageCoop_Client_Map_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class CoopMap</code></pre>
<pre><code class="lang-csharp hljs">public class Map</code></pre>
</div>
<h3 id="properties">Properties
</h3>
<a id="RageCoop_Client_CoopMap_Props_" data-uid="RageCoop.Client.CoopMap.Props*"></a>
<h4 id="RageCoop_Client_CoopMap_Props" data-uid="RageCoop.Client.CoopMap.Props">Props</h4>
<a id="RageCoop_Client_Map_Props_" data-uid="RageCoop.Client.Map.Props*"></a>
<h4 id="RageCoop_Client_Map_Props" data-uid="RageCoop.Client.Map.Props">Props</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>

69
docs/api/RageCoop.Client.Scripting.API.html
View File

@ -280,31 +280,18 @@
</tr>
</tbody>
</table>
<h3 id="methods">Methods
</h3>
<a id="RageCoop_Client_Scripting_API_Disconnect_" data-uid="RageCoop.Client.Scripting.API.Disconnect*"></a>
<h4 id="RageCoop_Client_Scripting_API_Disconnect" data-uid="RageCoop.Client.Scripting.API.Disconnect">Disconnect()</h4>
<div class="markdown level1 summary"><p>Disconnect from the server</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static void Disconnect()</code></pre>
</div>
<a id="RageCoop_Client_Scripting_API_GetLogger_" data-uid="RageCoop.Client.Scripting.API.GetLogger*"></a>
<h4 id="RageCoop_Client_Scripting_API_GetLogger" data-uid="RageCoop.Client.Scripting.API.GetLogger">GetLogger()</h4>
<a id="RageCoop_Client_Scripting_API_Logger_" data-uid="RageCoop.Client.Scripting.API.Logger*"></a>
<h4 id="RageCoop_Client_Scripting_API_Logger" data-uid="RageCoop.Client.Scripting.API.Logger">Logger</h4>
<div class="markdown level1 summary"><p>Get a <a class="xref" href="RageCoop.Core.Logger.html">Logger</a> that RAGECOOP is currently using.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static Logger GetLogger()</code></pre>
<pre><code class="lang-csharp hljs">public static Logger Logger { get; }</code></pre>
</div>
<h5 class="returns">Returns</h5>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
@ -319,6 +306,19 @@
</tr>
</tbody>
</table>
<h3 id="methods">Methods
</h3>
<a id="RageCoop_Client_Scripting_API_Disconnect_" data-uid="RageCoop.Client.Scripting.API.Disconnect*"></a>
<h4 id="RageCoop_Client_Scripting_API_Disconnect" data-uid="RageCoop.Client.Scripting.API.Disconnect">Disconnect()</h4>
<div class="markdown level1 summary"><p>Disconnect from the server</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static void Disconnect()</code></pre>
</div>
<a id="RageCoop_Client_Scripting_API_LocalChatMessage_" data-uid="RageCoop.Client.Scripting.API.LocalChatMessage*"></a>
@ -421,7 +421,7 @@
<a id="RageCoop_Client_Scripting_API_SendCustomEvent_" data-uid="RageCoop.Client.Scripting.API.SendCustomEvent*"></a>
<h4 id="RageCoop_Client_Scripting_API_SendCustomEvent_System_Int32_System_Collections_Generic_List_System_Object__" data-uid="RageCoop.Client.Scripting.API.SendCustomEvent(System.Int32,System.Collections.Generic.List{System.Object})">SendCustomEvent(Int32, List&lt;Object&gt;)</h4>
<div class="markdown level1 summary"><p>Send an event and data to the specified clients.</p>
<div class="markdown level1 summary"><p>Send an event and data to the server.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
@ -453,6 +453,39 @@ byte, short, ushort, int, uint, long, ulong, float, bool, string.</p>
</tr>
</tbody>
</table>
<a id="RageCoop_Client_Scripting_API_SendCustomEvent_" data-uid="RageCoop.Client.Scripting.API.SendCustomEvent*"></a>
<h4 id="RageCoop_Client_Scripting_API_SendCustomEvent_System_Int32_System_Object___" data-uid="RageCoop.Client.Scripting.API.SendCustomEvent(System.Int32,System.Object[])">SendCustomEvent(Int32, Object[])</h4>
<div class="markdown level1 summary"><p>Send an event and data to the server.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static void SendCustomEvent(int eventHash, params object[] args)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.int32">Int32</a></td>
<td><span class="parametername">eventHash</span></td>
<td></td>
</tr>
<tr>
<td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object">Object</a>[]</td>
<td><span class="parametername">args</span></td>
<td></td>
</tr>
</tbody>
</table>
</article>
</div>

26
docs/api/RageCoop.Client.Scripting.ClientScript.html
View File

@ -149,6 +149,32 @@
</tr>
</tbody>
</table>
<a id="RageCoop_Client_Scripting_ClientScript_CurrentResource_" data-uid="RageCoop.Client.Scripting.ClientScript.CurrentResource*"></a>
<h4 id="RageCoop_Client_Scripting_ClientScript_CurrentResource" data-uid="RageCoop.Client.Scripting.ClientScript.CurrentResource">CurrentResource</h4>
<div class="markdown level1 summary"><p>Get the <a class="xref" href="RageCoop.Client.Scripting.ClientResource.html">ClientResource</a> that this script belongs to.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public ClientResource CurrentResource { get; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="RageCoop.Client.Scripting.ClientResource.html">ClientResource</a></td>
<td></td>
</tr>
</tbody>
</table>
<h3 id="methods">Methods
</h3>

26
docs/api/RageCoop.Client.Settings.html
View File

@ -361,6 +361,32 @@
</table>
<a id="RageCoop_Client_Settings_ResourceDirectory_" data-uid="RageCoop.Client.Settings.ResourceDirectory*"></a>
<h4 id="RageCoop_Client_Settings_ResourceDirectory" data-uid="RageCoop.Client.Settings.ResourceDirectory">ResourceDirectory</h4>
<div class="markdown level1 summary"><p>The directory where resources downloaded from server will be placed.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string ResourceDirectory { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a></td>
<td></td>
</tr>
</tbody>
</table>
<a id="RageCoop_Client_Settings_Username_" data-uid="RageCoop.Client.Settings.Username*"></a>
<h4 id="RageCoop_Client_Settings_Username" data-uid="RageCoop.Client.Settings.Username">Username</h4>
<div class="markdown level1 summary"><p>Don't use it!</p>

2
docs/api/RageCoop.Client.html
View File

@ -87,7 +87,7 @@
<div class="markdown level0 remarks"></div>
<h3 id="classes">Classes
</h3>
<h4><a class="xref" href="RageCoop.Client.CoopMap.html">CoopMap</a></h4>
<h4><a class="xref" href="RageCoop.Client.Map.html">Map</a></h4>
<section></section>
<h4><a class="xref" href="RageCoop.Client.Settings.html">Settings</a></h4>
<section><p>Don't use it!</p>

34
docs/api/RageCoop.Server.Client.html
View File

@ -205,7 +205,7 @@
<a id="RageCoop_Server_Client_Latency_" data-uid="RageCoop.Server.Client.Latency*"></a>
<h4 id="RageCoop_Server_Client_Latency" data-uid="RageCoop.Server.Client.Latency">Latency</h4>
<div class="markdown level1 summary"><p>The client's latncy in seconds.</p>
<div class="markdown level1 summary"><p>The client's latency in seconds.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
@ -406,6 +406,38 @@
</table>
<a id="RageCoop_Server_Client_SendCustomEvent_" data-uid="RageCoop.Server.Client.SendCustomEvent*"></a>
<h4 id="RageCoop_Server_Client_SendCustomEvent_System_Int32_System_Object___" data-uid="RageCoop.Server.Client.SendCustomEvent(System.Int32,System.Object[])">SendCustomEvent(Int32, Object[])</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void SendCustomEvent(int hash, params object[] args)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.int32">Int32</a></td>
<td><span class="parametername">hash</span></td>
<td></td>
</tr>
<tr>
<td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object">Object</a>[]</td>
<td><span class="parametername">args</span></td>
<td></td>
</tr>
</tbody>
</table>
<a id="RageCoop_Server_Client_SendNativeCall_" data-uid="RageCoop.Server.Client.SendNativeCall*"></a>
<h4 id="RageCoop_Server_Client_SendNativeCall_GTA_Native_Hash_System_Object___" data-uid="RageCoop.Server.Client.SendNativeCall(GTA.Native.Hash,System.Object[])">SendNativeCall(Hash, Object[])</h4>
<div class="markdown level1 summary"><p>Send a native call to client and ignore it's response.</p>

32
docs/api/RageCoop.Server.Scripting.API.html
View File

@ -131,7 +131,7 @@
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public readonly APIEvents Events</code></pre>
<pre><code class="lang-csharp hljs">public readonly ServerEvents Events</code></pre>
</div>
<h5 class="fieldValue">Field Value</h5>
<table class="table table-bordered table-striped table-condensed">
@ -143,7 +143,7 @@
</thead>
<tbody>
<tr>
<td><a class="xref" href="RageCoop.Server.Scripting.APIEvents.html">APIEvents</a></td>
<td><a class="xref" href="RageCoop.Server.Scripting.ServerEvents.html">ServerEvents</a></td>
<td></td>
</tr>
</tbody>
@ -152,9 +152,35 @@
</h3>
<a id="RageCoop_Server_Scripting_API_Entities_" data-uid="RageCoop.Server.Scripting.API.Entities*"></a>
<h4 id="RageCoop_Server_Scripting_API_Entities" data-uid="RageCoop.Server.Scripting.API.Entities">Entities</h4>
<div class="markdown level1 summary"><p>All synchronized entities on this server.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public ServerEntities Entities { get; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="RageCoop.Server.ServerEntities.html">ServerEntities</a></td>
<td></td>
</tr>
</tbody>
</table>
<a id="RageCoop_Server_Scripting_API_Logger_" data-uid="RageCoop.Server.Scripting.API.Logger*"></a>
<h4 id="RageCoop_Server_Scripting_API_Logger" data-uid="RageCoop.Server.Scripting.API.Logger">Logger</h4>
<div class="markdown level1 summary"><p>Get a <a class="xref" href="RageCoop.Server.Scripting.API.html#RageCoop_Server_Scripting_API_Logger">Logger</a> that the server is currently using, you should use <a class="xref" href="RageCoop.Server.Scripting.ServerResource.html#RageCoop_Server_Scripting_ServerResource_Logger">Logger</a> to display resource-specific information.</p>
<div class="markdown level1 summary"><p>Get a <a class="xref" href="RageCoop.Core.Logger.html">Logger</a> that the server is currently using, you should use <a class="xref" href="RageCoop.Server.Scripting.ServerResource.html#RageCoop_Server_Scripting_ServerResource_Logger">Logger</a> to display resource-specific information.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>

336
docs/api/RageCoop.Server.Scripting.ServerEvents.html Normal file
View File

@ -0,0 +1,336 @@
<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Class ServerEvents
| RageCoop resource documentation </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class ServerEvents
| RageCoop resource documentation ">
<meta name="generator" content="docfx 2.59.2.0">
<link rel="shortcut icon" href="../favicon.ico">
<link rel="stylesheet" href="../styles/docfx.vendor.css">
<link rel="stylesheet" href="../styles/docfx.css">
<link rel="stylesheet" href="../styles/main.css">
<meta property="docfx:navrel" content="../toc.html">
<meta property="docfx:tocrel" content="toc.html">
<meta property="docfx:rel" content="../">
</head>
<body data-spy="scroll" data-target="#affix" data-offset="120">
<div id="wrapper">
<header>
<nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="../index.html">
<img id="logo" class="svg" src="../logo.svg" alt="">
</a>
</div>
<div class="collapse navbar-collapse" id="navbar">
<form class="navbar-form navbar-right" role="search" id="search">
<div class="form-group">
<input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
</div>
</form>
</div>
</div>
</nav>
<div class="subnav navbar navbar-default">
<div class="container hide-when-search" id="breadcrumb">
<ul class="breadcrumb">
<li></li>
</ul>
</div>
</div>
</header>
<div class="container body-content">
<div id="search-results">
<div class="search-list">Search Results for <span></span></div>
<div class="sr-items">
<p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
</div>
<ul id="pagination" data-first="First" data-prev="Previous" data-next="Next" data-last="Last"></ul>
</div>
</div>
<div role="main" class="container body-content hide-when-search">
<div class="sidenav hide-when-search">
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
<div class="sidetoggle collapse" id="sidetoggle">
<div id="sidetoc"></div>
</div>
</div>
<div class="article row grid-right">
<div class="col-md-10">
<article class="content wrap" id="_content" data-uid="RageCoop.Server.Scripting.ServerEvents">
<h1 id="RageCoop_Server_Scripting_ServerEvents" data-uid="RageCoop.Server.Scripting.ServerEvents" class="text-break">Class ServerEvents
</h1>
<div class="markdown level0 summary"></div>
<div class="markdown level0 conceptual"></div>
<div class="inheritance">
<h5>Inheritance</h5>
<div class="level0"><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object">Object</a></div>
<div class="level1"><span class="xref">ServerEvents</span></div>
</div>
<div class="inheritedMembers">
<h5>Inherited Members</h5>
<div>
<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">Object.Equals(Object)</a>
</div>
<div>
<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">Object.Equals(Object, Object)</a>
</div>
<div>
<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.gethashcode#system-object-gethashcode">Object.GetHashCode()</a>
</div>
<div>
<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.gettype#system-object-gettype">Object.GetType()</a>
</div>
<div>
<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.memberwiseclone#system-object-memberwiseclone">Object.MemberwiseClone()</a>
</div>
<div>
<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.referenceequals#system-object-referenceequals(system-object-system-object)">Object.ReferenceEquals(Object, Object)</a>
</div>
<div>
<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.tostring#system-object-tostring">Object.ToString()</a>
</div>
</div>
<h6><strong>Namespace</strong>: <a class="xref" href="RageCoop.Server.Scripting.html">RageCoop.Server.Scripting</a></h6>
<h6><strong>Assembly</strong>: RageCoop.Server.dll</h6>
<h5 id="RageCoop_Server_Scripting_ServerEvents_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class ServerEvents</code></pre>
</div>
<h3 id="events">Events
</h3>
<h4 id="RageCoop_Server_Scripting_ServerEvents_OnChatMessage" data-uid="RageCoop.Server.Scripting.ServerEvents.OnChatMessage">OnChatMessage</h4>
<div class="markdown level1 summary"><p>Invoked when a chat message is received.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public event EventHandler&lt;ChatEventArgs&gt; OnChatMessage</code></pre>
</div>
<h5 class="eventType">Event Type</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.eventhandler-1">EventHandler</a>&lt;<a class="xref" href="RageCoop.Server.Scripting.ChatEventArgs.html">ChatEventArgs</a>&gt;</td>
<td></td>
</tr>
</tbody>
</table>
<h4 id="RageCoop_Server_Scripting_ServerEvents_OnCommandReceived" data-uid="RageCoop.Server.Scripting.ServerEvents.OnCommandReceived">OnCommandReceived</h4>
<div class="markdown level1 summary"><p>Will be invoked from main thread before registered handlers</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public event EventHandler&lt;OnCommandEventArgs&gt; OnCommandReceived</code></pre>
</div>
<h5 class="eventType">Event Type</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.eventhandler-1">EventHandler</a>&lt;<a class="xref" href="RageCoop.Server.Scripting.OnCommandEventArgs.html">OnCommandEventArgs</a>&gt;</td>
<td></td>
</tr>
</tbody>
</table>
<h4 id="RageCoop_Server_Scripting_ServerEvents_OnPlayerConnected" data-uid="RageCoop.Server.Scripting.ServerEvents.OnPlayerConnected">OnPlayerConnected</h4>
<div class="markdown level1 summary"><p>Will be invoked when a player is connected, but this player might not be ready yet(client resources not loaded), using <a class="xref" href="RageCoop.Server.Scripting.ServerEvents.html#RageCoop_Server_Scripting_ServerEvents_OnPlayerReady">OnPlayerReady</a> is recommended.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public event EventHandler&lt;Client&gt; OnPlayerConnected</code></pre>
</div>
<h5 class="eventType">Event Type</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.eventhandler-1">EventHandler</a>&lt;<a class="xref" href="RageCoop.Server.Client.html">Client</a>&gt;</td>
<td></td>
</tr>
</tbody>
</table>
<h4 id="RageCoop_Server_Scripting_ServerEvents_OnPlayerDisconnected" data-uid="RageCoop.Server.Scripting.ServerEvents.OnPlayerDisconnected">OnPlayerDisconnected</h4>
<div class="markdown level1 summary"><p>Invoked when a player disconnected, all method won't be effective in this scope.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public event EventHandler&lt;Client&gt; OnPlayerDisconnected</code></pre>
</div>
<h5 class="eventType">Event Type</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.eventhandler-1">EventHandler</a>&lt;<a class="xref" href="RageCoop.Server.Client.html">Client</a>&gt;</td>
<td></td>
</tr>
</tbody>
</table>
<h4 id="RageCoop_Server_Scripting_ServerEvents_OnPlayerHandshake" data-uid="RageCoop.Server.Scripting.ServerEvents.OnPlayerHandshake">OnPlayerHandshake</h4>
<div class="markdown level1 summary"><p>Will be invoked from main thread when a client is attempting to connect, use <a class="xref" href="RageCoop.Server.Scripting.HandshakeEventArgs.html#RageCoop_Server_Scripting_HandshakeEventArgs_Deny_System_String_">Deny(String)</a> to deny the connection request.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public event EventHandler&lt;HandshakeEventArgs&gt; OnPlayerHandshake</code></pre>
</div>
<h5 class="eventType">Event Type</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.eventhandler-1">EventHandler</a>&lt;<a class="xref" href="RageCoop.Server.Scripting.HandshakeEventArgs.html">HandshakeEventArgs</a>&gt;</td>
<td></td>
</tr>
</tbody>
</table>
<h4 id="RageCoop_Server_Scripting_ServerEvents_OnPlayerReady" data-uid="RageCoop.Server.Scripting.ServerEvents.OnPlayerReady">OnPlayerReady</h4>
<div class="markdown level1 summary"><p>Will be invoked after the client connected and all resources(if any) have been loaded.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public event EventHandler&lt;Client&gt; OnPlayerReady</code></pre>
</div>
<h5 class="eventType">Event Type</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.eventhandler-1">EventHandler</a>&lt;<a class="xref" href="RageCoop.Server.Client.html">Client</a>&gt;</td>
<td></td>
</tr>
</tbody>
</table>
<h4 id="RageCoop_Server_Scripting_ServerEvents_OnPlayerUpdate" data-uid="RageCoop.Server.Scripting.ServerEvents.OnPlayerUpdate">OnPlayerUpdate</h4>
<div class="markdown level1 summary"><p>Invoked everytime a player's main ped has been updated</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public event EventHandler&lt;Client&gt; OnPlayerUpdate</code></pre>
</div>
<h5 class="eventType">Event Type</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.eventhandler-1">EventHandler</a>&lt;<a class="xref" href="RageCoop.Server.Client.html">Client</a>&gt;</td>
<td></td>
</tr>
</tbody>
</table>
</article>
</div>
<div class="hidden-sm col-md-2" role="complementary">
<div class="sideaffix">
<div class="contribution">
<ul class="nav">
</ul>
</div>
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
<h5>In This Article</h5>
<div></div>
</nav>
</div>
</div>
</div>
</div>
<footer>
<div class="grad-bottom"></div>
<div class="footer">
<div class="container">
<span class="pull-right">
<a href="#top">Back to top</a>
</span>
<span>Generated by <strong>DocFX</strong></span>
</div>
</div>
</footer>
</div>
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
<script type="text/javascript" src="../styles/docfx.js"></script>
<script type="text/javascript" src="../styles/main.js"></script>
</body>
</html>

4
docs/api/RageCoop.Server.Scripting.ServerScript.html
View File

@ -127,7 +127,7 @@
<a id="RageCoop_Server_Scripting_ServerScript_API_" data-uid="RageCoop.Server.Scripting.ServerScript.API*"></a>
<h4 id="RageCoop_Server_Scripting_ServerScript_API" data-uid="RageCoop.Server.Scripting.ServerScript.API">API</h4>
<div class="markdown level1 summary"><p>Get the <a class="xref" href="RageCoop.Server.Scripting.ServerScript.html#RageCoop_Server_Scripting_ServerScript_API">API</a> instance that can be used to control the server.</p>
<div class="markdown level1 summary"><p>Get the <a class="xref" href="RageCoop.Server.Scripting.API.html">API</a> instance that can be used to control the server.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
@ -179,7 +179,7 @@
<a id="RageCoop_Server_Scripting_ServerScript_CurrentResource_" data-uid="RageCoop.Server.Scripting.ServerScript.CurrentResource*"></a>
<h4 id="RageCoop_Server_Scripting_ServerScript_CurrentResource" data-uid="RageCoop.Server.Scripting.ServerScript.CurrentResource">CurrentResource</h4>
<div class="markdown level1 summary"><p>Get the <a class="xref" href="RageCoop.Server.Scripting.ServerResource.html">ServerResource</a> object this script belongs to, this property will be initiated before <a class="xref" href="RageCoop.Server.Scripting.ServerScript.html#RageCoop_Server_Scripting_ServerScript_OnStart">OnStart()</a> (will be null if you access it in the constructor).</p>
<div class="markdown level1 summary"><p>Get the <a class="xref" href="RageCoop.Server.Scripting.ServerResource.html">ServerResource</a> this script belongs to, this property won't be initiated before <a class="xref" href="RageCoop.Server.Scripting.ServerScript.html#RageCoop_Server_Scripting_ServerScript_OnStart">OnStart()</a>.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>

4
docs/api/RageCoop.Server.Scripting.html
View File

@ -90,8 +90,6 @@
<h4><a class="xref" href="RageCoop.Server.Scripting.API.html">API</a></h4>
<section><p>An class that can be used to interact with RageCoop server.</p>
</section>
<h4><a class="xref" href="RageCoop.Server.Scripting.APIEvents.html">APIEvents</a></h4>
<section></section>
<h4><a class="xref" href="RageCoop.Server.Scripting.ChatEventArgs.html">ChatEventArgs</a></h4>
<section></section>
<h4><a class="xref" href="RageCoop.Server.Scripting.Command.html">Command</a></h4>
@ -106,6 +104,8 @@
<section></section>
<h4><a class="xref" href="RageCoop.Server.Scripting.OnCommandEventArgs.html">OnCommandEventArgs</a></h4>
<section></section>
<h4><a class="xref" href="RageCoop.Server.Scripting.ServerEvents.html">ServerEvents</a></h4>
<section></section>
<h4><a class="xref" href="RageCoop.Server.Scripting.ServerResource.html">ServerResource</a></h4>
<section><p>A class representing a server side resource, each resource is isolated from another and will be started alongside the server.</p>
</section>

240
docs/api/RageCoop.Server.ServerEntities.html Normal file
View File

@ -0,0 +1,240 @@
<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Class ServerEntities
| RageCoop resource documentation </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class ServerEntities
| RageCoop resource documentation ">
<meta name="generator" content="docfx 2.59.2.0">
<link rel="shortcut icon" href="../favicon.ico">
<link rel="stylesheet" href="../styles/docfx.vendor.css">
<link rel="stylesheet" href="../styles/docfx.css">
<link rel="stylesheet" href="../styles/main.css">
<meta property="docfx:navrel" content="../toc.html">
<meta property="docfx:tocrel" content="toc.html">
<meta property="docfx:rel" content="../">
</head>
<body data-spy="scroll" data-target="#affix" data-offset="120">
<div id="wrapper">
<header>
<nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="../index.html">
<img id="logo" class="svg" src="../logo.svg" alt="">
</a>
</div>
<div class="collapse navbar-collapse" id="navbar">
<form class="navbar-form navbar-right" role="search" id="search">
<div class="form-group">
<input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
</div>
</form>
</div>
</div>
</nav>
<div class="subnav navbar navbar-default">
<div class="container hide-when-search" id="breadcrumb">
<ul class="breadcrumb">
<li></li>
</ul>
</div>
</div>
</header>
<div class="container body-content">
<div id="search-results">
<div class="search-list">Search Results for <span></span></div>
<div class="sr-items">
<p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
</div>
<ul id="pagination" data-first="First" data-prev="Previous" data-next="Next" data-last="Last"></ul>
</div>
</div>
<div role="main" class="container body-content hide-when-search">
<div class="sidenav hide-when-search">
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
<div class="sidetoggle collapse" id="sidetoggle">
<div id="sidetoc"></div>
</div>
</div>
<div class="article row grid-right">
<div class="col-md-10">
<article class="content wrap" id="_content" data-uid="RageCoop.Server.ServerEntities">
<h1 id="RageCoop_Server_ServerEntities" data-uid="RageCoop.Server.ServerEntities" class="text-break">Class ServerEntities
</h1>
<div class="markdown level0 summary"><p>Manipulate entities from the server</p>
</div>
<div class="markdown level0 conceptual"></div>
<div class="inheritance">
<h5>Inheritance</h5>
<div class="level0"><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object">Object</a></div>
<div class="level1"><span class="xref">ServerEntities</span></div>
</div>
<div class="inheritedMembers">
<h5>Inherited Members</h5>
<div>
<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">Object.Equals(Object)</a>
</div>
<div>
<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">Object.Equals(Object, Object)</a>
</div>
<div>
<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.gethashcode#system-object-gethashcode">Object.GetHashCode()</a>
</div>
<div>
<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.gettype#system-object-gettype">Object.GetType()</a>
</div>
<div>
<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.memberwiseclone#system-object-memberwiseclone">Object.MemberwiseClone()</a>
</div>
<div>
<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.referenceequals#system-object-referenceequals(system-object-system-object)">Object.ReferenceEquals(Object, Object)</a>
</div>
<div>
<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.tostring#system-object-tostring">Object.ToString()</a>
</div>
</div>
<h6><strong>Namespace</strong>: <a class="xref" href="RageCoop.Server.html">RageCoop.Server</a></h6>
<h6><strong>Assembly</strong>: RageCoop.Server.dll</h6>
<h5 id="RageCoop_Server_ServerEntities_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class ServerEntities</code></pre>
</div>
<h3 id="methods">Methods
</h3>
<a id="RageCoop_Server_ServerEntities_GetAllObjects_" data-uid="RageCoop.Server.ServerEntities.GetAllObjects*"></a>
<h4 id="RageCoop_Server_ServerEntities_GetAllObjects" data-uid="RageCoop.Server.ServerEntities.GetAllObjects">GetAllObjects()</h4>
<div class="markdown level1 summary"><p>Get all static objects owned by server</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public ServerObject[] GetAllObjects()</code></pre>
</div>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="RageCoop.Server.ServerObject.html">ServerObject</a>[]</td>
<td></td>
</tr>
</tbody>
</table>
<a id="RageCoop_Server_ServerEntities_GetAllPeds_" data-uid="RageCoop.Server.ServerEntities.GetAllPeds*"></a>
<h4 id="RageCoop_Server_ServerEntities_GetAllPeds" data-uid="RageCoop.Server.ServerEntities.GetAllPeds">GetAllPeds()</h4>
<div class="markdown level1 summary"><p>Get all peds on this server</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public ServerPed[] GetAllPeds()</code></pre>
</div>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="RageCoop.Server.ServerPed.html">ServerPed</a>[]</td>
<td></td>
</tr>
</tbody>
</table>
<a id="RageCoop_Server_ServerEntities_GetAllVehicle_" data-uid="RageCoop.Server.ServerEntities.GetAllVehicle*"></a>
<h4 id="RageCoop_Server_ServerEntities_GetAllVehicle" data-uid="RageCoop.Server.ServerEntities.GetAllVehicle">GetAllVehicle()</h4>
<div class="markdown level1 summary"><p>Get all vehicles on this server</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public ServerVehicle[] GetAllVehicle()</code></pre>
</div>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="RageCoop.Server.ServerVehicle.html">ServerVehicle</a>[]</td>
<td></td>
</tr>
</tbody>
</table>
</article>
</div>
<div class="hidden-sm col-md-2" role="complementary">
<div class="sideaffix">
<div class="contribution">
<ul class="nav">
</ul>
</div>
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
<h5>In This Article</h5>
<div></div>
</nav>
</div>
</div>
</div>
</div>
<footer>
<div class="grad-bottom"></div>
<div class="footer">
<div class="container">
<span class="pull-right">
<a href="#top">Back to top</a>
</span>
<span>Generated by <strong>DocFX</strong></span>
</div>
</div>
</footer>
</div>
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
<script type="text/javascript" src="../styles/docfx.js"></script>
<script type="text/javascript" src="../styles/main.js"></script>
</body>
</html>

266
docs/api/RageCoop.Server.ServerObject.html Normal file
View File

@ -0,0 +1,266 @@
<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Class ServerObject
| RageCoop resource documentation </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class ServerObject
| RageCoop resource documentation ">
<meta name="generator" content="docfx 2.59.2.0">
<link rel="shortcut icon" href="../favicon.ico">
<link rel="stylesheet" href="../styles/docfx.vendor.css">
<link rel="stylesheet" href="../styles/docfx.css">
<link rel="stylesheet" href="../styles/main.css">
<meta property="docfx:navrel" content="../toc.html">
<meta property="docfx:tocrel" content="toc.html">
<meta property="docfx:rel" content="../">
</head>
<body data-spy="scroll" data-target="#affix" data-offset="120">
<div id="wrapper">
<header>
<nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="../index.html">
<img id="logo" class="svg" src="../logo.svg" alt="">
</a>
</div>
<div class="collapse navbar-collapse" id="navbar">
<form class="navbar-form navbar-right" role="search" id="search">
<div class="form-group">
<input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
</div>
</form>
</div>
</div>
</nav>
<div class="subnav navbar navbar-default">
<div class="container hide-when-search" id="breadcrumb">
<ul class="breadcrumb">
<li></li>
</ul>
</div>
</div>
</header>
<div class="container body-content">
<div id="search-results">
<div class="search-list">Search Results for <span></span></div>
<div class="sr-items">
<p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
</div>
<ul id="pagination" data-first="First" data-prev="Previous" data-next="Next" data-last="Last"></ul>
</div>
</div>
<div role="main" class="container body-content hide-when-search">
<div class="sidenav hide-when-search">
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
<div class="sidetoggle collapse" id="sidetoggle">
<div id="sidetoc"></div>
</div>
</div>
<div class="article row grid-right">
<div class="col-md-10">
<article class="content wrap" id="_content" data-uid="RageCoop.Server.ServerObject">
<h1 id="RageCoop_Server_ServerObject" data-uid="RageCoop.Server.ServerObject" class="text-break">Class ServerObject
</h1>
<div class="markdown level0 summary"><p>Represents an object owned by server.</p>
</div>
<div class="markdown level0 conceptual"></div>
<div class="inheritance">
<h5>Inheritance</h5>
<div class="level0"><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object">Object</a></div>
<div class="level1"><span class="xref">ServerObject</span></div>
</div>
<div class="inheritedMembers">
<h5>Inherited Members</h5>
<div>
<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">Object.Equals(Object)</a>
</div>
<div>
<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">Object.Equals(Object, Object)</a>
</div>
<div>
<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.gethashcode#system-object-gethashcode">Object.GetHashCode()</a>
</div>
<div>
<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.gettype#system-object-gettype">Object.GetType()</a>
</div>
<div>
<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.memberwiseclone#system-object-memberwiseclone">Object.MemberwiseClone()</a>
</div>
<div>
<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.referenceequals#system-object-referenceequals(system-object-system-object)">Object.ReferenceEquals(Object, Object)</a>
</div>
<div>
<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.tostring#system-object-tostring">Object.ToString()</a>
</div>
</div>
<h6><strong>Namespace</strong>: <a class="xref" href="RageCoop.Server.html">RageCoop.Server</a></h6>
<h6><strong>Assembly</strong>: RageCoop.Server.dll</h6>
<h5 id="RageCoop_Server_ServerObject_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class ServerObject</code></pre>
</div>
<h3 id="properties">Properties
</h3>
<a id="RageCoop_Server_ServerObject_IsInvincible_" data-uid="RageCoop.Server.ServerObject.IsInvincible*"></a>
<h4 id="RageCoop_Server_ServerObject_IsInvincible" data-uid="RageCoop.Server.ServerObject.IsInvincible">IsInvincible</h4>
<div class="markdown level1 summary"><p>Whether this object is invincible</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public bool IsInvincible { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.boolean">Boolean</a></td>
<td></td>
</tr>
</tbody>
</table>
<a id="RageCoop_Server_ServerObject_Model_" data-uid="RageCoop.Server.ServerObject.Model*"></a>
<h4 id="RageCoop_Server_ServerObject_Model" data-uid="RageCoop.Server.ServerObject.Model">Model</h4>
<div class="markdown level1 summary"><p>The object's model</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Model Model { get; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">GTA.Model</span></td>
<td></td>
</tr>
</tbody>
</table>
<a id="RageCoop_Server_ServerObject_Position_" data-uid="RageCoop.Server.ServerObject.Position*"></a>
<h4 id="RageCoop_Server_ServerObject_Position" data-uid="RageCoop.Server.ServerObject.Position">Position</h4>
<div class="markdown level1 summary"><p>Gets or sets this object's position</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Vector3 Position { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">GTA.Math.Vector3</span></td>
<td></td>
</tr>
</tbody>
</table>
<a id="RageCoop_Server_ServerObject_Quaternion_" data-uid="RageCoop.Server.ServerObject.Quaternion*"></a>
<h4 id="RageCoop_Server_ServerObject_Quaternion" data-uid="RageCoop.Server.ServerObject.Quaternion">Quaternion</h4>
<div class="markdown level1 summary"><p>Gets or sets this object's quaternion</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Quaternion Quaternion { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">GTA.Math.Quaternion</span></td>
<td></td>
</tr>
</tbody>
</table>
</article>
</div>
<div class="hidden-sm col-md-2" role="complementary">
<div class="sideaffix">
<div class="contribution">
<ul class="nav">
</ul>
</div>
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
<h5>In This Article</h5>
<div></div>
</nav>
</div>
</div>
</div>
</div>
<footer>
<div class="grad-bottom"></div>
<div class="footer">
<div class="container">
<span class="pull-right">
<a href="#top">Back to top</a>
</span>
<span>Generated by <strong>DocFX</strong></span>
</div>
</div>
</footer>
</div>
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
<script type="text/javascript" src="../styles/docfx.js"></script>
<script type="text/javascript" src="../styles/main.js"></script>
</body>
</html>

64
docs/api/RageCoop.Server.ServerPed.html
View File

@ -153,7 +153,7 @@
<a id="RageCoop_Server_ServerPed_ID_" data-uid="RageCoop.Server.ServerPed.ID*"></a>
<h4 id="RageCoop_Server_ServerPed_ID" data-uid="RageCoop.Server.ServerPed.ID">ID</h4>
<div class="markdown level1 summary"><p>The ped's ID (not handle!).</p>
<div class="markdown level1 summary"><p>The ped's network ID (not handle!).</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
@ -177,6 +177,58 @@
</table>
<a id="RageCoop_Server_ServerPed_IsPlayer_" data-uid="RageCoop.Server.ServerPed.IsPlayer*"></a>
<h4 id="RageCoop_Server_ServerPed_IsPlayer" data-uid="RageCoop.Server.ServerPed.IsPlayer">IsPlayer</h4>
<div class="markdown level1 summary"><p>Whether this ped is a player.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public bool IsPlayer { get; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.boolean">Boolean</a></td>
<td></td>
</tr>
</tbody>
</table>
<a id="RageCoop_Server_ServerPed_LastVehicle_" data-uid="RageCoop.Server.ServerPed.LastVehicle*"></a>
<h4 id="RageCoop_Server_ServerPed_LastVehicle" data-uid="RageCoop.Server.ServerPed.LastVehicle">LastVehicle</h4>
<div class="markdown level1 summary"><p>The ped's last vehicle.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public ServerVehicle LastVehicle { get; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="RageCoop.Server.ServerVehicle.html">ServerVehicle</a></td>
<td></td>
</tr>
</tbody>
</table>
<a id="RageCoop_Server_ServerPed_Owner_" data-uid="RageCoop.Server.ServerPed.Owner*"></a>
<h4 id="RageCoop_Server_ServerPed_Owner" data-uid="RageCoop.Server.ServerPed.Owner">Owner</h4>
<div class="markdown level1 summary"><p>The <a class="xref" href="RageCoop.Server.Client.html">Client</a> that is responsible synchronizing for this ped.</p>
@ -229,14 +281,14 @@
</table>
<a id="RageCoop_Server_ServerPed_VehicleID_" data-uid="RageCoop.Server.ServerPed.VehicleID*"></a>
<h4 id="RageCoop_Server_ServerPed_VehicleID" data-uid="RageCoop.Server.ServerPed.VehicleID">VehicleID</h4>
<div class="markdown level1 summary"><p>The ID of the ped's last vehicle.</p>
<a id="RageCoop_Server_ServerPed_Rotation_" data-uid="RageCoop.Server.ServerPed.Rotation*"></a>
<h4 id="RageCoop_Server_ServerPed_Rotation" data-uid="RageCoop.Server.ServerPed.Rotation">Rotation</h4>
<div class="markdown level1 summary"><p>Gets or sets this ped's rotation</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public int VehicleID { get; }</code></pre>
<pre><code class="lang-csharp hljs">public Vector3 Rotation { get; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
@ -248,7 +300,7 @@
</thead>
<tbody>
<tr>
<td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.int32">Int32</a></td>
<td><span class="xref">GTA.Math.Vector3</span></td>
<td></td>
</tr>
</tbody>

57
docs/api/RageCoop.Server.ServerSettings.html
View File

@ -121,40 +121,13 @@
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class ServerSettings</code></pre>
</div>
<h3 id="fields">Fields
</h3>
<h4 id="RageCoop_Server_ServerSettings_LogLevel" data-uid="RageCoop.Server.ServerSettings.LogLevel">LogLevel</h4>
<div class="markdown level1 summary"><p>See <a class="xref" href="RageCoop.Core.Logger.html#RageCoop_Core_Logger_LogLevel">LogLevel</a>.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public int LogLevel</code></pre>
</div>
<h5 class="fieldValue">Field Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.int32">Int32</a></td>
<td></td>
</tr>
</tbody>
</table>
<h3 id="properties">Properties
</h3>
<a id="RageCoop_Server_ServerSettings_AnnounceSelf_" data-uid="RageCoop.Server.ServerSettings.AnnounceSelf*"></a>
<h4 id="RageCoop_Server_ServerSettings_AnnounceSelf" data-uid="RageCoop.Server.ServerSettings.AnnounceSelf">AnnounceSelf</h4>
<div class="markdown level1 summary"><p>Whether or not to announce this server so that it'll appear on server list.</p>
<div class="markdown level1 summary"><p>Whether or not to announce this server so it'll appear on server list.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
@ -178,9 +151,35 @@
</table>
<a id="RageCoop_Server_ServerSettings_LogLevel_" data-uid="RageCoop.Server.ServerSettings.LogLevel*"></a>
<h4 id="RageCoop_Server_ServerSettings_LogLevel" data-uid="RageCoop.Server.ServerSettings.LogLevel">LogLevel</h4>
<div class="markdown level1 summary"><p>See <a class="xref" href="RageCoop.Core.Logger.html#RageCoop_Core_Logger_LogLevel">LogLevel</a>.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public int LogLevel { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.int32">Int32</a></td>
<td></td>
</tr>
</tbody>
</table>
<a id="RageCoop_Server_ServerSettings_MasterServer_" data-uid="RageCoop.Server.ServerSettings.MasterServer*"></a>
<h4 id="RageCoop_Server_ServerSettings_MasterServer" data-uid="RageCoop.Server.ServerSettings.MasterServer">MasterServer</h4>
<div class="markdown level1 summary"><p>Master server address, mostly doesn't to be changed.</p>
<div class="markdown level1 summary"><p>Master server address, mostly doesn't need to be changed.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>

266
docs/api/RageCoop.Server.ServerVehicle.html Normal file
View File

@ -0,0 +1,266 @@
<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Class ServerVehicle
| RageCoop resource documentation </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class ServerVehicle
| RageCoop resource documentation ">
<meta name="generator" content="docfx 2.59.2.0">
<link rel="shortcut icon" href="../favicon.ico">
<link rel="stylesheet" href="../styles/docfx.vendor.css">
<link rel="stylesheet" href="../styles/docfx.css">
<link rel="stylesheet" href="../styles/main.css">
<meta property="docfx:navrel" content="../toc.html">
<meta property="docfx:tocrel" content="toc.html">
<meta property="docfx:rel" content="../">
</head>
<body data-spy="scroll" data-target="#affix" data-offset="120">
<div id="wrapper">
<header>
<nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="../index.html">
<img id="logo" class="svg" src="../logo.svg" alt="">
</a>
</div>
<div class="collapse navbar-collapse" id="navbar">
<form class="navbar-form navbar-right" role="search" id="search">
<div class="form-group">
<input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
</div>
</form>
</div>
</div>
</nav>
<div class="subnav navbar navbar-default">
<div class="container hide-when-search" id="breadcrumb">
<ul class="breadcrumb">
<li></li>
</ul>
</div>
</div>
</header>
<div class="container body-content">
<div id="search-results">
<div class="search-list">Search Results for <span></span></div>
<div class="sr-items">
<p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
</div>
<ul id="pagination" data-first="First" data-prev="Previous" data-next="Next" data-last="Last"></ul>
</div>
</div>
<div role="main" class="container body-content hide-when-search">
<div class="sidenav hide-when-search">
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
<div class="sidetoggle collapse" id="sidetoggle">
<div id="sidetoc"></div>
</div>
</div>
<div class="article row grid-right">
<div class="col-md-10">
<article class="content wrap" id="_content" data-uid="RageCoop.Server.ServerVehicle">
<h1 id="RageCoop_Server_ServerVehicle" data-uid="RageCoop.Server.ServerVehicle" class="text-break">Class ServerVehicle
</h1>
<div class="markdown level0 summary"><p>Represents a vehicle from a client</p>
</div>
<div class="markdown level0 conceptual"></div>
<div class="inheritance">
<h5>Inheritance</h5>
<div class="level0"><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object">Object</a></div>
<div class="level1"><span class="xref">ServerVehicle</span></div>
</div>
<div class="inheritedMembers">
<h5>Inherited Members</h5>
<div>
<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">Object.Equals(Object)</a>
</div>
<div>
<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">Object.Equals(Object, Object)</a>
</div>
<div>
<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.gethashcode#system-object-gethashcode">Object.GetHashCode()</a>
</div>
<div>
<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.gettype#system-object-gettype">Object.GetType()</a>
</div>
<div>
<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.memberwiseclone#system-object-memberwiseclone">Object.MemberwiseClone()</a>
</div>
<div>
<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.referenceequals#system-object-referenceequals(system-object-system-object)">Object.ReferenceEquals(Object, Object)</a>
</div>
<div>
<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.tostring#system-object-tostring">Object.ToString()</a>
</div>
</div>
<h6><strong>Namespace</strong>: <a class="xref" href="RageCoop.Server.html">RageCoop.Server</a></h6>
<h6><strong>Assembly</strong>: RageCoop.Server.dll</h6>
<h5 id="RageCoop_Server_ServerVehicle_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class ServerVehicle</code></pre>
</div>
<h3 id="properties">Properties
</h3>
<a id="RageCoop_Server_ServerVehicle_ID_" data-uid="RageCoop.Server.ServerVehicle.ID*"></a>
<h4 id="RageCoop_Server_ServerVehicle_ID" data-uid="RageCoop.Server.ServerVehicle.ID">ID</h4>
<div class="markdown level1 summary"><p>The vehicle's network ID (not handle!).</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public int ID { get; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.int32">Int32</a></td>
<td></td>
</tr>
</tbody>
</table>
<a id="RageCoop_Server_ServerVehicle_Owner_" data-uid="RageCoop.Server.ServerVehicle.Owner*"></a>
<h4 id="RageCoop_Server_ServerVehicle_Owner" data-uid="RageCoop.Server.ServerVehicle.Owner">Owner</h4>
<div class="markdown level1 summary"><p>The <a class="xref" href="RageCoop.Server.Client.html">Client</a> that is responsible synchronizing for this vehicle.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Client Owner { get; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="RageCoop.Server.Client.html">Client</a></td>
<td></td>
</tr>
</tbody>
</table>
<a id="RageCoop_Server_ServerVehicle_Position_" data-uid="RageCoop.Server.ServerVehicle.Position*"></a>
<h4 id="RageCoop_Server_ServerVehicle_Position" data-uid="RageCoop.Server.ServerVehicle.Position">Position</h4>
<div class="markdown level1 summary"><p>Position of this vehicle</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Vector3 Position { get; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">GTA.Math.Vector3</span></td>
<td></td>
</tr>
</tbody>
</table>
<a id="RageCoop_Server_ServerVehicle_Quaternion_" data-uid="RageCoop.Server.ServerVehicle.Quaternion*"></a>
<h4 id="RageCoop_Server_ServerVehicle_Quaternion" data-uid="RageCoop.Server.ServerVehicle.Quaternion">Quaternion</h4>
<div class="markdown level1 summary"><p>Gets or sets this vehicle's quaternion</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Quaternion Quaternion { get; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">GTA.Math.Quaternion</span></td>
<td></td>
</tr>
</tbody>
</table>
</article>
</div>
<div class="hidden-sm col-md-2" role="complementary">
<div class="sideaffix">
<div class="contribution">
<ul class="nav">
</ul>
</div>
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
<h5>In This Article</h5>
<div></div>
</nav>
</div>
</div>
</div>
</div>
<footer>
<div class="grad-bottom"></div>
<div class="footer">
<div class="container">
<span class="pull-right">
<a href="#top">Back to top</a>
</span>
<span>Generated by <strong>DocFX</strong></span>
</div>
</div>
</footer>
</div>
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
<script type="text/javascript" src="../styles/docfx.js"></script>
<script type="text/javascript" src="../styles/main.js"></script>
</body>
</html>

9
docs/api/RageCoop.Server.html
View File

@ -94,12 +94,21 @@
<section></section>
<h4><a class="xref" href="RageCoop.Server.Server.html">Server</a></h4>
<section><p>The instantiable RageCoop server class</p>
</section>
<h4><a class="xref" href="RageCoop.Server.ServerEntities.html">ServerEntities</a></h4>
<section><p>Manipulate entities from the server</p>
</section>
<h4><a class="xref" href="RageCoop.Server.ServerObject.html">ServerObject</a></h4>
<section><p>Represents an object owned by server.</p>
</section>
<h4><a class="xref" href="RageCoop.Server.ServerPed.html">ServerPed</a></h4>
<section><p>Represents a ped from a client</p>
</section>
<h4><a class="xref" href="RageCoop.Server.ServerSettings.html">ServerSettings</a></h4>
<section><p>Settings for RageCoop Server</p>
</section>
<h4><a class="xref" href="RageCoop.Server.ServerVehicle.html">ServerVehicle</a></h4>
<section><p>Represents a vehicle from a client</p>
</section>
</article>
</div>

19
docs/api/toc.html
View File

@ -18,10 +18,10 @@
<ul class="nav level2">
<li>
<a href="RageCoop.Client.CoopMap.html" name="" title="CoopMap">CoopMap</a>
<a href="RageCoop.Client.CoopProp.html" name="" title="CoopProp">CoopProp</a>
</li>
<li>
<a href="RageCoop.Client.CoopProp.html" name="" title="CoopProp">CoopProp</a>
<a href="RageCoop.Client.Map.html" name="" title="Map">Map</a>
</li>
<li>
<a href="RageCoop.Client.Settings.html" name="" title="Settings">Settings</a>
@ -111,12 +111,21 @@
<li>
<a href="RageCoop.Server.Server.html" name="" title="Server">Server</a>
</li>
<li>
<a href="RageCoop.Server.ServerEntities.html" name="" title="ServerEntities">ServerEntities</a>
</li>
<li>
<a href="RageCoop.Server.ServerObject.html" name="" title="ServerObject">ServerObject</a>
</li>
<li>
<a href="RageCoop.Server.ServerPed.html" name="" title="ServerPed">ServerPed</a>
</li>
<li>
<a href="RageCoop.Server.ServerSettings.html" name="" title="ServerSettings">ServerSettings</a>
</li>
<li>
<a href="RageCoop.Server.ServerVehicle.html" name="" title="ServerVehicle">ServerVehicle</a>
</li>
</ul>
</li>
<li>
@ -127,9 +136,6 @@
<li>
<a href="RageCoop.Server.Scripting.API.html" name="" title="API">API</a>
</li>
<li>
<a href="RageCoop.Server.Scripting.APIEvents.html" name="" title="APIEvents">APIEvents</a>
</li>
<li>
<a href="RageCoop.Server.Scripting.ChatEventArgs.html" name="" title="ChatEventArgs">ChatEventArgs</a>
</li>
@ -148,6 +154,9 @@
<li>
<a href="RageCoop.Server.Scripting.OnCommandEventArgs.html" name="" title="OnCommandEventArgs">OnCommandEventArgs</a>
</li>
<li>
<a href="RageCoop.Server.Scripting.ServerEvents.html" name="" title="ServerEvents">ServerEvents</a>
</li>
<li>
<a href="RageCoop.Server.Scripting.ServerResource.html" name="" title="ServerResource">ServerResource</a>
</li>

51
docs/index.html
View File

@ -72,11 +72,14 @@
<article class="content wrap" id="_content" data-uid="">
<h1 id="getting-started">Getting started</h1>
<p>Here you can learn how to create your first resource</p>
<h2 id="resources-and-scripts">Resources and Scripts</h2>
<p>A <strong>Script</strong> stands for class that inherits from RageCoop's script class ( <a href="api/RageCoop.Server.Scripting.ServerScript.html">ServerScript</a> and <a href="api/RageCoop.Client.Scripting.ClientScript.html">ClientScript</a> ) and will be loaded at runtime, one assembly can have multiple scripts in it.</p>
<p>A <strong>Resource</strong> consists of one or more assemblies and other files. Server-side resource will be loaded at startup and is isolated from other resources, while client-side resource will be sent to each client and loaded after they connected to the server. A <strong>Resource</strong> can either be in a folder or packed inside a zip archive.</p>
<h2 id="directory-structure">Directory structure</h2>
<p>Below is the server's directory structure</p>
<pre><code>ServerRoot
│ Settings.xml
| RageCoop.Server.exe
│
└───Resources
└───Server
@ -91,16 +94,13 @@
└───Temp
</code></pre>
<h3 id="settingsxml">Settings.xml</h3>
<p>This file will be generated first time you started the, you can change the server's configuration option by editing it, refer to <a href="api/RageCoop.Server.ServerSettings.html">this</a> for detailed description.</p>
<h3 id="resources">Resources</h3>
<p>Each directory or zip in represents one resource, which consists of several dlls, and is isolated from another resource.</p>
<p>This file will be generated first time you started the server, you can then change the server's configuration option by editing it, refer to <a href="api/RageCoop.Server.ServerSettings.html">ServerSettings</a> for detailed description.</p>
<h2 id="server-reource">Server Reource</h2>
<p>The resource will be running at server side, here's how to create one:</p>
<p>To create a server resource:</p>
<ol>
<li>Create a C# class library project targeting .NET 6.0.</li>
<li>Add reference to <strong>RageCoop.Server.dll</strong> and <strong>RageCoop.Core.dll</strong>.</li>
<li>Add following namespace(s):</li>
</ol>
<li>Add following namespace(s):
<pre><code>using RageCoop.Server.Scripting;
// Optional
@ -109,24 +109,33 @@ using RageCoop.Core.Scripting;
using RageCoop.Core;
</code></pre>
<ol start="4">
</li>
<li>Inherit a class from <a href="api/RageCoop.Server.Scripting.ServerScript.html">ServerScript</a>.</li>
<li>Implement <code>OnStart()</code> and <code>OnStop()</code>:</li>
</ol>
<pre><code>public class MyFirstResource :ServerScript
<li>Implement <code>OnStart()</code> and <code>OnStop()</code>, your cs file should look like this:
<pre><code>using RageCoop.Server.Scripting;
namespace NiceGuy.MyFirstResource
{
public override void OnStart()
{
// Initiate your script here
}
public override void OnStop()
{
// Free all resources and perform cleanup
}
public class Main : ServerScript
{
public override void OnStart()
{
// Initiate your script here
}
public override void OnStop()
{
// Free all resources and perform cleanup
}
}
}
</code></pre>
<ol start="6">
<li>That's it! Now you can have some fun by using the <a href="api/RageCoop.Server.Scripting.API.html">API</a> instance, please refer to the <a href="https://github.com/RAGECOOP/GTAV-RESOURCES">GiHub</a> for more examples.</li>
</li>
<li>Now you can have some fun by using the <a href="api/RageCoop.Server.Scripting.API.html">API</a> instance, please refer to the <a href="https://github.com/RAGECOOP/GTAV-RESOURCES">GitHub repo</a> for more examples.</li>
<li>For convenience, you can create a symlink in <code>ServerRoot/Resources/Server/NiceGuy.MyFirstResource</code> targeting your output folder:
<pre><code>mklink /d ServerRoot/Resources/Server/NiceGuy.MyFirstResource C:/MyRepos/NiceGuy.MyFirstResource/bin/Debug
</code></pre>
</li>
<li>That's it! Start your server and you should see your resource loading.</li>
</ol>
</article>
</div>

59
docs/index.json
View File

File diff suppressed because one or more lines are too long

130
docs/manifest.json
View File

@ -1,6 +1,6 @@
{
"homepages": [],
"source_base_path": "M:/SandBox-Shared/repo/RageCoop/RageCoop-V",
"source_base_path": "M:/SandBox-Shared/repos/RageCoop/RageCoop-V",
"xrefmap": "xrefmap.yml",
"files": [
{
@ -33,19 +33,7 @@
"output": {
".html": {
"relative_path": "index.html",
"hash": "xZtR9mnh2bw9nXr6zDQZUznPJ6l0uDhL2mvGT2zIDr8="
}
},
"is_incremental": false,
"version": ""
},
{
"type": "ManagedReference",
"source_relative_path": "obj/api/RageCoop.Client.CoopMap.yml",
"output": {
".html": {
"relative_path": "api/RageCoop.Client.CoopMap.html",
"hash": "ApXbPPfQzicGTsFcFPF6HEmZXemGkbp3ydNM04CvB+s="
"hash": "YNzCgE7KQWQPTJGSxetitmT6QG/2CXmz/gdmv3cY68s="
}
},
"is_incremental": false,
@ -63,6 +51,18 @@
"is_incremental": false,
"version": ""
},
{
"type": "ManagedReference",
"source_relative_path": "obj/api/RageCoop.Client.Map.yml",
"output": {
".html": {
"relative_path": "api/RageCoop.Client.Map.html",
"hash": "VmVDHWaovZQd41aDgeZZHqZhsu5U4J13K5UwCCsoatM="
}
},
"is_incremental": false,
"version": ""
},
{
"type": "ManagedReference",
"source_relative_path": "obj/api/RageCoop.Client.Scripting.API.Config.yml",
@ -117,7 +117,7 @@
"output": {
".html": {
"relative_path": "api/RageCoop.Client.Scripting.API.html",
"hash": "3vouttdhPT7hJ5jKvppmWkEG3dojHlSziwmO9fnUiM4="
"hash": "Ia+Sh3EBdepmbfJ+BGpzSBf6eKuA/n+d3gtuuWbWeFA="
}
},
"is_incremental": false,
@ -141,7 +141,7 @@
"output": {
".html": {
"relative_path": "api/RageCoop.Client.Scripting.ClientScript.html",
"hash": "b2p0FPsloqCjtvFEWfrPJOxhHTcvSb+0B8kV+eUg71k="
"hash": "N73yvdl0ubXKOzOi/yGMNG8u9t/xqzSSN4Jpkk81agE="
}
},
"is_incremental": false,
@ -177,7 +177,7 @@
"output": {
".html": {
"relative_path": "api/RageCoop.Client.Settings.html",
"hash": "+DDL1PelcoobBpmcXlRvNn69CsFwyaS8UQ6ph9IveAg="
"hash": "3znLfYhDtMnMnZtwPrZycmfJVDL6PlVBhAfiTgwPFBs="
}
},
"is_incremental": false,
@ -237,7 +237,7 @@
"output": {
".html": {
"relative_path": "api/RageCoop.Client.html",
"hash": "gG3KIry12mcDBVYt/bMSz1mU6aK9YAP8zUcUX/b4A8M="
"hash": "AMbF0zXRFnYwdn7WO+/SVe8eooUeMTjR7ozZOxHWzGY="
}
},
"is_incremental": false,
@ -321,7 +321,7 @@
"output": {
".html": {
"relative_path": "api/RageCoop.Server.Client.html",
"hash": "196mRFYrl2PSnrnVby5qjIdrrrlopjCBf0x/3qMl1kU="
"hash": "69W19KalHDH5dGJ/uCGVW3nIdmJxPVejA1JQaH5S65A="
}
},
"is_incremental": false,
@ -345,19 +345,7 @@
"output": {
".html": {
"relative_path": "api/RageCoop.Server.Scripting.API.html",
"hash": "pgIuWA6eyQjIZ84xMQVdEUXSkzOBV/iAfqFi6xQr2G4="
}
},
"is_incremental": false,
"version": ""
},
{
"type": "ManagedReference",
"source_relative_path": "obj/api/RageCoop.Server.Scripting.APIEvents.yml",
"output": {
".html": {
"relative_path": "api/RageCoop.Server.Scripting.APIEvents.html",
"hash": "/w/hZPH71+WPX9ha03bYmXAvWIwPiw0eeKxx5quz3Ws="
"hash": "VDClnRrNQDeUyHDlLMKHr1LRqviN0OCHiKxmJuc8fkc="
}
},
"is_incremental": false,
@ -435,6 +423,18 @@
"is_incremental": false,
"version": ""
},
{
"type": "ManagedReference",
"source_relative_path": "obj/api/RageCoop.Server.Scripting.ServerEvents.yml",
"output": {
".html": {
"relative_path": "api/RageCoop.Server.Scripting.ServerEvents.html",
"hash": "McBcrN54pUHpjR12BklFgPOqhS0UCxwUKsCuZrBsiKc="
}
},
"is_incremental": false,
"version": ""
},
{
"type": "ManagedReference",
"source_relative_path": "obj/api/RageCoop.Server.Scripting.ServerResource.yml",
@ -453,7 +453,7 @@
"output": {
".html": {
"relative_path": "api/RageCoop.Server.Scripting.ServerScript.html",
"hash": "gjH0sBJQgfR49Fh+jkE1VXfpfPd5CpggXRHIQTeLnWM="
"hash": "+WOGIL+kUdq0OA8WfW5ubzm1kDIizPbNhx36uRXjp0o="
}
},
"is_incremental": false,
@ -465,7 +465,7 @@
"output": {
".html": {
"relative_path": "api/RageCoop.Server.Scripting.html",
"hash": "0t5785EMzOpUn5q6LcuTvzgM2DgsQkOApYC6+Q9EXjc="
"hash": "/3wLFw/xx/dj3jj3zSpwT247r5JmANndoC59C1G8mWQ="
}
},
"is_incremental": false,
@ -483,13 +483,37 @@
"is_incremental": false,
"version": ""
},
{
"type": "ManagedReference",
"source_relative_path": "obj/api/RageCoop.Server.ServerEntities.yml",
"output": {
".html": {
"relative_path": "api/RageCoop.Server.ServerEntities.html",
"hash": "Y0OE2h706GJqCO4MWB1ZSpXNbng2uwUQ8n2pOwz1Hac="
}
},
"is_incremental": false,
"version": ""
},
{
"type": "ManagedReference",
"source_relative_path": "obj/api/RageCoop.Server.ServerObject.yml",
"output": {
".html": {
"relative_path": "api/RageCoop.Server.ServerObject.html",
"hash": "e2YLbgW8WsDPmuFRhZFOX2W2E972c5oy8okqkXf0uMI="
}
},
"is_incremental": false,
"version": ""
},
{
"type": "ManagedReference",
"source_relative_path": "obj/api/RageCoop.Server.ServerPed.yml",
"output": {
".html": {
"relative_path": "api/RageCoop.Server.ServerPed.html",
"hash": "QeEVh7ONgnzYiRLO8nBD5N/qNV89xcJHzHE8lqRM/q0="
"hash": "Nj4jArT3JTMihW4fsosizupSemIk3p3U806nMWfUQKE="
}
},
"is_incremental": false,
@ -501,7 +525,19 @@
"output": {
".html": {
"relative_path": "api/RageCoop.Server.ServerSettings.html",
"hash": "R4Q73a2azCJPZ6JGoHGeKudN/ksOzSk8sOfat1ia/+k="
"hash": "yDhZzdsJSauJbRUBMYqLcfGt1q1YyV5M41B/zNgW8gI="
}
},
"is_incremental": false,
"version": ""
},
{
"type": "ManagedReference",
"source_relative_path": "obj/api/RageCoop.Server.ServerVehicle.yml",
"output": {
".html": {
"relative_path": "api/RageCoop.Server.ServerVehicle.html",
"hash": "v+94Bus0VzLvu3LXRRUx3HSt21BQcJolGX9nm8FNmyw="
}
},
"is_incremental": false,
@ -513,7 +549,7 @@
"output": {
".html": {
"relative_path": "api/RageCoop.Server.html",
"hash": "LOSxQJbWgnvBUXDpxsvtof4nr9PvqiA5Fi3Z29HBFKs="
"hash": "mj01hIwqBkW53XAh3EZsurEbCjFajYL1wYvdrdH0nEY="
}
},
"is_incremental": false,
@ -525,7 +561,7 @@
"output": {
".html": {
"relative_path": "api/toc.html",
"hash": "PW61lPyS75NuahuDi8YLyx3EyYb0nvxJL/aewak5Sis="
"hash": "1JzSLOBQvWb4NM8OEoZv8OWAEzpFNGdYv+HJaX0XXBI="
}
},
"is_incremental": false,
@ -540,7 +576,7 @@
"output": {
".html": {
"relative_path": "toc.html",
"hash": "35U2H1EoDwqwkPz5UkLpx+SDxUt7yJCtoyC7zmUYWcw="
"hash": "IZVcaCvkW13AieUzohB67bBaEFumWzbslZp8aqQdEc8="
}
},
"is_incremental": false,
@ -550,23 +586,25 @@
"incremental_info": [
{
"status": {
"can_incremental": true,
"can_incremental": false,
"details": "Cannot build incrementally because last build info is missing.",
"incrementalPhase": "build",
"total_file_count": 0,
"skipped_file_count": 0
"skipped_file_count": 0,
"full_build_reason_code": "NoAvailableBuildCache"
},
"processors": {
"ConceptualDocumentProcessor": {
"can_incremental": true,
"can_incremental": false,
"incrementalPhase": "build",
"total_file_count": 2,
"skipped_file_count": 1
"skipped_file_count": 0
},
"ManagedReferenceDocumentProcessor": {
"can_incremental": true,
"can_incremental": false,
"incrementalPhase": "build",
"total_file_count": 40,
"skipped_file_count": 34
"total_file_count": 43,
"skipped_file_count": 0
},
"TocDocumentProcessor": {
"can_incremental": false,

2
docs/toc.html
View File

@ -19,7 +19,7 @@
<a href="README.html" name="" title="About">About</a>
</li>
<li>
<a href="api/RageCoop.Client.html" name="" title="API Documentation">API Documentation</a>
<a href="api/RageCoop.Client.Scripting.html" name="" title="API Documentation">API Documentation</a>
</li>
</ul>
</div>

437
docs/xrefmap.yml
View File

@ -7,25 +7,6 @@ references:
commentId: N:RageCoop.Client
fullName: RageCoop.Client
nameWithType: RageCoop.Client
- uid: RageCoop.Client.CoopMap
name: CoopMap
href: api/RageCoop.Client.CoopMap.html
commentId: T:RageCoop.Client.CoopMap
fullName: RageCoop.Client.CoopMap
nameWithType: CoopMap
- uid: RageCoop.Client.CoopMap.Props
name: Props
href: api/RageCoop.Client.CoopMap.html#RageCoop_Client_CoopMap_Props
commentId: P:RageCoop.Client.CoopMap.Props
fullName: RageCoop.Client.CoopMap.Props
nameWithType: CoopMap.Props
- uid: RageCoop.Client.CoopMap.Props*
name: Props
href: api/RageCoop.Client.CoopMap.html#RageCoop_Client_CoopMap_Props_
commentId: Overload:RageCoop.Client.CoopMap.Props
isSpec: "True"
fullName: RageCoop.Client.CoopMap.Props
nameWithType: CoopMap.Props
- uid: RageCoop.Client.CoopProp
name: CoopProp
href: api/RageCoop.Client.CoopProp.html
@ -97,6 +78,25 @@ references:
isSpec: "True"
fullName: RageCoop.Client.CoopProp.Texture
nameWithType: CoopProp.Texture
- uid: RageCoop.Client.Map
name: Map
href: api/RageCoop.Client.Map.html
commentId: T:RageCoop.Client.Map
fullName: RageCoop.Client.Map
nameWithType: Map
- uid: RageCoop.Client.Map.Props
name: Props
href: api/RageCoop.Client.Map.html#RageCoop_Client_Map_Props
commentId: P:RageCoop.Client.Map.Props
fullName: RageCoop.Client.Map.Props
nameWithType: Map.Props
- uid: RageCoop.Client.Map.Props*
name: Props
href: api/RageCoop.Client.Map.html#RageCoop_Client_Map_Props_
commentId: Overload:RageCoop.Client.Map.Props
isSpec: "True"
fullName: RageCoop.Client.Map.Props
nameWithType: Map.Props
- uid: RageCoop.Client.Scripting
name: RageCoop.Client.Scripting
href: api/RageCoop.Client.Scripting.html
@ -221,19 +221,6 @@ references:
commentId: E:RageCoop.Client.Scripting.API.Events.OnVehicleSpawned
fullName: RageCoop.Client.Scripting.API.Events.OnVehicleSpawned
nameWithType: API.Events.OnVehicleSpawned
- uid: RageCoop.Client.Scripting.API.GetLogger
name: GetLogger()
href: api/RageCoop.Client.Scripting.API.html#RageCoop_Client_Scripting_API_GetLogger
commentId: M:RageCoop.Client.Scripting.API.GetLogger
fullName: RageCoop.Client.Scripting.API.GetLogger()
nameWithType: API.GetLogger()
- uid: RageCoop.Client.Scripting.API.GetLogger*
name: GetLogger
href: api/RageCoop.Client.Scripting.API.html#RageCoop_Client_Scripting_API_GetLogger_
commentId: Overload:RageCoop.Client.Scripting.API.GetLogger
isSpec: "True"
fullName: RageCoop.Client.Scripting.API.GetLogger
nameWithType: API.GetLogger
- uid: RageCoop.Client.Scripting.API.IsChatFocused
name: IsChatFocused
href: api/RageCoop.Client.Scripting.API.html#RageCoop_Client_Scripting_API_IsChatFocused
@ -312,6 +299,19 @@ references:
isSpec: "True"
fullName: RageCoop.Client.Scripting.API.LocalPlayerID
nameWithType: API.LocalPlayerID
- uid: RageCoop.Client.Scripting.API.Logger
name: Logger
href: api/RageCoop.Client.Scripting.API.html#RageCoop_Client_Scripting_API_Logger
commentId: P:RageCoop.Client.Scripting.API.Logger
fullName: RageCoop.Client.Scripting.API.Logger
nameWithType: API.Logger
- uid: RageCoop.Client.Scripting.API.Logger*
name: Logger
href: api/RageCoop.Client.Scripting.API.html#RageCoop_Client_Scripting_API_Logger_
commentId: Overload:RageCoop.Client.Scripting.API.Logger
isSpec: "True"
fullName: RageCoop.Client.Scripting.API.Logger
nameWithType: API.Logger
- uid: RageCoop.Client.Scripting.API.QueueAction(System.Action)
name: QueueAction(Action)
href: api/RageCoop.Client.Scripting.API.html#RageCoop_Client_Scripting_API_QueueAction_System_Action_
@ -350,6 +350,15 @@ references:
fullName.vb: RageCoop.Client.Scripting.API.SendCustomEvent(System.Int32, System.Collections.Generic.List(Of System.Object))
nameWithType: API.SendCustomEvent(Int32, List<Object>)
nameWithType.vb: API.SendCustomEvent(Int32, List(Of Object))
- uid: RageCoop.Client.Scripting.API.SendCustomEvent(System.Int32,System.Object[])
name: SendCustomEvent(Int32, Object[])
href: api/RageCoop.Client.Scripting.API.html#RageCoop_Client_Scripting_API_SendCustomEvent_System_Int32_System_Object___
commentId: M:RageCoop.Client.Scripting.API.SendCustomEvent(System.Int32,System.Object[])
name.vb: SendCustomEvent(Int32, Object())
fullName: RageCoop.Client.Scripting.API.SendCustomEvent(System.Int32, System.Object[])
fullName.vb: RageCoop.Client.Scripting.API.SendCustomEvent(System.Int32, System.Object())
nameWithType: API.SendCustomEvent(Int32, Object[])
nameWithType.vb: API.SendCustomEvent(Int32, Object())
- uid: RageCoop.Client.Scripting.API.SendCustomEvent*
name: SendCustomEvent
href: api/RageCoop.Client.Scripting.API.html#RageCoop_Client_Scripting_API_SendCustomEvent_
@ -434,6 +443,19 @@ references:
isSpec: "True"
fullName: RageCoop.Client.Scripting.ClientScript.CurrentFile
nameWithType: ClientScript.CurrentFile
- uid: RageCoop.Client.Scripting.ClientScript.CurrentResource
name: CurrentResource
href: api/RageCoop.Client.Scripting.ClientScript.html#RageCoop_Client_Scripting_ClientScript_CurrentResource
commentId: P:RageCoop.Client.Scripting.ClientScript.CurrentResource
fullName: RageCoop.Client.Scripting.ClientScript.CurrentResource
nameWithType: ClientScript.CurrentResource
- uid: RageCoop.Client.Scripting.ClientScript.CurrentResource*
name: CurrentResource
href: api/RageCoop.Client.Scripting.ClientScript.html#RageCoop_Client_Scripting_ClientScript_CurrentResource_
commentId: Overload:RageCoop.Client.Scripting.ClientScript.CurrentResource
isSpec: "True"
fullName: RageCoop.Client.Scripting.ClientScript.CurrentResource
nameWithType: ClientScript.CurrentResource
- uid: RageCoop.Client.Scripting.ClientScript.OnStart
name: OnStart()
href: api/RageCoop.Client.Scripting.ClientScript.html#RageCoop_Client_Scripting_ClientScript_OnStart
@ -608,6 +630,19 @@ references:
isSpec: "True"
fullName: RageCoop.Client.Settings.Password
nameWithType: Settings.Password
- uid: RageCoop.Client.Settings.ResourceDirectory
name: ResourceDirectory
href: api/RageCoop.Client.Settings.html#RageCoop_Client_Settings_ResourceDirectory
commentId: P:RageCoop.Client.Settings.ResourceDirectory
fullName: RageCoop.Client.Settings.ResourceDirectory
nameWithType: Settings.ResourceDirectory
- uid: RageCoop.Client.Settings.ResourceDirectory*
name: ResourceDirectory
href: api/RageCoop.Client.Settings.html#RageCoop_Client_Settings_ResourceDirectory_
commentId: Overload:RageCoop.Client.Settings.ResourceDirectory
isSpec: "True"
fullName: RageCoop.Client.Settings.ResourceDirectory
nameWithType: Settings.ResourceDirectory
- uid: RageCoop.Client.Settings.Username
name: Username
href: api/RageCoop.Client.Settings.html#RageCoop_Client_Settings_Username
@ -1229,6 +1264,15 @@ references:
fullName.vb: RageCoop.Server.Client.SendCustomEvent(System.Int32, System.Collections.Generic.List(Of System.Object))
nameWithType: Client.SendCustomEvent(Int32, List<Object>)
nameWithType.vb: Client.SendCustomEvent(Int32, List(Of Object))
- uid: RageCoop.Server.Client.SendCustomEvent(System.Int32,System.Object[])
name: SendCustomEvent(Int32, Object[])
href: api/RageCoop.Server.Client.html#RageCoop_Server_Client_SendCustomEvent_System_Int32_System_Object___
commentId: M:RageCoop.Server.Client.SendCustomEvent(System.Int32,System.Object[])
name.vb: SendCustomEvent(Int32, Object())
fullName: RageCoop.Server.Client.SendCustomEvent(System.Int32, System.Object[])
fullName.vb: RageCoop.Server.Client.SendCustomEvent(System.Int32, System.Object())
nameWithType: Client.SendCustomEvent(Int32, Object[])
nameWithType.vb: Client.SendCustomEvent(Int32, Object())
- uid: RageCoop.Server.Client.SendCustomEvent*
name: SendCustomEvent
href: api/RageCoop.Server.Client.html#RageCoop_Server_Client_SendCustomEvent_
@ -1344,6 +1388,19 @@ references:
commentId: T:RageCoop.Server.Scripting.API
fullName: RageCoop.Server.Scripting.API
nameWithType: API
- uid: RageCoop.Server.Scripting.API.Entities
name: Entities
href: api/RageCoop.Server.Scripting.API.html#RageCoop_Server_Scripting_API_Entities
commentId: P:RageCoop.Server.Scripting.API.Entities
fullName: RageCoop.Server.Scripting.API.Entities
nameWithType: API.Entities
- uid: RageCoop.Server.Scripting.API.Entities*
name: Entities
href: api/RageCoop.Server.Scripting.API.html#RageCoop_Server_Scripting_API_Entities_
commentId: Overload:RageCoop.Server.Scripting.API.Entities
isSpec: "True"
fullName: RageCoop.Server.Scripting.API.Entities
nameWithType: API.Entities
- uid: RageCoop.Server.Scripting.API.Events
name: Events
href: api/RageCoop.Server.Scripting.API.html#RageCoop_Server_Scripting_API_Events
@ -1502,54 +1559,6 @@ references:
isSpec: "True"
fullName: RageCoop.Server.Scripting.API.SendCustomEvent
nameWithType: API.SendCustomEvent
- uid: RageCoop.Server.Scripting.APIEvents
name: APIEvents
href: api/RageCoop.Server.Scripting.APIEvents.html
commentId: T:RageCoop.Server.Scripting.APIEvents
fullName: RageCoop.Server.Scripting.APIEvents
nameWithType: APIEvents
- uid: RageCoop.Server.Scripting.APIEvents.OnChatMessage
name: OnChatMessage
href: api/RageCoop.Server.Scripting.APIEvents.html#RageCoop_Server_Scripting_APIEvents_OnChatMessage
commentId: E:RageCoop.Server.Scripting.APIEvents.OnChatMessage
fullName: RageCoop.Server.Scripting.APIEvents.OnChatMessage
nameWithType: APIEvents.OnChatMessage
- uid: RageCoop.Server.Scripting.APIEvents.OnCommandReceived
name: OnCommandReceived
href: api/RageCoop.Server.Scripting.APIEvents.html#RageCoop_Server_Scripting_APIEvents_OnCommandReceived
commentId: E:RageCoop.Server.Scripting.APIEvents.OnCommandReceived
fullName: RageCoop.Server.Scripting.APIEvents.OnCommandReceived
nameWithType: APIEvents.OnCommandReceived
- uid: RageCoop.Server.Scripting.APIEvents.OnPlayerConnected
name: OnPlayerConnected
href: api/RageCoop.Server.Scripting.APIEvents.html#RageCoop_Server_Scripting_APIEvents_OnPlayerConnected
commentId: E:RageCoop.Server.Scripting.APIEvents.OnPlayerConnected
fullName: RageCoop.Server.Scripting.APIEvents.OnPlayerConnected
nameWithType: APIEvents.OnPlayerConnected
- uid: RageCoop.Server.Scripting.APIEvents.OnPlayerDisconnected
name: OnPlayerDisconnected
href: api/RageCoop.Server.Scripting.APIEvents.html#RageCoop_Server_Scripting_APIEvents_OnPlayerDisconnected
commentId: E:RageCoop.Server.Scripting.APIEvents.OnPlayerDisconnected
fullName: RageCoop.Server.Scripting.APIEvents.OnPlayerDisconnected
nameWithType: APIEvents.OnPlayerDisconnected
- uid: RageCoop.Server.Scripting.APIEvents.OnPlayerHandshake
name: OnPlayerHandshake
href: api/RageCoop.Server.Scripting.APIEvents.html#RageCoop_Server_Scripting_APIEvents_OnPlayerHandshake
commentId: E:RageCoop.Server.Scripting.APIEvents.OnPlayerHandshake
fullName: RageCoop.Server.Scripting.APIEvents.OnPlayerHandshake
nameWithType: APIEvents.OnPlayerHandshake
- uid: RageCoop.Server.Scripting.APIEvents.OnPlayerReady
name: OnPlayerReady
href: api/RageCoop.Server.Scripting.APIEvents.html#RageCoop_Server_Scripting_APIEvents_OnPlayerReady
commentId: E:RageCoop.Server.Scripting.APIEvents.OnPlayerReady
fullName: RageCoop.Server.Scripting.APIEvents.OnPlayerReady
nameWithType: APIEvents.OnPlayerReady
- uid: RageCoop.Server.Scripting.APIEvents.OnPlayerUpdate
name: OnPlayerUpdate
href: api/RageCoop.Server.Scripting.APIEvents.html#RageCoop_Server_Scripting_APIEvents_OnPlayerUpdate
commentId: E:RageCoop.Server.Scripting.APIEvents.OnPlayerUpdate
fullName: RageCoop.Server.Scripting.APIEvents.OnPlayerUpdate
nameWithType: APIEvents.OnPlayerUpdate
- uid: RageCoop.Server.Scripting.ChatEventArgs
name: ChatEventArgs
href: api/RageCoop.Server.Scripting.ChatEventArgs.html
@ -1846,6 +1855,54 @@ references:
isSpec: "True"
fullName: RageCoop.Server.Scripting.OnCommandEventArgs.Sender
nameWithType: OnCommandEventArgs.Sender
- uid: RageCoop.Server.Scripting.ServerEvents
name: ServerEvents
href: api/RageCoop.Server.Scripting.ServerEvents.html
commentId: T:RageCoop.Server.Scripting.ServerEvents
fullName: RageCoop.Server.Scripting.ServerEvents
nameWithType: ServerEvents
- uid: RageCoop.Server.Scripting.ServerEvents.OnChatMessage
name: OnChatMessage
href: api/RageCoop.Server.Scripting.ServerEvents.html#RageCoop_Server_Scripting_ServerEvents_OnChatMessage
commentId: E:RageCoop.Server.Scripting.ServerEvents.OnChatMessage
fullName: RageCoop.Server.Scripting.ServerEvents.OnChatMessage
nameWithType: ServerEvents.OnChatMessage
- uid: RageCoop.Server.Scripting.ServerEvents.OnCommandReceived
name: OnCommandReceived
href: api/RageCoop.Server.Scripting.ServerEvents.html#RageCoop_Server_Scripting_ServerEvents_OnCommandReceived
commentId: E:RageCoop.Server.Scripting.ServerEvents.OnCommandReceived
fullName: RageCoop.Server.Scripting.ServerEvents.OnCommandReceived
nameWithType: ServerEvents.OnCommandReceived
- uid: RageCoop.Server.Scripting.ServerEvents.OnPlayerConnected
name: OnPlayerConnected
href: api/RageCoop.Server.Scripting.ServerEvents.html#RageCoop_Server_Scripting_ServerEvents_OnPlayerConnected
commentId: E:RageCoop.Server.Scripting.ServerEvents.OnPlayerConnected
fullName: RageCoop.Server.Scripting.ServerEvents.OnPlayerConnected
nameWithType: ServerEvents.OnPlayerConnected
- uid: RageCoop.Server.Scripting.ServerEvents.OnPlayerDisconnected
name: OnPlayerDisconnected
href: api/RageCoop.Server.Scripting.ServerEvents.html#RageCoop_Server_Scripting_ServerEvents_OnPlayerDisconnected
commentId: E:RageCoop.Server.Scripting.ServerEvents.OnPlayerDisconnected
fullName: RageCoop.Server.Scripting.ServerEvents.OnPlayerDisconnected
nameWithType: ServerEvents.OnPlayerDisconnected
- uid: RageCoop.Server.Scripting.ServerEvents.OnPlayerHandshake
name: OnPlayerHandshake
href: api/RageCoop.Server.Scripting.ServerEvents.html#RageCoop_Server_Scripting_ServerEvents_OnPlayerHandshake
commentId: E:RageCoop.Server.Scripting.ServerEvents.OnPlayerHandshake
fullName: RageCoop.Server.Scripting.ServerEvents.OnPlayerHandshake
nameWithType: ServerEvents.OnPlayerHandshake
- uid: RageCoop.Server.Scripting.ServerEvents.OnPlayerReady
name: OnPlayerReady
href: api/RageCoop.Server.Scripting.ServerEvents.html#RageCoop_Server_Scripting_ServerEvents_OnPlayerReady
commentId: E:RageCoop.Server.Scripting.ServerEvents.OnPlayerReady
fullName: RageCoop.Server.Scripting.ServerEvents.OnPlayerReady
nameWithType: ServerEvents.OnPlayerReady
- uid: RageCoop.Server.Scripting.ServerEvents.OnPlayerUpdate
name: OnPlayerUpdate
href: api/RageCoop.Server.Scripting.ServerEvents.html#RageCoop_Server_Scripting_ServerEvents_OnPlayerUpdate
commentId: E:RageCoop.Server.Scripting.ServerEvents.OnPlayerUpdate
fullName: RageCoop.Server.Scripting.ServerEvents.OnPlayerUpdate
nameWithType: ServerEvents.OnPlayerUpdate
- uid: RageCoop.Server.Scripting.ServerResource
name: ServerResource
href: api/RageCoop.Server.Scripting.ServerResource.html
@ -2039,6 +2096,109 @@ references:
isSpec: "True"
fullName: RageCoop.Server.Server.Stop
nameWithType: Server.Stop
- uid: RageCoop.Server.ServerEntities
name: ServerEntities
href: api/RageCoop.Server.ServerEntities.html
commentId: T:RageCoop.Server.ServerEntities
fullName: RageCoop.Server.ServerEntities
nameWithType: ServerEntities
- uid: RageCoop.Server.ServerEntities.GetAllObjects
name: GetAllObjects()
href: api/RageCoop.Server.ServerEntities.html#RageCoop_Server_ServerEntities_GetAllObjects
commentId: M:RageCoop.Server.ServerEntities.GetAllObjects
fullName: RageCoop.Server.ServerEntities.GetAllObjects()
nameWithType: ServerEntities.GetAllObjects()
- uid: RageCoop.Server.ServerEntities.GetAllObjects*
name: GetAllObjects
href: api/RageCoop.Server.ServerEntities.html#RageCoop_Server_ServerEntities_GetAllObjects_
commentId: Overload:RageCoop.Server.ServerEntities.GetAllObjects
isSpec: "True"
fullName: RageCoop.Server.ServerEntities.GetAllObjects
nameWithType: ServerEntities.GetAllObjects
- uid: RageCoop.Server.ServerEntities.GetAllPeds
name: GetAllPeds()
href: api/RageCoop.Server.ServerEntities.html#RageCoop_Server_ServerEntities_GetAllPeds
commentId: M:RageCoop.Server.ServerEntities.GetAllPeds
fullName: RageCoop.Server.ServerEntities.GetAllPeds()
nameWithType: ServerEntities.GetAllPeds()
- uid: RageCoop.Server.ServerEntities.GetAllPeds*
name: GetAllPeds
href: api/RageCoop.Server.ServerEntities.html#RageCoop_Server_ServerEntities_GetAllPeds_
commentId: Overload:RageCoop.Server.ServerEntities.GetAllPeds
isSpec: "True"
fullName: RageCoop.Server.ServerEntities.GetAllPeds
nameWithType: ServerEntities.GetAllPeds
- uid: RageCoop.Server.ServerEntities.GetAllVehicle
name: GetAllVehicle()
href: api/RageCoop.Server.ServerEntities.html#RageCoop_Server_ServerEntities_GetAllVehicle
commentId: M:RageCoop.Server.ServerEntities.GetAllVehicle
fullName: RageCoop.Server.ServerEntities.GetAllVehicle()
nameWithType: ServerEntities.GetAllVehicle()
- uid: RageCoop.Server.ServerEntities.GetAllVehicle*
name: GetAllVehicle
href: api/RageCoop.Server.ServerEntities.html#RageCoop_Server_ServerEntities_GetAllVehicle_
commentId: Overload:RageCoop.Server.ServerEntities.GetAllVehicle
isSpec: "True"
fullName: RageCoop.Server.ServerEntities.GetAllVehicle
nameWithType: ServerEntities.GetAllVehicle
- uid: RageCoop.Server.ServerObject
name: ServerObject
href: api/RageCoop.Server.ServerObject.html
commentId: T:RageCoop.Server.ServerObject
fullName: RageCoop.Server.ServerObject
nameWithType: ServerObject
- uid: RageCoop.Server.ServerObject.IsInvincible
name: IsInvincible
href: api/RageCoop.Server.ServerObject.html#RageCoop_Server_ServerObject_IsInvincible
commentId: P:RageCoop.Server.ServerObject.IsInvincible
fullName: RageCoop.Server.ServerObject.IsInvincible
nameWithType: ServerObject.IsInvincible
- uid: RageCoop.Server.ServerObject.IsInvincible*
name: IsInvincible
href: api/RageCoop.Server.ServerObject.html#RageCoop_Server_ServerObject_IsInvincible_
commentId: Overload:RageCoop.Server.ServerObject.IsInvincible
isSpec: "True"
fullName: RageCoop.Server.ServerObject.IsInvincible
nameWithType: ServerObject.IsInvincible
- uid: RageCoop.Server.ServerObject.Model
name: Model
href: api/RageCoop.Server.ServerObject.html#RageCoop_Server_ServerObject_Model
commentId: P:RageCoop.Server.ServerObject.Model
fullName: RageCoop.Server.ServerObject.Model
nameWithType: ServerObject.Model
- uid: RageCoop.Server.ServerObject.Model*
name: Model
href: api/RageCoop.Server.ServerObject.html#RageCoop_Server_ServerObject_Model_
commentId: Overload:RageCoop.Server.ServerObject.Model
isSpec: "True"
fullName: RageCoop.Server.ServerObject.Model
nameWithType: ServerObject.Model
- uid: RageCoop.Server.ServerObject.Position
name: Position
href: api/RageCoop.Server.ServerObject.html#RageCoop_Server_ServerObject_Position
commentId: P:RageCoop.Server.ServerObject.Position
fullName: RageCoop.Server.ServerObject.Position
nameWithType: ServerObject.Position
- uid: RageCoop.Server.ServerObject.Position*
name: Position
href: api/RageCoop.Server.ServerObject.html#RageCoop_Server_ServerObject_Position_
commentId: Overload:RageCoop.Server.ServerObject.Position
isSpec: "True"
fullName: RageCoop.Server.ServerObject.Position
nameWithType: ServerObject.Position
- uid: RageCoop.Server.ServerObject.Quaternion
name: Quaternion
href: api/RageCoop.Server.ServerObject.html#RageCoop_Server_ServerObject_Quaternion
commentId: P:RageCoop.Server.ServerObject.Quaternion
fullName: RageCoop.Server.ServerObject.Quaternion
nameWithType: ServerObject.Quaternion
- uid: RageCoop.Server.ServerObject.Quaternion*
name: Quaternion
href: api/RageCoop.Server.ServerObject.html#RageCoop_Server_ServerObject_Quaternion_
commentId: Overload:RageCoop.Server.ServerObject.Quaternion
isSpec: "True"
fullName: RageCoop.Server.ServerObject.Quaternion
nameWithType: ServerObject.Quaternion
- uid: RageCoop.Server.ServerPed
name: ServerPed
href: api/RageCoop.Server.ServerPed.html
@ -2071,6 +2231,32 @@ references:
isSpec: "True"
fullName: RageCoop.Server.ServerPed.ID
nameWithType: ServerPed.ID
- uid: RageCoop.Server.ServerPed.IsPlayer
name: IsPlayer
href: api/RageCoop.Server.ServerPed.html#RageCoop_Server_ServerPed_IsPlayer
commentId: P:RageCoop.Server.ServerPed.IsPlayer
fullName: RageCoop.Server.ServerPed.IsPlayer
nameWithType: ServerPed.IsPlayer
- uid: RageCoop.Server.ServerPed.IsPlayer*
name: IsPlayer
href: api/RageCoop.Server.ServerPed.html#RageCoop_Server_ServerPed_IsPlayer_
commentId: Overload:RageCoop.Server.ServerPed.IsPlayer
isSpec: "True"
fullName: RageCoop.Server.ServerPed.IsPlayer
nameWithType: ServerPed.IsPlayer
- uid: RageCoop.Server.ServerPed.LastVehicle
name: LastVehicle
href: api/RageCoop.Server.ServerPed.html#RageCoop_Server_ServerPed_LastVehicle
commentId: P:RageCoop.Server.ServerPed.LastVehicle
fullName: RageCoop.Server.ServerPed.LastVehicle
nameWithType: ServerPed.LastVehicle
- uid: RageCoop.Server.ServerPed.LastVehicle*
name: LastVehicle
href: api/RageCoop.Server.ServerPed.html#RageCoop_Server_ServerPed_LastVehicle_
commentId: Overload:RageCoop.Server.ServerPed.LastVehicle
isSpec: "True"
fullName: RageCoop.Server.ServerPed.LastVehicle
nameWithType: ServerPed.LastVehicle
- uid: RageCoop.Server.ServerPed.Owner
name: Owner
href: api/RageCoop.Server.ServerPed.html#RageCoop_Server_ServerPed_Owner
@ -2097,19 +2283,19 @@ references:
isSpec: "True"
fullName: RageCoop.Server.ServerPed.Position
nameWithType: ServerPed.Position
- uid: RageCoop.Server.ServerPed.VehicleID
name: VehicleID
href: api/RageCoop.Server.ServerPed.html#RageCoop_Server_ServerPed_VehicleID
commentId: P:RageCoop.Server.ServerPed.VehicleID
fullName: RageCoop.Server.ServerPed.VehicleID
nameWithType: ServerPed.VehicleID
- uid: RageCoop.Server.ServerPed.VehicleID*
name: VehicleID
href: api/RageCoop.Server.ServerPed.html#RageCoop_Server_ServerPed_VehicleID_
commentId: Overload:RageCoop.Server.ServerPed.VehicleID
- uid: RageCoop.Server.ServerPed.Rotation
name: Rotation
href: api/RageCoop.Server.ServerPed.html#RageCoop_Server_ServerPed_Rotation
commentId: P:RageCoop.Server.ServerPed.Rotation
fullName: RageCoop.Server.ServerPed.Rotation
nameWithType: ServerPed.Rotation
- uid: RageCoop.Server.ServerPed.Rotation*
name: Rotation
href: api/RageCoop.Server.ServerPed.html#RageCoop_Server_ServerPed_Rotation_
commentId: Overload:RageCoop.Server.ServerPed.Rotation
isSpec: "True"
fullName: RageCoop.Server.ServerPed.VehicleID
nameWithType: ServerPed.VehicleID
fullName: RageCoop.Server.ServerPed.Rotation
nameWithType: ServerPed.Rotation
- uid: RageCoop.Server.ServerSettings
name: ServerSettings
href: api/RageCoop.Server.ServerSettings.html
@ -2132,7 +2318,14 @@ references:
- uid: RageCoop.Server.ServerSettings.LogLevel
name: LogLevel
href: api/RageCoop.Server.ServerSettings.html#RageCoop_Server_ServerSettings_LogLevel
commentId: F:RageCoop.Server.ServerSettings.LogLevel
commentId: P:RageCoop.Server.ServerSettings.LogLevel
fullName: RageCoop.Server.ServerSettings.LogLevel
nameWithType: ServerSettings.LogLevel
- uid: RageCoop.Server.ServerSettings.LogLevel*
name: LogLevel
href: api/RageCoop.Server.ServerSettings.html#RageCoop_Server_ServerSettings_LogLevel_
commentId: Overload:RageCoop.Server.ServerSettings.LogLevel
isSpec: "True"
fullName: RageCoop.Server.ServerSettings.LogLevel
nameWithType: ServerSettings.LogLevel
- uid: RageCoop.Server.ServerSettings.MasterServer
@ -2239,3 +2432,61 @@ references:
isSpec: "True"
fullName: RageCoop.Server.ServerSettings.WelcomeMessage
nameWithType: ServerSettings.WelcomeMessage
- uid: RageCoop.Server.ServerVehicle
name: ServerVehicle
href: api/RageCoop.Server.ServerVehicle.html
commentId: T:RageCoop.Server.ServerVehicle
fullName: RageCoop.Server.ServerVehicle
nameWithType: ServerVehicle
- uid: RageCoop.Server.ServerVehicle.ID
name: ID
href: api/RageCoop.Server.ServerVehicle.html#RageCoop_Server_ServerVehicle_ID
commentId: P:RageCoop.Server.ServerVehicle.ID
fullName: RageCoop.Server.ServerVehicle.ID
nameWithType: ServerVehicle.ID
- uid: RageCoop.Server.ServerVehicle.ID*
name: ID
href: api/RageCoop.Server.ServerVehicle.html#RageCoop_Server_ServerVehicle_ID_
commentId: Overload:RageCoop.Server.ServerVehicle.ID
isSpec: "True"
fullName: RageCoop.Server.ServerVehicle.ID
nameWithType: ServerVehicle.ID
- uid: RageCoop.Server.ServerVehicle.Owner
name: Owner
href: api/RageCoop.Server.ServerVehicle.html#RageCoop_Server_ServerVehicle_Owner
commentId: P:RageCoop.Server.ServerVehicle.Owner
fullName: RageCoop.Server.ServerVehicle.Owner
nameWithType: ServerVehicle.Owner
- uid: RageCoop.Server.ServerVehicle.Owner*
name: Owner
href: api/RageCoop.Server.ServerVehicle.html#RageCoop_Server_ServerVehicle_Owner_
commentId: Overload:RageCoop.Server.ServerVehicle.Owner
isSpec: "True"
fullName: RageCoop.Server.ServerVehicle.Owner
nameWithType: ServerVehicle.Owner
- uid: RageCoop.Server.ServerVehicle.Position
name: Position
href: api/RageCoop.Server.ServerVehicle.html#RageCoop_Server_ServerVehicle_Position
commentId: P:RageCoop.Server.ServerVehicle.Position
fullName: RageCoop.Server.ServerVehicle.Position
nameWithType: ServerVehicle.Position
- uid: RageCoop.Server.ServerVehicle.Position*
name: Position
href: api/RageCoop.Server.ServerVehicle.html#RageCoop_Server_ServerVehicle_Position_
commentId: Overload:RageCoop.Server.ServerVehicle.Position
isSpec: "True"
fullName: RageCoop.Server.ServerVehicle.Position
nameWithType: ServerVehicle.Position
- uid: RageCoop.Server.ServerVehicle.Quaternion
name: Quaternion
href: api/RageCoop.Server.ServerVehicle.html#RageCoop_Server_ServerVehicle_Quaternion
commentId: P:RageCoop.Server.ServerVehicle.Quaternion
fullName: RageCoop.Server.ServerVehicle.Quaternion
nameWithType: ServerVehicle.Quaternion
- uid: RageCoop.Server.ServerVehicle.Quaternion*
name: Quaternion
href: api/RageCoop.Server.ServerVehicle.html#RageCoop_Server_ServerVehicle_Quaternion_
commentId: Overload:RageCoop.Server.ServerVehicle.Quaternion
isSpec: "True"
fullName: RageCoop.Server.ServerVehicle.Quaternion
nameWithType: ServerVehicle.Quaternion

75
index.md
View File

@ -1,7 +1,12 @@
# Getting started
Here you can learn how to create your first resource
## Resources and Scripts
A **Script** stands for class that inherits from RageCoop's script class ( [ServerScript](api/RageCoop.Server.Scripting.ServerScript.html) and [ClientScript](api/RageCoop.Client.Scripting.ClientScript.html) ) and will be loaded at runtime, one assembly can have multiple scripts in it.
A **Resource** consists of one or more assemblies and other files. Server-side resource will be loaded at startup and is isolated from other resources, while client-side resource will be sent to each client and loaded after they connected to the server. A **Resource** can either be in a folder or packed inside a zip archive.
## Directory structure
@ -9,6 +14,7 @@ Below is the server's directory structure
```
ServerRoot
│ Settings.xml
| RageCoop.Server.exe
│
└───Resources
└───Server
@ -23,38 +29,47 @@ ServerRoot
└───Temp
```
### Settings.xml
This file will be generated first time you started the, you can change the server's configuration option by editing it, refer to [this](api/RageCoop.Server.ServerSettings.html) for detailed description.
### Resources
Each directory or zip in represents one resource, which consists of several dlls, and is isolated from another resource.
This file will be generated first time you started the server, you can then change the server's configuration option by editing it, refer to [ServerSettings](api/RageCoop.Server.ServerSettings.html) for detailed description.
## Server Reource
The resource will be running at server side, here's how to create one:
To create a server resource:
1. Create a C# class library project targeting .NET 6.0.
2. Add reference to **RageCoop.Server.dll** and **RageCoop.Core.dll**.
3. Add following namespace(s):
```
using RageCoop.Server.Scripting;
// Optional
using RageCoop.Server;
using RageCoop.Core.Scripting;
using RageCoop.Core;
```
```
using RageCoop.Server.Scripting;
// Optional
using RageCoop.Server;
using RageCoop.Core.Scripting;
using RageCoop.Core;
```
4. Inherit a class from [ServerScript](api/RageCoop.Server.Scripting.ServerScript.html).
5. Implement `OnStart()` and `OnStop()`:
```
public class MyFirstResource :ServerScript
{
public override void OnStart()
{
// Initiate your script here
}
public override void OnStop()
{
// Free all resources and perform cleanup
}
}
```
6. That's it! Now you can have some fun by using the [API](api/RageCoop.Server.Scripting.API.html) instance, please refer to the [GiHub](https://github.com/RAGECOOP/GTAV-RESOURCES) for more examples.
5. Implement `OnStart()` and `OnStop()`, your cs file should look like this:
```
using RageCoop.Server.Scripting;
namespace NiceGuy.MyFirstResource
{
public class Main : ServerScript
{
public override void OnStart()
{
// Initiate your script here
}
public override void OnStop()
{
// Free all resources and perform cleanup
}
}
}
```
6. Now you can have some fun by using the [API](api/RageCoop.Server.Scripting.API.html) instance, please refer to the [GitHub repo](https://github.com/RAGECOOP/GTAV-RESOURCES) for more examples.
7. For convenience, you can create a symlink in `ServerRoot/Resources/Server/NiceGuy.MyFirstResource` targeting your output folder:
```
mklink /d ServerRoot/Resources/Server/NiceGuy.MyFirstResource C:/MyRepos/NiceGuy.MyFirstResource/bin/Debug
```
8. That's it! Start your server and you should see your resource loading.

2
toc.yml
View File

@ -3,4 +3,4 @@
- name: About
href: README.md
- name: API Documentation
href: api/RageCoop.Client.html
href: api/RageCoop.Client.Scripting.html