Skip to content

Commit 23f6371

Browse files
committed
Update docs
1 parent 0a4505c commit 23f6371

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

41 files changed

+1429
-993
lines changed
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,13 @@ lua:
1212
function: ExecuteThink
1313
realm: shared
1414
description: "Think."
15-
15+
1616
arguments:
1717
- position: 1
1818
name: "entity"
1919
type: Entity
2020
returns:
21-
21+
2222
---
2323

2424
<div class="lua__search__keywords">

docs/classes/Entity/SetModel.md

Lines changed: 0 additions & 30 deletions
This file was deleted.

docs/classes/Entity/SetParent.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,11 @@ lua:
2020
- position: 2
2121
name: "parent"
2222
type: Entity
23+
default: "NULL"
2324
- position: 3
2425
name: "attachment"
2526
type: number
26-
default: "0"
27+
default: "-1"
2728
returns:
2829

2930
---

docs/classes/Entity/SetUseType.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ lua:
1919
type: Entity
2020
- position: 2
2121
name: "useType"
22-
type: unknown
22+
type: enumeration/USABILITY_TYPE
2323
returns:
2424

2525
---
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
template: lua-class-function.html
3+
title: IsValid
4+
icon: lua-shared
5+
tags:
6+
- lua
7+
- shared
8+
- needs-verification
9+
- needs-example
10+
lua:
11+
library: PhysicsObject
12+
function: IsValid
13+
realm: shared
14+
description: "Check if physics object is valid."
15+
16+
arguments:
17+
- position: 1
18+
name: "physicsObject"
19+
type: PhysicsObject
20+
returns:
21+
22+
---
23+
24+
<div class="lua__search__keywords">
25+
PhysicsObject:IsValid &#x2013; Check if physics object is valid.
26+
</div>
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
template: lua-class-function.html
3+
title: GetAvoidPlayers
4+
icon: lua-shared
5+
tags:
6+
- lua
7+
- shared
8+
- needs-verification
9+
- needs-example
10+
lua:
11+
library: Player
12+
function: GetAvoidPlayers
13+
realm: shared
14+
description: "Get whether to push away players in the same team."
15+
16+
arguments:
17+
- position: 1
18+
name: "entity"
19+
type: Player
20+
returns:
21+
- type: boolean
22+
description: "Whether to push away players in the same team"
23+
---
24+
25+
<div class="lua__search__keywords">
26+
Player:GetAvoidPlayers &#x2013; Get whether to push away players in the same team.
27+
</div>

docs/classes/Player/GetMaxArmor.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
template: lua-class-function.html
3+
title: GetMaxArmor
4+
icon: lua-shared
5+
tags:
6+
- lua
7+
- shared
8+
- needs-verification
9+
- needs-example
10+
lua:
11+
library: Player
12+
function: GetMaxArmor
13+
realm: shared
14+
description: "Get the max armor for this player."
15+
16+
arguments:
17+
- position: 1
18+
name: "entity"
19+
type: Player
20+
returns:
21+
- type: integer
22+
description: "The maximum armor"
23+
---
24+
25+
<div class="lua__search__keywords">
26+
Player:GetMaxArmor &#x2013; Get the max armor for this player.
27+
</div>
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
template: lua-class-function.html
3+
title: RunConsoleCommand
4+
icon: lua-server
5+
tags:
6+
- lua
7+
- server
8+
- needs-verification
9+
- needs-example
10+
lua:
11+
library: Player
12+
function: RunConsoleCommand
13+
realm: server
14+
description: "Mimics that client typing the command at the console."
15+
16+
arguments:
17+
- position: 1
18+
name: "player"
19+
type: Player
20+
- position: 2
21+
name: "command"
22+
type: string
23+
returns:
24+
25+
---
26+
27+
<div class="lua__search__keywords">
28+
Player:RunConsoleCommand &#x2013; Mimics that client typing the command at the console.
29+
</div>

docs/classes/Player/SetArmor.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
template: lua-class-function.html
3+
title: SetArmor
4+
icon: lua-server
5+
tags:
6+
- lua
7+
- server
8+
- needs-verification
9+
- needs-example
10+
lua:
11+
library: Player
12+
function: SetArmor
13+
realm: server
14+
description: "Sets the armor value for a player."
15+
16+
arguments:
17+
- position: 1
18+
name: "player"
19+
type: Player
20+
- position: 2
21+
name: "armorValue"
22+
type: number
23+
returns:
24+
25+
---
26+
27+
<div class="lua__search__keywords">
28+
Player:SetArmor &#x2013; Sets the armor value for a player.
29+
</div>
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
template: lua-class-function.html
3+
title: SetAvoidPlayers
4+
icon: lua-shared
5+
tags:
6+
- lua
7+
- shared
8+
- needs-verification
9+
- needs-example
10+
lua:
11+
library: Player
12+
function: SetAvoidPlayers
13+
realm: shared
14+
description: "Set whether to push away players in the same team. The pushing away is handled client-side."
15+
16+
arguments:
17+
- position: 1
18+
name: "entity"
19+
type: Player
20+
- position: 2
21+
name: "shouldAvoidPlayers"
22+
type: boolean
23+
returns:
24+
25+
---
26+
27+
<div class="lua__search__keywords">
28+
Player:SetAvoidPlayers &#x2013; Set whether to push away players in the same team. The pushing away is handled client-side.
29+
</div>

0 commit comments

Comments
 (0)