@@ -6,8 +6,8 @@ The character stores information that is relevant to the gameplay, but not speci
6
6
All characters that a player owns are loaded into server memory upon the client connecting.
7
7
8
8
## Methods
9
- ???+ realm-server "<a id =Character:save ></a >Character: save (callback)"
10
- ##### sv_Character : save {#charactersave}
9
+ ??? realm-server "<a id =Character:save ></a >Character: save (callback)"
10
+ ##### Character : save {#charactersave}
11
11
Saves the character to the database and calls the callback if provided.
12
12
<h3 >Parameters:</h3 >
13
13
<span class =" types " ><span class =" type " >function</span ></span >
@@ -16,8 +16,8 @@ All characters that a player owns are loaded into server memory upon the client
16
16
17
17
18
18
19
- ???+ realm-server "<a id =Character:sync ></a >Character: sync (receiver)"
20
- ##### sv_Character : sync {#charactersync}
19
+ ??? realm-server "<a id =Character:sync ></a >Character: sync (receiver)"
20
+ ##### Character : sync {#charactersync}
21
21
Sends character information to the receiver.
22
22
<h3 >Parameters:</h3 >
23
23
<span class =" types " ><span class =" type " >Client</span ></span >
@@ -27,8 +27,8 @@ All characters that a player owns are loaded into server memory upon the client
27
27
28
28
29
29
30
- ???+ realm-server "<a id =Character:setup ></a >Character: setup (noNetworking)"
31
- ##### sv_Character : setup {#charactersetup}
30
+ ??? realm-server "<a id =Character:setup ></a >Character: setup (noNetworking)"
31
+ ##### Character : setup {#charactersetup}
32
32
Sets up the "appearance" related information for the character.
33
33
<h3 >Parameters:</h3 >
34
34
<span class =" types " ><span class =" type " >boolean</span ></span >
@@ -37,12 +37,12 @@ All characters that a player owns are loaded into server memory upon the client
37
37
38
38
39
39
40
- ???+ realm-server "<a id =Character:kick ></a >Character: kick ()"
41
- ##### sv_Character : kick {#characterkick}
40
+ ??? realm-server "<a id =Character:kick ></a >Character: kick ()"
41
+ ##### Character : kick {#characterkick}
42
42
Forces the player to choose a character.
43
43
44
- ???+ realm-server "<a id =Character:ban ></a >Character: ban (time)"
45
- ##### sv_Character : ban {#characterban}
44
+ ??? realm-server "<a id =Character:ban ></a >Character: ban (time)"
45
+ ##### Character : ban {#characterban}
46
46
Prevents the use of this character permanently or for a certain amount of time.
47
47
<h3 >Parameters:</h3 >
48
48
<span class =" types " ><span class =" type " >integer</span ></span >
@@ -58,18 +58,18 @@ All characters that a player owns are loaded into server memory upon the client
58
58
59
59
```
60
60
</ul>
61
- ???+ realm-server "<a id =Character:delete ></a >Character: delete ()"
62
- ##### sv_Character : delete {#characterdelete}
61
+ ??? realm-server "<a id =Character:delete ></a >Character: delete ()"
62
+ ##### Character : delete {#characterdelete}
63
63
Deletes this character from existence along with its associated data.
64
64
65
- ???+ realm-server "<a id =Character:destroy ></a >Character: destroy ()"
66
- ##### sv_Character : destroy {#characterdestroy}
65
+ ??? realm-server "<a id =Character:destroy ></a >Character: destroy ()"
66
+ ##### Character : destroy {#characterdestroy}
67
67
!!! warning "Internal"
68
68
This is used internally - although you're able to use it you probably shouldn't.
69
69
Deletes this character from memory.
70
70
71
- ???+ realm-shared "<a id =Character:getPlayer ></a >Character: getPlayer ()"
72
- ##### sh_Character : getPlayer {#charactergetplayer}
71
+ ??? realm-shared "<a id =Character:getPlayer ></a >Character: getPlayer ()"
72
+ ##### Character : getPlayer {#charactergetplayer}
73
73
Returns which player owns this character.
74
74
<h3 >Returns:</h3 >
75
75
<span class =" types " ><span class =" type " >player</span ></span >
@@ -87,8 +87,8 @@ All characters that a player owns are loaded into server memory upon the client
87
87
</ul>
88
88
## Class-related methods
89
89
90
- ???+ realm-shared "<a id =Character:joinClass ></a >Character: joinClass (class, isForced)"
91
- ##### sh_Character : joinClass {#characterjoinclass}
90
+ ??? realm-shared "<a id =Character:joinClass ></a >Character: joinClass (class, isForced)"
91
+ ##### Character : joinClass {#characterjoinclass}
92
92
Makes a character join a class
93
93
<h3 >Parameters:</h3 >
94
94
<span class =" types " ><span class =" type " >number</span ></span >
@@ -107,14 +107,14 @@ All characters that a player owns are loaded into server memory upon the client
107
107
108
108
109
109
110
- ???+ realm-shared "<a id =Character:kickClass ></a >Character: kickClass ()"
111
- ##### sh_Character : kickClass {#characterkickclass}
110
+ ??? realm-shared "<a id =Character:kickClass ></a >Character: kickClass ()"
111
+ ##### Character : kickClass {#characterkickclass}
112
112
Removes character from current class (joins default)
113
113
114
114
## Currency-related methods
115
115
116
- ???+ realm-shared "<a id =Character:hasMoney ></a >Character: hasMoney (amount)"
117
- ##### sh_Character : hasMoney {#characterhasmoney}
116
+ ??? realm-shared "<a id =Character:hasMoney ></a >Character: hasMoney (amount)"
117
+ ##### Character : hasMoney {#characterhasmoney}
118
118
Checks if character has sufficient funds
119
119
<h3 >Parameters:</h3 >
120
120
<span class =" types " ><span class =" type " >number</span ></span >
@@ -128,8 +128,8 @@ All characters that a player owns are loaded into server memory upon the client
128
128
129
129
130
130
131
- ???+ realm-shared "<a id =Character:giveMoney ></a >Character: giveMoney (amount, takingMoney)"
132
- ##### sh_Character : giveMoney {#charactergivemoney}
131
+ ??? realm-shared "<a id =Character:giveMoney ></a >Character: giveMoney (amount, takingMoney)"
132
+ ##### Character : giveMoney {#charactergivemoney}
133
133
Gives money to character
134
134
<h3 >Parameters:</h3 >
135
135
<span class =" types " ><span class =" type " >number</span ></span >
@@ -148,8 +148,8 @@ All characters that a player owns are loaded into server memory upon the client
148
148
149
149
150
150
151
- ???+ realm-shared "<a id =Character:takeMoney ></a >Character: takeMoney (amount)"
152
- ##### sh_Character : takeMoney {#charactertakemoney}
151
+ ??? realm-shared "<a id =Character:takeMoney ></a >Character: takeMoney (amount)"
152
+ ##### Character : takeMoney {#charactertakemoney}
153
153
Takes money from character
154
154
<h3 >Parameters:</h3 >
155
155
<span class =" types " ><span class =" type " >number</span ></span >
@@ -165,8 +165,8 @@ All characters that a player owns are loaded into server memory upon the client
165
165
166
166
## Flag-related methods
167
167
168
- ???+ realm-server "<a id =Character:setFlags ></a >Character: setFlags (flags)"
169
- ##### sv_Character : setFlags {#charactersetflags}
168
+ ??? realm-server "<a id =Character:setFlags ></a >Character: setFlags (flags)"
169
+ ##### Character : setFlags {#charactersetflags}
170
170
Set the flag data to the character, overriding existing flags
171
171
<h3 >Parameters:</h3 >
172
172
<span class =" types " ><a class =" type " href =" https://www.lua.org/manual/5.1/manual.html#5.4 " >string</a ></span >
@@ -175,8 +175,8 @@ All characters that a player owns are loaded into server memory upon the client
175
175
176
176
177
177
178
- ???+ realm-server "<a id =Character:takeFlags ></a >Character: takeFlags (flags)"
179
- ##### sv_Character : takeFlags {#charactertakeflags}
178
+ ??? realm-server "<a id =Character:takeFlags ></a >Character: takeFlags (flags)"
179
+ ##### Character : takeFlags {#charactertakeflags}
180
180
Remove the flags from the character.
181
181
<h3 >Parameters:</h3 >
182
182
<span class =" types " ><a class =" type " href =" https://www.lua.org/manual/5.1/manual.html#5.4 " >string</a ></span >
@@ -185,17 +185,17 @@ All characters that a player owns are loaded into server memory upon the client
185
185
186
186
187
187
188
- ???+ realm-shared "<a id =Character:getFlags ></a >Character: getFlags ()"
189
- ##### sh_Character : getFlags {#charactergetflags}
188
+ ??? realm-shared "<a id =Character:getFlags ></a >Character: getFlags ()"
189
+ ##### Character : getFlags {#charactergetflags}
190
190
Gets character's current flags.
191
191
<h3 >Returns:</h3 >
192
192
<span class =" types " ><a class =" type " href =" https://www.lua.org/manual/5.1/manual.html#5.4 " >string</a ></span >
193
193
Current flags string
194
194
195
195
196
196
197
- ???+ realm-shared "<a id =Character:hasFlags ></a >Character: hasFlags (flags)"
198
- ##### sh_Character : hasFlags {#characterhasflags}
197
+ ??? realm-shared "<a id =Character:hasFlags ></a >Character: hasFlags (flags)"
198
+ ##### Character : hasFlags {#characterhasflags}
199
199
Check if the character contains the flags specified.
200
200
<h3 >Parameters:</h3 >
201
201
<span class =" types " ><a class =" type " href =" https://www.lua.org/manual/5.1/manual.html#5.4 " >string</a ></span >
0 commit comments