Skip to content

Commit 16358c9

Browse files
fix aliases and section names
1 parent ce991ee commit 16358c9

File tree

3 files changed

+18
-23
lines changed

3 files changed

+18
-23
lines changed

docs/developer/classes/Character.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@ The character stores information that is relevant to the gameplay, but not speci
44

55
All characters that a player owns are loaded into server memory upon the client connecting.
66

7-
## Functions
8-
???+ realm-server "<a id=CHAR:save></a>CHAR:save (callback)"
9-
##### sv_CHAR:save {#charsave}
7+
## Methods
8+
???+ realm-server "<a id=character:save></a>character:save (callback)"
9+
##### sv_character:save {#charactersave}
1010
Saves the character to the database and calls the callback if provided.
1111
<h3>Parameters:</h3>
1212
<span class="types"><span class="type">function</span></span>
@@ -15,8 +15,8 @@ All characters that a player owns are loaded into server memory upon the client
1515

1616

1717

18-
???+ realm-server "<a id=CHAR:sync></a>CHAR:sync (receiver)"
19-
##### sv_CHAR:sync {#charsync}
18+
???+ realm-server "<a id=character:sync></a>character:sync (receiver)"
19+
##### sv_character:sync {#charactersync}
2020
Sends character information to the receiver.
2121
<h3>Parameters:</h3>
2222
<span class="types"><a class="type" href="../Client#">Client</a></span>
@@ -26,8 +26,8 @@ All characters that a player owns are loaded into server memory upon the client
2626

2727

2828

29-
???+ realm-server "<a id=CHAR:setup></a>CHAR:setup (noNetworking)"
30-
##### sv_CHAR:setup {#charsetup}
29+
???+ realm-server "<a id=character:setup></a>character:setup (noNetworking)"
30+
##### sv_character:setup {#charactersetup}
3131
Sets up the "appearance" related information for the character.
3232
<h3>Parameters:</h3>
3333
<span class="types"><span class="type">boolean</span></span>
@@ -36,12 +36,12 @@ All characters that a player owns are loaded into server memory upon the client
3636

3737

3838

39-
???+ realm-server "<a id=CHAR:kick></a>CHAR:kick ()"
40-
##### sv_CHAR:kick {#charkick}
39+
???+ realm-server "<a id=character:kick></a>character:kick ()"
40+
##### sv_character:kick {#characterkick}
4141
Forces the player to choose a character.
4242

43-
???+ realm-server "<a id=CHAR:ban></a>CHAR:ban (time)"
44-
##### sv_CHAR:ban {#charban}
43+
???+ realm-server "<a id=character:ban></a>character:ban (time)"
44+
##### sv_character:ban {#characterban}
4545
Prevents the use of this character permanently or for a certain amount of time.
4646
<h3>Parameters:</h3>
4747
<span class="types"><span class="type">integer</span></span>
@@ -57,18 +57,18 @@ All characters that a player owns are loaded into server memory upon the client
5757

5858
```
5959
</ul>
60-
???+ realm-server "<a id=CHAR:delete></a>CHAR:delete ()"
61-
##### sv_CHAR:delete {#chardelete}
60+
???+ realm-server "<a id=character:delete></a>character:delete ()"
61+
##### sv_character:delete {#characterdelete}
6262
Deletes this character from existence along with its associated data.
6363

64-
???+ realm-server "<a id=CHAR:destroy></a>CHAR:destroy ()"
65-
##### sv_CHAR:destroy {#chardestroy}
64+
???+ realm-server "<a id=character:destroy></a>character:destroy ()"
65+
##### sv_character:destroy {#characterdestroy}
6666
!!! warning "Internal"
6767
This is used internally - although you're able to use it you probably shouldn't.
6868
Deletes this character from memory.
6969

70-
???+ realm-shared "<a id=CHAR:getPlayer></a>CHAR:getPlayer ()"
71-
##### sh_CHAR:getPlayer {#chargetplayer}
70+
???+ realm-shared "<a id=character:getPlayer></a>character:getPlayer ()"
71+
##### sh_character:getPlayer {#charactergetplayer}
7272
Returns which player owns this character.
7373
<h3>Returns:</h3>
7474
<span class="types"><span class="type">player</span></span>

docs/developer/classes/Client.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ The client, aka the [Player](https://wiki.facepunch.com/gmod/Player), represents
44
A client can have more than one character attached, but a character can have no more and no less than 1 client attached.
55

66
Functions and meta-methods defined in Gmod outside of NutScript typically target the client.
7-
## Functions
7+
## Methods
88
???+ realm-shared "<a id=client:dummy2></a>client:dummy2 ()"
99
##### sh_client:dummy2 {#clientdummy2}
1010
dummy func2

docs/developer/classes/Inventory.md

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,6 @@ Base inventory class.
22
The inventory object stores items, typically in a grid via the GridInv plugin. Alternatively, a simple inventory, without a grid system, is available with the SimpleInv plugin.
33
Typically, each Character has their own inventory, however an inventory can also be tied to a world object/prop (such as with the storage plugin), or an item (such as bags).
44

5-
## Functions
6-
???+ realm-shared "<a id=inv:dummy3></a>inv:dummy3 ()"
7-
##### sh_inv:dummy3 {#invdummy3}
8-
dummy func3
9-
105
## Methods
116
???+ realm-shared "<a id=inventory:getData></a>inventory:getData (key, default)"
127
##### sh_inventory:getData {#inventorygetdata}

0 commit comments

Comments
 (0)