-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathRageCoop.Server.Scripting.ServerScript.html
290 lines (263 loc) · 12.6 KB
/
RageCoop.Server.Scripting.ServerScript.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Class ServerScript
| RageCoop resource documentation </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class ServerScript
| 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.ServerScript">
<h1 id="RageCoop_Server_Scripting_ServerScript" data-uid="RageCoop.Server.Scripting.ServerScript" class="text-break">Class ServerScript
</h1>
<div class="markdown level0 summary"><p>Inherit from this class, constructor will be called automatically, but other scripts might have yet been loaded and <a class="xref" href="RageCoop.Server.Scripting.ServerScript.html#RageCoop_Server_Scripting_ServerScript_API">API</a> will be null, you should use <a class="xref" href="RageCoop.Server.Scripting.ServerScript.html#RageCoop_Server_Scripting_ServerScript_OnStart">OnStart()</a>. to initiate your script.</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">ServerScript</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_ServerScript_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public abstract class ServerScript</code></pre>
</div>
<h3 id="properties">Properties
</h3>
<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.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>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public API API { 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="RageCoop.Server.Scripting.API.html">API</a></td>
<td></td>
</tr>
</tbody>
</table>
<a id="RageCoop_Server_Scripting_ServerScript_CurrentFile_" data-uid="RageCoop.Server.Scripting.ServerScript.CurrentFile*"></a>
<h4 id="RageCoop_Server_Scripting_ServerScript_CurrentFile" data-uid="RageCoop.Server.Scripting.ServerScript.CurrentFile">CurrentFile</h4>
<div class="markdown level1 summary"><p>Get the <a class="xref" href="RageCoop.Core.Scripting.ResourceFile.html">ResourceFile</a> that the 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 ResourceFile CurrentFile { 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.Core.Scripting.ResourceFile.html">ResourceFile</a></td>
<td></td>
</tr>
</tbody>
</table>
<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> 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>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public ServerResource 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.Server.Scripting.ServerResource.html">ServerResource</a></td>
<td></td>
</tr>
</tbody>
</table>
<a id="RageCoop_Server_Scripting_ServerScript_Logger_" data-uid="RageCoop.Server.Scripting.ServerScript.Logger*"></a>
<h4 id="RageCoop_Server_Scripting_ServerScript_Logger" data-uid="RageCoop.Server.Scripting.ServerScript.Logger">Logger</h4>
<div class="markdown level1 summary"><p>Eqivalent of <a class="xref" href="RageCoop.Server.Scripting.ServerResource.html#RageCoop_Server_Scripting_ServerResource_Logger">Logger</a> in <a class="xref" href="RageCoop.Server.Scripting.ServerScript.html#RageCoop_Server_Scripting_ServerScript_CurrentResource">CurrentResource</a></p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Logger Logger { 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.Core.Logger.html">Logger</a></td>
<td></td>
</tr>
</tbody>
</table>
<h3 id="methods">Methods
</h3>
<a id="RageCoop_Server_Scripting_ServerScript_OnStart_" data-uid="RageCoop.Server.Scripting.ServerScript.OnStart*"></a>
<h4 id="RageCoop_Server_Scripting_ServerScript_OnStart" data-uid="RageCoop.Server.Scripting.ServerScript.OnStart">OnStart()</h4>
<div class="markdown level1 summary"><p>This method would be called from listener thread after all scripts 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 abstract void OnStart()</code></pre>
</div>
<a id="RageCoop_Server_Scripting_ServerScript_OnStop_" data-uid="RageCoop.Server.Scripting.ServerScript.OnStop*"></a>
<h4 id="RageCoop_Server_Scripting_ServerScript_OnStop" data-uid="RageCoop.Server.Scripting.ServerScript.OnStop">OnStop()</h4>
<div class="markdown level1 summary"><p>This method would be called from listener thread when the server is shutting down, you MUST terminate all background jobs/threads in this method.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public abstract void OnStop()</code></pre>
</div>
</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>