Skip to content

Commit e94506a

Browse files
have the admons closed by default
1 parent e5deb91 commit e94506a

29 files changed

+659
-659
lines changed

docs/developer/classes/Character.md

Lines changed: 34 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ The character stores information that is relevant to the gameplay, but not speci
66
All characters that a player owns are loaded into server memory upon the client connecting.
77

88
## 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}
1111
Saves the character to the database and calls the callback if provided.
1212
<h3>Parameters:</h3>
1313
<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
1616

1717

1818

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}
2121
Sends character information to the receiver.
2222
<h3>Parameters:</h3>
2323
<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
2727

2828

2929

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}
3232
Sets up the "appearance" related information for the character.
3333
<h3>Parameters:</h3>
3434
<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
3737

3838

3939

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}
4242
Forces the player to choose a character.
4343

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}
4646
Prevents the use of this character permanently or for a certain amount of time.
4747
<h3>Parameters:</h3>
4848
<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
5858

5959
```
6060
</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}
6363
Deletes this character from existence along with its associated data.
6464

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}
6767
!!! warning "Internal"
6868
This is used internally - although you're able to use it you probably shouldn't.
6969
Deletes this character from memory.
7070

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}
7373
Returns which player owns this character.
7474
<h3>Returns:</h3>
7575
<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
8787
</ul>
8888
## Class-related methods
8989

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}
9292
Makes a character join a class
9393
<h3>Parameters:</h3>
9494
<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
107107

108108

109109

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}
112112
Removes character from current class (joins default)
113113

114114
## Currency-related methods
115115

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}
118118
Checks if character has sufficient funds
119119
<h3>Parameters:</h3>
120120
<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
128128

129129

130130

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}
133133
Gives money to character
134134
<h3>Parameters:</h3>
135135
<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
148148

149149

150150

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}
153153
Takes money from character
154154
<h3>Parameters:</h3>
155155
<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
165165

166166
## Flag-related methods
167167

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}
170170
Set the flag data to the character, overriding existing flags
171171
<h3>Parameters:</h3>
172172
<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
175175

176176

177177

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}
180180
Remove the flags from the character.
181181
<h3>Parameters:</h3>
182182
<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
185185

186186

187187

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}
190190
Gets character's current flags.
191191
<h3>Returns:</h3>
192192
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
193193
Current flags string
194194

195195

196196

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}
199199
Check if the character contains the flags specified.
200200
<h3>Parameters:</h3>
201201
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>

0 commit comments

Comments
 (0)