+AudioChannel:Get3dEnabled – Gets whether 3D sound is enabled for the audio channel
+
diff --git a/docs/classes/AudioChannel/Get3dFadeDistance.md b/docs/classes/AudioChannel/Get3dFadeDistance.md
new file mode 100644
index 0000000000..ffb8e8558b
--- /dev/null
+++ b/docs/classes/AudioChannel/Get3dFadeDistance.md
@@ -0,0 +1,29 @@
+---
+template: lua-class-function.html
+title: Get3dFadeDistance
+icon: lua-shared
+tags:
+ - lua
+ - shared
+ - needs-verification
+ - needs-example
+lua:
+ library: AudioChannel
+ function: Get3dFadeDistance
+ realm: shared
+ description: "Gets the 3D fade distance of the audio channel"
+
+ arguments:
+ - position: 1
+ name: "audioChannel"
+ type: AudioChannel
+ returns:
+ - type: number
+ description: "The minimum fade distance of the audio channel"
+ - type: number
+ description: "The maximum fade distance of the audio channel"
+---
+
+
+AudioChannel:Get3dFadeDistance – Gets the 3D fade distance of the audio channel
+
diff --git a/docs/classes/AudioChannel/GetAverageBitRate.md b/docs/classes/AudioChannel/GetAverageBitRate.md
new file mode 100644
index 0000000000..a5093e066b
--- /dev/null
+++ b/docs/classes/AudioChannel/GetAverageBitRate.md
@@ -0,0 +1,27 @@
+---
+template: lua-class-function.html
+title: GetAverageBitRate
+icon: lua-shared
+tags:
+ - lua
+ - shared
+ - needs-verification
+ - needs-example
+lua:
+ library: AudioChannel
+ function: GetAverageBitRate
+ realm: shared
+ description: "Gets the average bit rate of the audio channel"
+
+ arguments:
+ - position: 1
+ name: "audioChannel"
+ type: AudioChannel
+ returns:
+ - type: number
+ description: "The average bit rate of the audio channel"
+---
+
+
+AudioChannel:GetAverageBitRate – Gets the average bit rate of the audio channel
+
diff --git a/docs/classes/AudioChannel/GetBitsPerSample.md b/docs/classes/AudioChannel/GetBitsPerSample.md
new file mode 100644
index 0000000000..1b0cfd811a
--- /dev/null
+++ b/docs/classes/AudioChannel/GetBitsPerSample.md
@@ -0,0 +1,27 @@
+---
+template: lua-class-function.html
+title: GetBitsPerSample
+icon: lua-shared
+tags:
+ - lua
+ - shared
+ - needs-verification
+ - needs-example
+lua:
+ library: AudioChannel
+ function: GetBitsPerSample
+ realm: shared
+ description: "Gets the bits per sample of the audio channel (not properly implemented, always returns 0)"
+
+ arguments:
+ - position: 1
+ name: "audioChannel"
+ type: AudioChannel
+ returns:
+ - type: number
+ description: "The bits per sample of the audio channel"
+---
+
+
+AudioChannel:GetBitsPerSample – Gets the bits per sample of the audio channel (not properly implemented, always returns 0)
+
diff --git a/docs/classes/AudioChannel/GetBufferedTime.md b/docs/classes/AudioChannel/GetBufferedTime.md
new file mode 100644
index 0000000000..e9d045e168
--- /dev/null
+++ b/docs/classes/AudioChannel/GetBufferedTime.md
@@ -0,0 +1,27 @@
+---
+template: lua-class-function.html
+title: GetBufferedTime
+icon: lua-shared
+tags:
+ - lua
+ - shared
+ - needs-verification
+ - needs-example
+lua:
+ library: AudioChannel
+ function: GetBufferedTime
+ realm: shared
+ description: "Gets the buffered time of the audio channel"
+
+ arguments:
+ - position: 1
+ name: "audioChannel"
+ type: AudioChannel
+ returns:
+ - type: number
+ description: "The buffered time of the audio channel"
+---
+
+
+AudioChannel:GetFft – Gets the Discrete Fourier Transform of the audio channel
+
diff --git a/docs/classes/AudioChannel/GetLength.md b/docs/classes/AudioChannel/GetLength.md
new file mode 100644
index 0000000000..78afa48dad
--- /dev/null
+++ b/docs/classes/AudioChannel/GetLength.md
@@ -0,0 +1,27 @@
+---
+template: lua-class-function.html
+title: GetLength
+icon: lua-shared
+tags:
+ - lua
+ - shared
+ - needs-verification
+ - needs-example
+lua:
+ library: AudioChannel
+ function: GetLength
+ realm: shared
+ description: "Gets the length of the audio channel"
+
+ arguments:
+ - position: 1
+ name: "audioChannel"
+ type: AudioChannel
+ returns:
+ - type: number
+ description: "The length of the audio channel"
+---
+
+
+AudioChannel:IsBlockStreamed – Gets whether the audio channel is block streamed
+
diff --git a/docs/classes/AudioChannel/IsLooping.md b/docs/classes/AudioChannel/IsLooping.md
new file mode 100644
index 0000000000..e9696eb622
--- /dev/null
+++ b/docs/classes/AudioChannel/IsLooping.md
@@ -0,0 +1,27 @@
+---
+template: lua-class-function.html
+title: IsLooping
+icon: lua-shared
+tags:
+ - lua
+ - shared
+ - needs-verification
+ - needs-example
+lua:
+ library: AudioChannel
+ function: IsLooping
+ realm: shared
+ description: "Gets whether the audio channel is looping"
+
+ arguments:
+ - position: 1
+ name: "audioChannel"
+ type: AudioChannel
+ returns:
+ - type: boolean
+ description: "Whether the audio channel is looping"
+---
+
+
+AudioChannel:IsValid – Gets whether the audio channel is valid (Not properly implemented, returns true if not stopped)
+
diff --git a/docs/classes/AudioChannel/Pause.md b/docs/classes/AudioChannel/Pause.md
new file mode 100644
index 0000000000..6abc775f48
--- /dev/null
+++ b/docs/classes/AudioChannel/Pause.md
@@ -0,0 +1,26 @@
+---
+template: lua-class-function.html
+title: Pause
+icon: lua-shared
+tags:
+ - lua
+ - shared
+ - needs-verification
+ - needs-example
+lua:
+ library: AudioChannel
+ function: Pause
+ realm: shared
+ description: "Pauses the audio channel"
+
+ arguments:
+ - position: 1
+ name: "audioChannel"
+ type: AudioChannel
+ returns:
+
+---
+
+
+AudioChannel:Set3dEnabled – Sets whether 3D sound is enabled for the audio channel
+
diff --git a/docs/classes/AudioChannel/Set3dFadeDistance.md b/docs/classes/AudioChannel/Set3dFadeDistance.md
new file mode 100644
index 0000000000..aea45be201
--- /dev/null
+++ b/docs/classes/AudioChannel/Set3dFadeDistance.md
@@ -0,0 +1,32 @@
+---
+template: lua-class-function.html
+title: Set3dFadeDistance
+icon: lua-shared
+tags:
+ - lua
+ - shared
+ - needs-verification
+ - needs-example
+lua:
+ library: AudioChannel
+ function: Set3dFadeDistance
+ realm: shared
+ description: "Sets the 3D fade distance of the audio channel"
+
+ arguments:
+ - position: 1
+ name: "audioChannel"
+ type: AudioChannel
+ - position: 2
+ name: "min"
+ type: number
+ - position: 3
+ name: "max"
+ type: number
+ returns:
+
+---
+
+
+AudioChannel:Set3dFadeDistance – Sets the 3D fade distance of the audio channel
+
diff --git a/docs/classes/AudioChannel/SetLooping.md b/docs/classes/AudioChannel/SetLooping.md
new file mode 100644
index 0000000000..e52d6ba9e4
--- /dev/null
+++ b/docs/classes/AudioChannel/SetLooping.md
@@ -0,0 +1,29 @@
+---
+template: lua-class-function.html
+title: SetLooping
+icon: lua-shared
+tags:
+ - lua
+ - shared
+ - needs-verification
+ - needs-example
+lua:
+ library: AudioChannel
+ function: SetLooping
+ realm: shared
+ description: "Sets whether the audio channel is looping"
+
+ arguments:
+ - position: 1
+ name: "audioChannel"
+ type: AudioChannel
+ - position: 2
+ name: "enable"
+ type: boolean
+ returns:
+
+---
+
+
+AudioChannel:__gc – Called when the audio channel is garbage collected. Cleans up the audio channel so it can't be reused and memory is freed.
+
diff --git a/docs/classes/AudioChannel/index.md b/docs/classes/AudioChannel/index.md
new file mode 100644
index 0000000000..f3c5090937
--- /dev/null
+++ b/docs/classes/AudioChannel/index.md
@@ -0,0 +1,10 @@
+---
+template: lua-index.html
+childrenTitle: Methods
+include:
+ startsWith: classes/AudioChannel/
+exclude:
+ isIndex: true
+---
+
+# AudioChannel
diff --git a/docs/classes/Button/CanBeDefaultButton.md b/docs/classes/Button/CanBeDefaultButton.md
index fee58447d4..448ec283c0 100644
--- a/docs/classes/Button/CanBeDefaultButton.md
+++ b/docs/classes/Button/CanBeDefaultButton.md
@@ -13,7 +13,10 @@ lua:
realm: client
description: "Returns whether the button can be the default button"
-
+ arguments:
+ - position: 1
+ name: "button"
+ type: Button
returns:
- type: boolean
description: "Returns whether the button can be the default button"
diff --git a/docs/classes/Button/DoClick.md b/docs/classes/Button/DoClick.md
index 680d3a6d19..3c809c25a5 100644
--- a/docs/classes/Button/DoClick.md
+++ b/docs/classes/Button/DoClick.md
@@ -13,7 +13,10 @@ lua:
realm: client
description: "Simulates a click on the button"
-
+ arguments:
+ - position: 1
+ name: "button"
+ type: Button
returns:
---
diff --git a/docs/classes/Button/DrawFocusBox.md b/docs/classes/Button/DrawFocusBox.md
index f4e96f0b96..1f811ae777 100644
--- a/docs/classes/Button/DrawFocusBox.md
+++ b/docs/classes/Button/DrawFocusBox.md
@@ -14,8 +14,12 @@ lua:
description: "Draws the focus box"
arguments:
- - name: "shouldDraw"
- type: boolean
+ - position: 1
+ name: "button"
+ type: Button
+ - position: 2
+ name: "shouldDraw"
+ type: boolean
returns:
---
diff --git a/docs/classes/Button/FireActionSignal.md b/docs/classes/Button/FireActionSignal.md
index d7e7908b69..090919092a 100644
--- a/docs/classes/Button/FireActionSignal.md
+++ b/docs/classes/Button/FireActionSignal.md
@@ -13,7 +13,10 @@ lua:
realm: client
description: "Fires the action signal"
-
+ arguments:
+ - position: 1
+ name: "button"
+ type: Button
returns:
---
diff --git a/docs/classes/Button/ForceDepressed.md b/docs/classes/Button/ForceDepressed.md
index 7c87334183..30790067ae 100644
--- a/docs/classes/Button/ForceDepressed.md
+++ b/docs/classes/Button/ForceDepressed.md
@@ -14,8 +14,12 @@ lua:
description: "Forces the button to be depressed"
arguments:
- - name: "depressed"
- type: boolean
+ - position: 1
+ name: "button"
+ type: Button
+ - position: 2
+ name: "depressed"
+ type: boolean
returns:
---
diff --git a/docs/classes/Button/GetButtonBackgroundColor.md b/docs/classes/Button/GetButtonBackgroundColor.md
index febf8c90a1..c254930692 100644
--- a/docs/classes/Button/GetButtonBackgroundColor.md
+++ b/docs/classes/Button/GetButtonBackgroundColor.md
@@ -13,7 +13,10 @@ lua:
realm: client
description: "Returns the button's background color"
-
+ arguments:
+ - position: 1
+ name: "button"
+ type: Button
returns:
- type: Color
description: "Returns the button's background color"
diff --git a/docs/classes/Button/GetButtonForegroundColor.md b/docs/classes/Button/GetButtonForegroundColor.md
index c8c48f77e3..2190f1229d 100644
--- a/docs/classes/Button/GetButtonForegroundColor.md
+++ b/docs/classes/Button/GetButtonForegroundColor.md
@@ -13,7 +13,10 @@ lua:
realm: client
description: "Returns the button's foreground color"
-
+ arguments:
+ - position: 1
+ name: "button"
+ type: Button
returns:
- type: Color
description: "Returns the button's foreground color"
diff --git a/docs/classes/Button/GetPanelBaseClassName.md b/docs/classes/Button/GetPanelBaseClassName.md
deleted file mode 100644
index 3e69ad25c2..0000000000
--- a/docs/classes/Button/GetPanelBaseClassName.md
+++ /dev/null
@@ -1,25 +0,0 @@
----
-template: lua-class-function.html
-title: GetPanelBaseClassName
-icon: lua-client
-tags:
- - lua
- - client
- - needs-verification
- - needs-example
-lua:
- library: Button
- function: GetPanelBaseClassName
- realm: client
- description: "Gets the base class name of the panel"
-
- static: true
-
- returns:
- - type: string
- description: "The base class name of the panel"
----
-
-
-ConsoleVariable:GetInt – Gets the value of the ConsoleVariable as an integer
+ConsoleVariable:GetInteger – Gets the value of the ConsoleVariable as an integer
diff --git a/docs/classes/ConsoleVariable/GetMax.md b/docs/classes/ConsoleVariable/GetMax.md
index af405bc874..1eabd1fa78 100644
--- a/docs/classes/ConsoleVariable/GetMax.md
+++ b/docs/classes/ConsoleVariable/GetMax.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Gets the maximum value of the ConsoleVariable"
-
+ arguments:
+ - position: 1
+ name: "consoleVariable"
+ type: ConsoleVariable
returns:
- type: boolean, number
description: "Gets the maximum value of the ConsoleVariable"
diff --git a/docs/classes/ConsoleVariable/GetMin.md b/docs/classes/ConsoleVariable/GetMin.md
index 8248efb61b..67ba023cb6 100644
--- a/docs/classes/ConsoleVariable/GetMin.md
+++ b/docs/classes/ConsoleVariable/GetMin.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Gets the minimum value of the ConsoleVariable"
-
+ arguments:
+ - position: 1
+ name: "consoleVariable"
+ type: ConsoleVariable
returns:
- type: boolean, number
description: "Gets the minimum value of the ConsoleVariable"
diff --git a/docs/classes/ConsoleVariable/GetName.md b/docs/classes/ConsoleVariable/GetName.md
index eaf6357922..f24112357c 100644
--- a/docs/classes/ConsoleVariable/GetName.md
+++ b/docs/classes/ConsoleVariable/GetName.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Gets the name of the ConsoleVariable"
-
+ arguments:
+ - position: 1
+ name: "consoleVariable"
+ type: ConsoleVariable
returns:
- type: string
description: "Gets the name of the ConsoleVariable"
diff --git a/docs/classes/ConsoleVariable/GetString.md b/docs/classes/ConsoleVariable/GetString.md
index a70de81bfd..18d44c028c 100644
--- a/docs/classes/ConsoleVariable/GetString.md
+++ b/docs/classes/ConsoleVariable/GetString.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Gets the value of the ConsoleVariable as a string"
-
+ arguments:
+ - position: 1
+ name: "consoleVariable"
+ type: ConsoleVariable
returns:
- type: string
description: "Gets the value of the ConsoleVariable as a string"
diff --git a/docs/classes/ConsoleVariable/IsCommand.md b/docs/classes/ConsoleVariable/IsCommand.md
index 61afafd391..e73076272e 100644
--- a/docs/classes/ConsoleVariable/IsCommand.md
+++ b/docs/classes/ConsoleVariable/IsCommand.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Whether the ConsoleVariable is a command (and not a ConsoleVariable)"
-
+ arguments:
+ - position: 1
+ name: "consoleVariable"
+ type: ConsoleVariable
returns:
- type: boolean
description: "Whether the ConsoleVariable is a command (and not a ConsoleVariable)"
diff --git a/docs/classes/ConsoleVariable/IsFlagSet.md b/docs/classes/ConsoleVariable/IsFlagSet.md
index dcb57f29c5..cd3ee81d4d 100644
--- a/docs/classes/ConsoleVariable/IsFlagSet.md
+++ b/docs/classes/ConsoleVariable/IsFlagSet.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Whether the ConsoleVariable has a flag set"
-
+ arguments:
+ - position: 1
+ name: "consoleVariable"
+ type: ConsoleVariable
returns:
- type: boolean
description: "Whether the ConsoleVariable has a flag set"
diff --git a/docs/classes/ConsoleVariable/IsRegistered.md b/docs/classes/ConsoleVariable/IsRegistered.md
index e9e736b1d5..ecd1fb5b4c 100644
--- a/docs/classes/ConsoleVariable/IsRegistered.md
+++ b/docs/classes/ConsoleVariable/IsRegistered.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Whether the ConsoleVariable is registered"
-
+ arguments:
+ - position: 1
+ name: "consoleVariable"
+ type: ConsoleVariable
returns:
- type: boolean
description: "Whether the ConsoleVariable is registered"
diff --git a/docs/classes/ConsoleVariable/IsValid.md b/docs/classes/ConsoleVariable/IsValid.md
index 3208727843..d8374be357 100644
--- a/docs/classes/ConsoleVariable/IsValid.md
+++ b/docs/classes/ConsoleVariable/IsValid.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Whether the ConsoleVariable is valid"
-
+ arguments:
+ - position: 1
+ name: "consoleVariable"
+ type: ConsoleVariable
returns:
- type: boolean
description: "Whether the ConsoleVariable is valid"
diff --git a/docs/classes/ConsoleVariable/Revert.md b/docs/classes/ConsoleVariable/Revert.md
index ba21d2d9cc..30a3528340 100644
--- a/docs/classes/ConsoleVariable/Revert.md
+++ b/docs/classes/ConsoleVariable/Revert.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Reverts the ConsoleVariable to its default value"
-
+ arguments:
+ - position: 1
+ name: "consoleVariable"
+ type: ConsoleVariable
returns:
---
diff --git a/docs/classes/ConsoleVariable/SetValue.md b/docs/classes/ConsoleVariable/SetValue.md
index 74acd716db..3da6647753 100644
--- a/docs/classes/ConsoleVariable/SetValue.md
+++ b/docs/classes/ConsoleVariable/SetValue.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Sets the value of the ConsoleVariable"
-
+ arguments:
+ - position: 1
+ name: "consoleVariable"
+ type: ConsoleVariable
returns:
---
diff --git a/docs/classes/ConsoleVariable/__tostring.md b/docs/classes/ConsoleVariable/__tostring.md
index 0e5b281ba6..d13c6d3e03 100644
--- a/docs/classes/ConsoleVariable/__tostring.md
+++ b/docs/classes/ConsoleVariable/__tostring.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Returns a string representation of the ConsoleVariable"
-
+ arguments:
+ - position: 1
+ name: "consoleVariable"
+ type: ConsoleVariable
returns:
- type: string
description: "Returns a string representation of the ConsoleVariable"
diff --git a/docs/classes/EditablePanel/ActivateBuildMode.md b/docs/classes/EditablePanel/ActivateBuildMode.md
index 92be80a132..bc595105b0 100644
--- a/docs/classes/EditablePanel/ActivateBuildMode.md
+++ b/docs/classes/EditablePanel/ActivateBuildMode.md
@@ -13,7 +13,10 @@ lua:
realm: client
description: "Activates build mode for the panel"
-
+ arguments:
+ - position: 1
+ name: "editablePanel"
+ type: EditablePanel
returns:
---
diff --git a/docs/classes/EditablePanel/ApplySettings.md b/docs/classes/EditablePanel/ApplySettings.md
index 357ab05b5a..03b9bc9ae1 100644
--- a/docs/classes/EditablePanel/ApplySettings.md
+++ b/docs/classes/EditablePanel/ApplySettings.md
@@ -13,7 +13,13 @@ lua:
realm: client
description: "Applies settings from key-values"
-
+ arguments:
+ - position: 1
+ name: "editablePanel"
+ type: EditablePanel
+ - position: 2
+ name: "keyValues"
+ type: KeyValuesHandle
returns:
---
diff --git a/docs/classes/EditablePanel/DoModal.md b/docs/classes/EditablePanel/DoModal.md
index d93f0fa591..4393bfb1fd 100644
--- a/docs/classes/EditablePanel/DoModal.md
+++ b/docs/classes/EditablePanel/DoModal.md
@@ -13,7 +13,10 @@ lua:
realm: client
description: "Makes the panel modal"
-
+ arguments:
+ - position: 1
+ name: "editablePanel"
+ type: EditablePanel
returns:
---
diff --git a/docs/classes/EditablePanel/GetControlInt.md b/docs/classes/EditablePanel/GetControlInt.md
index 3ca0310240..a1c1b05c15 100644
--- a/docs/classes/EditablePanel/GetControlInt.md
+++ b/docs/classes/EditablePanel/GetControlInt.md
@@ -14,10 +14,15 @@ lua:
description: "Gets an integer value from a control"
arguments:
- - name: "control"
- type: string
- - name: "default"
- type: number
+ - position: 1
+ name: "editablePanel"
+ type: EditablePanel
+ - position: 2
+ name: "control"
+ type: string
+ - position: 3
+ name: "default"
+ type: number
returns:
- type: integer
description: "The control integer value"
diff --git a/docs/classes/EditablePanel/GetControlString.md b/docs/classes/EditablePanel/GetControlString.md
index 4a1abe7fdd..db1bde1356 100644
--- a/docs/classes/EditablePanel/GetControlString.md
+++ b/docs/classes/EditablePanel/GetControlString.md
@@ -14,11 +14,16 @@ lua:
description: "Gets a string value from a control"
arguments:
- - name: "control"
- type: string
- - name: "default"
- type: string
- default: "\"\""
+ - position: 1
+ name: "editablePanel"
+ type: EditablePanel
+ - position: 2
+ name: "control"
+ type: string
+ - position: 3
+ name: "default"
+ type: string
+ default: "\"\""
returns:
- type: string
description: "The control string value"
diff --git a/docs/classes/EditablePanel/GetCurrentKeyFocus.md b/docs/classes/EditablePanel/GetCurrentKeyFocus.md
index 3d07c60bd9..2a27fd6ec9 100644
--- a/docs/classes/EditablePanel/GetCurrentKeyFocus.md
+++ b/docs/classes/EditablePanel/GetCurrentKeyFocus.md
@@ -13,7 +13,10 @@ lua:
realm: client
description: "Gets the current key focus"
-
+ arguments:
+ - position: 1
+ name: "editablePanel"
+ type: EditablePanel
returns:
- type: Panel
description: "The current key focus panel"
diff --git a/docs/classes/EditablePanel/GetDialogVariables.md b/docs/classes/EditablePanel/GetDialogVariables.md
index 5aaeb030ae..ad20998576 100644
--- a/docs/classes/EditablePanel/GetDialogVariables.md
+++ b/docs/classes/EditablePanel/GetDialogVariables.md
@@ -13,7 +13,10 @@ lua:
realm: client
description: "Gets the dialog variables"
-
+ arguments:
+ - position: 1
+ name: "editablePanel"
+ type: EditablePanel
returns:
- type: KeyValuesHandle
description: "The dialog variables"
diff --git a/docs/classes/EditablePanel/GetPanelBaseClassName.md b/docs/classes/EditablePanel/GetPanelBaseClassName.md
deleted file mode 100644
index e8bcf07656..0000000000
--- a/docs/classes/EditablePanel/GetPanelBaseClassName.md
+++ /dev/null
@@ -1,24 +0,0 @@
----
-template: lua-class-function.html
-title: GetPanelBaseClassName
-icon: lua-client
-tags:
- - lua
- - client
- - needs-verification
- - needs-example
-lua:
- library: EditablePanel
- function: GetPanelBaseClassName
- realm: client
- description: "Gets the base class name of the panel"
-
-
- returns:
- - type: string
- description: "The base class name"
----
-
-
-Entity:CreatePredictedEntityByName – Create predicted entity by name.
+Entities:CreatePredictedEntityByName – Create predicted entity by name.
diff --git a/docs/classes/Entities/index.md b/docs/classes/Entities/index.md
new file mode 100644
index 0000000000..2964693c76
--- /dev/null
+++ b/docs/classes/Entities/index.md
@@ -0,0 +1,10 @@
+---
+template: lua-index.html
+childrenTitle: Methods
+include:
+ startsWith: classes/Entities/
+exclude:
+ isIndex: true
+---
+
+# Entities
diff --git a/docs/classes/Entity/Activate.md b/docs/classes/Entity/Activate.md
index a32a3a62ae..27ca937d29 100644
--- a/docs/classes/Entity/Activate.md
+++ b/docs/classes/Entity/Activate.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Activate the entity."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Entity
returns:
---
diff --git a/docs/classes/Entity/AddContext.md b/docs/classes/Entity/AddContext.md
index eb536902fe..faa11062dd 100644
--- a/docs/classes/Entity/AddContext.md
+++ b/docs/classes/Entity/AddContext.md
@@ -14,8 +14,12 @@ lua:
description: "Add context."
arguments:
- - name: "nameAndValue"
- type: string
+ - position: 1
+ name: "entity"
+ type: Entity
+ - position: 2
+ name: "nameAndValue"
+ type: string
returns:
---
diff --git a/docs/classes/Entity/AddDataObjectType.md b/docs/classes/Entity/AddDataObjectType.md
index 4798ffff56..4da6bf341e 100644
--- a/docs/classes/Entity/AddDataObjectType.md
+++ b/docs/classes/Entity/AddDataObjectType.md
@@ -14,8 +14,12 @@ lua:
description: "Add data object type."
arguments:
- - name: "type"
- type: number
+ - position: 1
+ name: "entity"
+ type: Entity
+ - position: 2
+ name: "type"
+ type: number
returns:
---
diff --git a/docs/classes/Entity/AddDeleteOnRemove.md b/docs/classes/Entity/AddDeleteOnRemove.md
index a171194458..5155e6b54f 100644
--- a/docs/classes/Entity/AddDeleteOnRemove.md
+++ b/docs/classes/Entity/AddDeleteOnRemove.md
@@ -14,8 +14,12 @@ lua:
description: "Add an entity to the list of entities being deleted when this entity is removed."
arguments:
- - name: "entityToDelete"
- type: Entity
+ - position: 1
+ name: "entity"
+ type: Entity
+ - position: 2
+ name: "entityToDelete"
+ type: Entity
returns:
---
diff --git a/docs/classes/Entity/AddEffects.md b/docs/classes/Entity/AddEffects.md
index c4d69f593b..f9039ce0de 100644
--- a/docs/classes/Entity/AddEffects.md
+++ b/docs/classes/Entity/AddEffects.md
@@ -14,8 +14,12 @@ lua:
description: "Add effects."
arguments:
- - name: "effects"
- type: number
+ - position: 1
+ name: "entity"
+ type: Entity
+ - position: 2
+ name: "effects"
+ type: number
returns:
---
diff --git a/docs/classes/Entity/AddEntityFlags.md b/docs/classes/Entity/AddEntityFlags.md
index 6610a8c114..19bef01114 100644
--- a/docs/classes/Entity/AddEntityFlags.md
+++ b/docs/classes/Entity/AddEntityFlags.md
@@ -14,8 +14,12 @@ lua:
description: "Add entity flags."
arguments:
- - name: "flags"
- type: number
+ - position: 1
+ name: "entity"
+ type: Entity
+ - position: 2
+ name: "flags"
+ type: number
returns:
---
diff --git a/docs/classes/Entity/AddEntityToVisibleList.md b/docs/classes/Entity/AddEntityToVisibleList.md
index dbe23a2c4d..43145c205a 100644
--- a/docs/classes/Entity/AddEntityToVisibleList.md
+++ b/docs/classes/Entity/AddEntityToVisibleList.md
@@ -13,7 +13,10 @@ lua:
realm: client
description: "Add the entity to the visible entity list. Seems to only call CreateLightEffects internally."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Entity
returns:
---
diff --git a/docs/classes/Entity/AddFlag.md b/docs/classes/Entity/AddFlag.md
index ca3c323601..19a7bd75ce 100644
--- a/docs/classes/Entity/AddFlag.md
+++ b/docs/classes/Entity/AddFlag.md
@@ -14,8 +14,12 @@ lua:
description: "Add flag to entity."
arguments:
- - name: "flag"
- type: number
+ - position: 1
+ name: "entity"
+ type: Entity
+ - position: 2
+ name: "flag"
+ type: number
returns:
---
diff --git a/docs/classes/Entity/AddPoints.md b/docs/classes/Entity/AddPoints.md
index c35395edcc..2f2044329d 100644
--- a/docs/classes/Entity/AddPoints.md
+++ b/docs/classes/Entity/AddPoints.md
@@ -14,10 +14,15 @@ lua:
description: "Add points."
arguments:
- - name: "points"
- type: number
- - name: "allowNegative"
- type: boolean
+ - position: 1
+ name: "entity"
+ type: Entity
+ - position: 2
+ name: "points"
+ type: number
+ - position: 3
+ name: "allowNegative"
+ type: boolean
returns:
---
diff --git a/docs/classes/Entity/AddPointsToTeam.md b/docs/classes/Entity/AddPointsToTeam.md
index 29639faec1..9556517680 100644
--- a/docs/classes/Entity/AddPointsToTeam.md
+++ b/docs/classes/Entity/AddPointsToTeam.md
@@ -14,10 +14,15 @@ lua:
description: "Add points to team."
arguments:
- - name: "points"
- type: number
- - name: "allowNegative"
- type: boolean
+ - position: 1
+ name: "entity"
+ type: Entity
+ - position: 2
+ name: "points"
+ type: number
+ - position: 3
+ name: "allowNegative"
+ type: boolean
returns:
---
diff --git a/docs/classes/Entity/AddSolidFlags.md b/docs/classes/Entity/AddSolidFlags.md
index 020cebccf4..c7d7a19198 100644
--- a/docs/classes/Entity/AddSolidFlags.md
+++ b/docs/classes/Entity/AddSolidFlags.md
@@ -14,8 +14,12 @@ lua:
description: "Add solid flags."
arguments:
- - name: "flags"
- type: number
+ - position: 1
+ name: "entity"
+ type: Entity
+ - position: 2
+ name: "flags"
+ type: number
returns:
---
diff --git a/docs/classes/Entity/AddSpawnFlags.md b/docs/classes/Entity/AddSpawnFlags.md
index 3b0d08fc72..87ef24f78b 100644
--- a/docs/classes/Entity/AddSpawnFlags.md
+++ b/docs/classes/Entity/AddSpawnFlags.md
@@ -14,8 +14,12 @@ lua:
description: "Add spawn flags."
arguments:
- - name: "flags"
- type: number
+ - position: 1
+ name: "entity"
+ type: Entity
+ - position: 2
+ name: "flags"
+ type: number
returns:
---
diff --git a/docs/classes/Entity/AddTimedOverlay.md b/docs/classes/Entity/AddTimedOverlay.md
index ebd024c035..df3445023f 100644
--- a/docs/classes/Entity/AddTimedOverlay.md
+++ b/docs/classes/Entity/AddTimedOverlay.md
@@ -14,10 +14,15 @@ lua:
description: "Add timed overlay."
arguments:
- - name: "text"
- type: string
- - name: "durationInSeconds"
- type: number
+ - position: 1
+ name: "entity"
+ type: Entity
+ - position: 2
+ name: "text"
+ type: string
+ - position: 3
+ name: "durationInSeconds"
+ type: number
returns:
---
diff --git a/docs/classes/Entity/AddToClientSideAnimationList.md b/docs/classes/Entity/AddToClientSideAnimationList.md
index 7a2087415d..de2811db6a 100644
--- a/docs/classes/Entity/AddToClientSideAnimationList.md
+++ b/docs/classes/Entity/AddToClientSideAnimationList.md
@@ -13,7 +13,10 @@ lua:
realm: client
description: "Add the entity to the client side animation list."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Entity
returns:
---
diff --git a/docs/classes/Entity/ApplyAbsoluteVelocityImpulse.md b/docs/classes/Entity/ApplyAbsoluteVelocityImpulse.md
index 22f868b421..105ca8b729 100644
--- a/docs/classes/Entity/ApplyAbsoluteVelocityImpulse.md
+++ b/docs/classes/Entity/ApplyAbsoluteVelocityImpulse.md
@@ -14,8 +14,12 @@ lua:
description: "Apply absolute velocity impulse."
arguments:
- - name: "impulse"
- type: Vector
+ - position: 1
+ name: "entity"
+ type: Entity
+ - position: 2
+ name: "impulse"
+ type: Vector
returns:
---
diff --git a/docs/classes/Entity/ApplyLocalAngularVelocityImpulse.md b/docs/classes/Entity/ApplyLocalAngularVelocityImpulse.md
index cc2c65f112..0097b1b4f0 100644
--- a/docs/classes/Entity/ApplyLocalAngularVelocityImpulse.md
+++ b/docs/classes/Entity/ApplyLocalAngularVelocityImpulse.md
@@ -14,8 +14,12 @@ lua:
description: "Apply local angular velocity impulse."
arguments:
- - name: "impulse"
- type: Vector
+ - position: 1
+ name: "entity"
+ type: Entity
+ - position: 2
+ name: "impulse"
+ type: Vector
returns:
---
diff --git a/docs/classes/Entity/BecomeRagdollOnClient.md b/docs/classes/Entity/BecomeRagdollOnClient.md
index e6969a708a..5cf1634d05 100644
--- a/docs/classes/Entity/BecomeRagdollOnClient.md
+++ b/docs/classes/Entity/BecomeRagdollOnClient.md
@@ -13,7 +13,10 @@ lua:
realm: client
description: "Become a ragdoll on the client."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Entity
returns:
- type: Entity
description: "The ragdoll entity"
diff --git a/docs/classes/Entity/BodyTarget.md b/docs/classes/Entity/BodyTarget.md
index b6d54d2c43..23de6c600b 100644
--- a/docs/classes/Entity/BodyTarget.md
+++ b/docs/classes/Entity/BodyTarget.md
@@ -14,11 +14,16 @@ lua:
description: "Body target."
arguments:
- - name: "position"
- type: Vector
- - name: "noisy"
- type: boolean
- default: "true"
+ - position: 1
+ name: "entity"
+ type: Entity
+ - position: 2
+ name: "position"
+ type: Vector
+ - position: 3
+ name: "noisy"
+ type: boolean
+ default: "true"
returns:
- type: Vector
description: "The body target"
diff --git a/docs/classes/Entity/CalculateIkLocks.md b/docs/classes/Entity/CalculateIkLocks.md
index 5d5d09cafa..9a0635f402 100644
--- a/docs/classes/Entity/CalculateIkLocks.md
+++ b/docs/classes/Entity/CalculateIkLocks.md
@@ -14,8 +14,12 @@ lua:
description: "Calculate IK locks."
arguments:
- - name: "currentTime"
- type: number
+ - position: 1
+ name: "entity"
+ type: Entity
+ - position: 2
+ name: "currentTime"
+ type: number
returns:
---
diff --git a/docs/classes/Entity/CalculateNearestPoint.md b/docs/classes/Entity/CalculateNearestPoint.md
index cc5d0ea091..a06830a9e7 100644
--- a/docs/classes/Entity/CalculateNearestPoint.md
+++ b/docs/classes/Entity/CalculateNearestPoint.md
@@ -14,8 +14,12 @@ lua:
description: "Computes the nearest point in the OBB to a point specified in world space."
arguments:
- - name: "point"
- type: Vector
+ - position: 1
+ name: "entity"
+ type: Entity
+ - position: 2
+ name: "point"
+ type: Vector
returns:
- type: Vector
description: "The nearest point."
diff --git a/docs/classes/Entity/CallUseToggle.md b/docs/classes/Entity/CallUseToggle.md
index 2415400071..0dbfb74d1f 100644
--- a/docs/classes/Entity/CallUseToggle.md
+++ b/docs/classes/Entity/CallUseToggle.md
@@ -13,7 +13,10 @@ lua:
realm: server
description: "Call use toggle."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Entity
returns:
---
diff --git a/docs/classes/Entity/CanBeHitByMeleeAttack.md b/docs/classes/Entity/CanBeHitByMeleeAttack.md
index 55866f2306..b7ec3c8aa3 100644
--- a/docs/classes/Entity/CanBeHitByMeleeAttack.md
+++ b/docs/classes/Entity/CanBeHitByMeleeAttack.md
@@ -14,8 +14,12 @@ lua:
description: "Can be hit by melee attack."
arguments:
- - name: "attacker"
- type: Entity
+ - position: 1
+ name: "entity"
+ type: Entity
+ - position: 2
+ name: "attacker"
+ type: Entity
returns:
- type: boolean
description: "true if can be hit, false otherwise."
diff --git a/docs/classes/Entity/CanStandOn.md b/docs/classes/Entity/CanStandOn.md
index a307161f19..84edf7eb71 100644
--- a/docs/classes/Entity/CanStandOn.md
+++ b/docs/classes/Entity/CanStandOn.md
@@ -14,8 +14,12 @@ lua:
description: "Whether this entity can stand on the given surface entity."
arguments:
- - name: "surfaceEntity"
- type: Entity
+ - position: 1
+ name: "entity"
+ type: Entity
+ - position: 2
+ name: "surfaceEntity"
+ type: Entity
returns:
- type: boolean
description: "true if can stand on, false otherwise."
diff --git a/docs/classes/Entity/ChangeTeam.md b/docs/classes/Entity/ChangeTeam.md
index e7cd037bd2..9ef3ee7df6 100644
--- a/docs/classes/Entity/ChangeTeam.md
+++ b/docs/classes/Entity/ChangeTeam.md
@@ -14,8 +14,12 @@ lua:
description: "Change the team of the entity."
arguments:
- - name: "team"
- type: number
+ - position: 1
+ name: "entity"
+ type: Entity
+ - position: 2
+ name: "team"
+ type: number
returns:
---
diff --git a/docs/classes/Entity/ClampCycle.md b/docs/classes/Entity/ClampCycle.md
index eb2cb5ef93..9c4e859d09 100644
--- a/docs/classes/Entity/ClampCycle.md
+++ b/docs/classes/Entity/ClampCycle.md
@@ -14,10 +14,15 @@ lua:
description: "Clamp the cycle."
arguments:
- - name: "cycle"
- type: number
- - name: "isLooping"
- type: boolean
+ - position: 1
+ name: "entity"
+ type: Entity
+ - position: 2
+ name: "cycle"
+ type: number
+ - position: 3
+ name: "isLooping"
+ type: boolean
returns:
- type: number
description: "The clamped cycle"
diff --git a/docs/classes/Entity/ClassMatches.md b/docs/classes/Entity/ClassMatches.md
index e76e6cd489..711257cc35 100644
--- a/docs/classes/Entity/ClassMatches.md
+++ b/docs/classes/Entity/ClassMatches.md
@@ -14,8 +14,12 @@ lua:
description: "Class matches."
arguments:
- - name: "classNameOrWildcard"
- type: string
+ - position: 1
+ name: "entity"
+ type: Entity
+ - position: 2
+ name: "classNameOrWildcard"
+ type: string
returns:
- type: boolean
description: "true if matches, false otherwise."
diff --git a/docs/classes/Entity/Classify.md b/docs/classes/Entity/Classify.md
index 7694c51249..83fd16bd31 100644
--- a/docs/classes/Entity/Classify.md
+++ b/docs/classes/Entity/Classify.md
@@ -13,7 +13,10 @@ lua:
realm: server
description: "Returns the type of group (i.e, 'houndeye', or 'human military' so that NPCs with different classnames still realize that they are teammates. (overridden for NPCs that form groups)."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Entity
returns:
- type: enumeration/AI_CLASS
description: "The classification"
diff --git a/docs/classes/Entity/Clear.md b/docs/classes/Entity/Clear.md
index 9082f762a9..edb3edfa41 100644
--- a/docs/classes/Entity/Clear.md
+++ b/docs/classes/Entity/Clear.md
@@ -13,7 +13,10 @@ lua:
realm: client
description: "Resets internal fields."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Entity
returns:
---
diff --git a/docs/classes/Entity/ClearEffects.md b/docs/classes/Entity/ClearEffects.md
index 370242065c..c10967ef18 100644
--- a/docs/classes/Entity/ClearEffects.md
+++ b/docs/classes/Entity/ClearEffects.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Clear effects."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Entity
returns:
---
diff --git a/docs/classes/Entity/ClearFlags.md b/docs/classes/Entity/ClearFlags.md
index f26449758d..20cea43696 100644
--- a/docs/classes/Entity/ClearFlags.md
+++ b/docs/classes/Entity/ClearFlags.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Clear flags."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Entity
returns:
---
diff --git a/docs/classes/Entity/ClearNavIgnore.md b/docs/classes/Entity/ClearNavIgnore.md
index 8e562906a5..85b5b5d3f3 100644
--- a/docs/classes/Entity/ClearNavIgnore.md
+++ b/docs/classes/Entity/ClearNavIgnore.md
@@ -13,7 +13,10 @@ lua:
realm: server
description: "Clear nav ignore."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Entity
returns:
---
diff --git a/docs/classes/Entity/ClearRagdoll.md b/docs/classes/Entity/ClearRagdoll.md
index ab5f845e54..d34992611c 100644
--- a/docs/classes/Entity/ClearRagdoll.md
+++ b/docs/classes/Entity/ClearRagdoll.md
@@ -13,7 +13,10 @@ lua:
realm: client
description: "Clear/destroy the clientside ragdoll."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Entity
returns:
---
diff --git a/docs/classes/Entity/ClearSolidFlags.md b/docs/classes/Entity/ClearSolidFlags.md
index c880626620..214804c421 100644
--- a/docs/classes/Entity/ClearSolidFlags.md
+++ b/docs/classes/Entity/ClearSolidFlags.md
@@ -13,7 +13,10 @@ lua:
realm: server
description: "Clear solid flags."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Entity
returns:
---
diff --git a/docs/classes/Entity/ClearSpawnFlags.md b/docs/classes/Entity/ClearSpawnFlags.md
index 0d73547a90..0c5553ab79 100644
--- a/docs/classes/Entity/ClearSpawnFlags.md
+++ b/docs/classes/Entity/ClearSpawnFlags.md
@@ -13,7 +13,10 @@ lua:
realm: server
description: "Clear spawn flags."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Entity
returns:
---
diff --git a/docs/classes/Entity/ClientSideAnimationChanged.md b/docs/classes/Entity/ClientSideAnimationChanged.md
index 44180ab9f5..5ec260887a 100644
--- a/docs/classes/Entity/ClientSideAnimationChanged.md
+++ b/docs/classes/Entity/ClientSideAnimationChanged.md
@@ -13,7 +13,10 @@ lua:
realm: client
description: "Called when the client side animation changes."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Entity
returns:
---
diff --git a/docs/classes/Entity/CollisionRulesChanged.md b/docs/classes/Entity/CollisionRulesChanged.md
index 4b876ca6df..985bb4a5d0 100644
--- a/docs/classes/Entity/CollisionRulesChanged.md
+++ b/docs/classes/Entity/CollisionRulesChanged.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Collision rules changed."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Entity
returns:
---
diff --git a/docs/classes/Entity/ComputeAbsoluteDirection.md b/docs/classes/Entity/ComputeAbsoluteDirection.md
index 6ab3fcadd7..7b73acde1e 100644
--- a/docs/classes/Entity/ComputeAbsoluteDirection.md
+++ b/docs/classes/Entity/ComputeAbsoluteDirection.md
@@ -14,8 +14,12 @@ lua:
description: "Compute absolute direction."
arguments:
- - name: "localDir"
- type: Vector
+ - position: 1
+ name: "entity"
+ type: Entity
+ - position: 2
+ name: "localDir"
+ type: Vector
returns:
- type: Vector
description: "The absolute direction."
diff --git a/docs/classes/Entity/ComputeAbsolutePosition.md b/docs/classes/Entity/ComputeAbsolutePosition.md
index 5e6d5e3020..4bb6adf0ef 100644
--- a/docs/classes/Entity/ComputeAbsolutePosition.md
+++ b/docs/classes/Entity/ComputeAbsolutePosition.md
@@ -14,8 +14,12 @@ lua:
description: "Compute absolute position."
arguments:
- - name: "localPos"
- type: Vector
+ - position: 1
+ name: "entity"
+ type: Entity
+ - position: 2
+ name: "localPos"
+ type: Vector
returns:
- type: Vector
description: "The absolute position."
diff --git a/docs/classes/Entity/ComputeClientSideAnimationFlags.md b/docs/classes/Entity/ComputeClientSideAnimationFlags.md
index 73a7bbeb92..68d87e2cd2 100644
--- a/docs/classes/Entity/ComputeClientSideAnimationFlags.md
+++ b/docs/classes/Entity/ComputeClientSideAnimationFlags.md
@@ -13,7 +13,10 @@ lua:
realm: client
description: "Compute the client side animation flags."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Entity
returns:
- type: integer
description: "The client side animation flags"
diff --git a/docs/classes/Entity/ComputeEntitySpaceHitboxSurroundingBox.md b/docs/classes/Entity/ComputeEntitySpaceHitboxSurroundingBox.md
index 81ac120c78..dea2230dc2 100644
--- a/docs/classes/Entity/ComputeEntitySpaceHitboxSurroundingBox.md
+++ b/docs/classes/Entity/ComputeEntitySpaceHitboxSurroundingBox.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Compute the entity space hitbox surrounding box."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Entity
returns:
- type: boolean
description: "Whether the operation was successful"
diff --git a/docs/classes/Entity/ComputeHitboxSurroundingBox.md b/docs/classes/Entity/ComputeHitboxSurroundingBox.md
index aef3450590..df7e1901b0 100644
--- a/docs/classes/Entity/ComputeHitboxSurroundingBox.md
+++ b/docs/classes/Entity/ComputeHitboxSurroundingBox.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Compute the hitbox surrounding box."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Entity
returns:
- type: boolean
description: "Whether the operation was successful"
diff --git a/docs/classes/Entity/ComputeRenderEffectsBlend.md b/docs/classes/Entity/ComputeRenderEffectsBlend.md
index 3511a2a451..de742dc047 100644
--- a/docs/classes/Entity/ComputeRenderEffectsBlend.md
+++ b/docs/classes/Entity/ComputeRenderEffectsBlend.md
@@ -13,7 +13,10 @@ lua:
realm: client
description: "Compute RenderFX blend."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Entity
returns:
---
diff --git a/docs/classes/Entity/ComputeWorldSpaceSurroundingBox.md b/docs/classes/Entity/ComputeWorldSpaceSurroundingBox.md
index 3dca5565ea..8af243b26b 100644
--- a/docs/classes/Entity/ComputeWorldSpaceSurroundingBox.md
+++ b/docs/classes/Entity/ComputeWorldSpaceSurroundingBox.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Compute world space surrounding box."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Entity
returns:
- type: Vector
description: "The minimum vector."
diff --git a/docs/classes/Entity/CreateDataObject.md b/docs/classes/Entity/CreateDataObject.md
index e7987648ec..5b77076b57 100644
--- a/docs/classes/Entity/CreateDataObject.md
+++ b/docs/classes/Entity/CreateDataObject.md
@@ -14,8 +14,12 @@ lua:
description: "Create data object."
arguments:
- - name: "type"
- type: number
+ - position: 1
+ name: "entity"
+ type: Entity
+ - position: 2
+ name: "type"
+ type: number
returns:
---
diff --git a/docs/classes/Entity/CreateRagdollCopy.md b/docs/classes/Entity/CreateRagdollCopy.md
index 97202c57c5..ac411b0cf8 100644
--- a/docs/classes/Entity/CreateRagdollCopy.md
+++ b/docs/classes/Entity/CreateRagdollCopy.md
@@ -13,7 +13,10 @@ lua:
realm: client
description: "Create a ragdoll copy of the entity."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Entity
returns:
- type: Entity
description: "The ragdoll entity"
diff --git a/docs/classes/Entity/CreateUnragdollInfo.md b/docs/classes/Entity/CreateUnragdollInfo.md
index d2e3531a5e..ade28281a3 100644
--- a/docs/classes/Entity/CreateUnragdollInfo.md
+++ b/docs/classes/Entity/CreateUnragdollInfo.md
@@ -14,8 +14,12 @@ lua:
description: "Creates unragdoll info for the given ragdoll, setting it on the entity internally."
arguments:
- - name: "ragdoll"
- type: Entity
+ - position: 1
+ name: "entity"
+ type: Entity
+ - position: 2
+ name: "ragdoll"
+ type: Entity
returns:
---
diff --git a/docs/classes/Entity/CreateVPhysics.md b/docs/classes/Entity/CreateVPhysics.md
index d65b2da6c6..0c4c042bb3 100644
--- a/docs/classes/Entity/CreateVPhysics.md
+++ b/docs/classes/Entity/CreateVPhysics.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Create VPhysics."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Entity
returns:
- type: boolean
description: "True if VPhysics was created, false otherwise."
diff --git a/docs/classes/Entity/DamageDecal.md b/docs/classes/Entity/DamageDecal.md
index 027678b6d6..cade079d81 100644
--- a/docs/classes/Entity/DamageDecal.md
+++ b/docs/classes/Entity/DamageDecal.md
@@ -14,10 +14,15 @@ lua:
description: "Damage decal."
arguments:
- - name: "damageType"
- type: number
- - name: "damage"
- type: number
+ - position: 1
+ name: "entity"
+ type: Entity
+ - position: 2
+ name: "damageType"
+ type: number
+ - position: 3
+ name: "damage"
+ type: number
returns:
- type: string
description: "The decal name."
diff --git a/docs/classes/Entity/DeathNotice.md b/docs/classes/Entity/DeathNotice.md
index 16c10e47ec..99b3f8a04b 100644
--- a/docs/classes/Entity/DeathNotice.md
+++ b/docs/classes/Entity/DeathNotice.md
@@ -14,8 +14,12 @@ lua:
description: "Death notice."
arguments:
- - name: "killer"
- type: Entity
+ - position: 1
+ name: "entity"
+ type: Entity
+ - position: 2
+ name: "killer"
+ type: Entity
returns:
---
diff --git a/docs/classes/Entity/DecalTrace.md b/docs/classes/Entity/DecalTrace.md
index 02b09a1beb..128c9fc02d 100644
--- a/docs/classes/Entity/DecalTrace.md
+++ b/docs/classes/Entity/DecalTrace.md
@@ -14,10 +14,15 @@ lua:
description: "Decal trace."
arguments:
- - name: "trace"
- type: Trace
- - name: "decalName"
- type: string
+ - position: 1
+ name: "entity"
+ type: Entity
+ - position: 2
+ name: "trace"
+ type: Trace
+ - position: 3
+ name: "decalName"
+ type: string
returns:
---
diff --git a/docs/classes/Entity/DecrementTransmitStateOwnedCounter.md b/docs/classes/Entity/DecrementTransmitStateOwnedCounter.md
index d03313aa56..c83b628fef 100644
--- a/docs/classes/Entity/DecrementTransmitStateOwnedCounter.md
+++ b/docs/classes/Entity/DecrementTransmitStateOwnedCounter.md
@@ -13,7 +13,10 @@ lua:
realm: server
description: "Decrement transmit state owned counter."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Entity
returns:
---
diff --git a/docs/classes/Entity/DestroyAllDataObjects.md b/docs/classes/Entity/DestroyAllDataObjects.md
index 2cd23846c0..26fc304f4e 100644
--- a/docs/classes/Entity/DestroyAllDataObjects.md
+++ b/docs/classes/Entity/DestroyAllDataObjects.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Destroy all data objects."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Entity
returns:
---
diff --git a/docs/classes/Entity/DestroyDataObject.md b/docs/classes/Entity/DestroyDataObject.md
index 56964bc898..da7c485266 100644
--- a/docs/classes/Entity/DestroyDataObject.md
+++ b/docs/classes/Entity/DestroyDataObject.md
@@ -14,8 +14,12 @@ lua:
description: "Destroy data object."
arguments:
- - name: "type"
- type: number
+ - position: 1
+ name: "entity"
+ type: Entity
+ - position: 2
+ name: "type"
+ type: number
returns:
---
diff --git a/docs/classes/Entity/DestroyPhysicsObject.md b/docs/classes/Entity/DestroyPhysicsObject.md
index 4619ac8626..c31b800ee3 100644
--- a/docs/classes/Entity/DestroyPhysicsObject.md
+++ b/docs/classes/Entity/DestroyPhysicsObject.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Destroy physics object."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Entity
returns:
---
diff --git a/docs/classes/Entity/DetectInSkybox.md b/docs/classes/Entity/DetectInSkybox.md
index ba54565fba..5ce6e0b265 100644
--- a/docs/classes/Entity/DetectInSkybox.md
+++ b/docs/classes/Entity/DetectInSkybox.md
@@ -13,7 +13,10 @@ lua:
realm: server
description: "This function finds out if the entity is in the 3D skybox. If so, it sets the EFL_IN_SKYBOX flag so the entity gets transmitted to all the clients. Entities usually call this during their Activate(). Returns true if the entity is in the skybox (and EFL_IN_SKYBOX was set).."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Entity
returns:
- type: boolean
description: "true if in skybox, false otherwise."
diff --git a/docs/classes/Entity/DisableMuzzleFlash.md b/docs/classes/Entity/DisableMuzzleFlash.md
index 6c052afd3f..d4d213a576 100644
--- a/docs/classes/Entity/DisableMuzzleFlash.md
+++ b/docs/classes/Entity/DisableMuzzleFlash.md
@@ -13,7 +13,10 @@ lua:
realm: client
description: "Disable the muzzle flash."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Entity
returns:
---
diff --git a/docs/classes/Entity/DispatchMuzzleEffect.md b/docs/classes/Entity/DispatchMuzzleEffect.md
index eed1cc5c18..667ab4f8cc 100644
--- a/docs/classes/Entity/DispatchMuzzleEffect.md
+++ b/docs/classes/Entity/DispatchMuzzleEffect.md
@@ -14,10 +14,15 @@ lua:
description: "Dispatch the muzzle effect."
arguments:
- - name: "options"
- type: string
- - name: "isFirstPerson"
- type: boolean
+ - position: 1
+ name: "entity"
+ type: Entity
+ - position: 2
+ name: "options"
+ type: string
+ - position: 3
+ name: "isFirstPerson"
+ type: boolean
returns:
- type: boolean
description: "Whether the operation was successful"
diff --git a/docs/classes/Entity/DispatchResponse.md b/docs/classes/Entity/DispatchResponse.md
index 0b595abd26..179160fb49 100644
--- a/docs/classes/Entity/DispatchResponse.md
+++ b/docs/classes/Entity/DispatchResponse.md
@@ -14,8 +14,12 @@ lua:
description: "Dispatch response."
arguments:
- - name: "conceptName"
- type: string
+ - position: 1
+ name: "entity"
+ type: Entity
+ - position: 2
+ name: "conceptName"
+ type: string
returns:
---
diff --git a/docs/classes/Entity/DispatchTraceAttack.md b/docs/classes/Entity/DispatchTraceAttack.md
index 970b3e68d5..5c6953d54c 100644
--- a/docs/classes/Entity/DispatchTraceAttack.md
+++ b/docs/classes/Entity/DispatchTraceAttack.md
@@ -14,12 +14,18 @@ lua:
description: "Dispatch trace attack."
arguments:
- - name: "damageInfo"
- type: DamageInfo
- - name: "direction"
- type: Vector
- - name: "trace"
- type: Trace
+ - position: 1
+ name: "entity"
+ type: Entity
+ - position: 2
+ name: "damageInfo"
+ type: DamageInfo
+ - position: 3
+ name: "direction"
+ type: Vector
+ - position: 4
+ name: "trace"
+ type: Trace
returns:
---
diff --git a/docs/classes/Entity/DoImpactEffect.md b/docs/classes/Entity/DoImpactEffect.md
index 3d007e8743..90be241c6d 100644
--- a/docs/classes/Entity/DoImpactEffect.md
+++ b/docs/classes/Entity/DoImpactEffect.md
@@ -14,10 +14,15 @@ lua:
description: "Do impact effect."
arguments:
- - name: "trace"
- type: Trace
- - name: "damageType"
- type: number
+ - position: 1
+ name: "entity"
+ type: Entity
+ - position: 2
+ name: "trace"
+ type: Trace
+ - position: 3
+ name: "damageType"
+ type: number
returns:
---
diff --git a/docs/classes/Entity/DoMuzzleFlash.md b/docs/classes/Entity/DoMuzzleFlash.md
index b69852105d..a1a0e47f85 100644
--- a/docs/classes/Entity/DoMuzzleFlash.md
+++ b/docs/classes/Entity/DoMuzzleFlash.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Sets up muzzle flash parity."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Entity
returns:
---
diff --git a/docs/classes/Entity/DoNothing.md b/docs/classes/Entity/DoNothing.md
index 8bc48eae58..5dc3c0c3cb 100644
--- a/docs/classes/Entity/DoNothing.md
+++ b/docs/classes/Entity/DoNothing.md
@@ -13,7 +13,10 @@ lua:
realm: server
description: "Described as 'Convenient way to explicitly do nothing (passed to functions that require a method)'"
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Entity
returns:
---
diff --git a/docs/classes/Entity/DoesHavePlayerChild.md b/docs/classes/Entity/DoesHavePlayerChild.md
index 1696897c85..796ddba357 100644
--- a/docs/classes/Entity/DoesHavePlayerChild.md
+++ b/docs/classes/Entity/DoesHavePlayerChild.md
@@ -13,7 +13,10 @@ lua:
realm: server
description: "Whether this entity has a player child somewhere in the hierarchy (checks EFL_HAS_PLAYER_CHILD)."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Entity
returns:
- type: boolean
description: "true if has player child, false otherwise."
diff --git a/docs/classes/Entity/DontRecordInTools.md b/docs/classes/Entity/DontRecordInTools.md
index 032dce39ac..7c628aa12b 100644
--- a/docs/classes/Entity/DontRecordInTools.md
+++ b/docs/classes/Entity/DontRecordInTools.md
@@ -13,7 +13,10 @@ lua:
realm: client
description: "Don't record in tools."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Entity
returns:
---
diff --git a/docs/classes/Entity/DrawAbsBoxOverlay.md b/docs/classes/Entity/DrawAbsBoxOverlay.md
index b62d9c2316..7693e312b5 100644
--- a/docs/classes/Entity/DrawAbsBoxOverlay.md
+++ b/docs/classes/Entity/DrawAbsBoxOverlay.md
@@ -13,7 +13,10 @@ lua:
realm: server
description: "Draw absolute box overlay."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Entity
returns:
---
diff --git a/docs/classes/Entity/DrawBBoxOverlay.md b/docs/classes/Entity/DrawBBoxOverlay.md
index 1064c2a4a3..d0ea8cc0a1 100644
--- a/docs/classes/Entity/DrawBBoxOverlay.md
+++ b/docs/classes/Entity/DrawBBoxOverlay.md
@@ -14,8 +14,12 @@ lua:
description: "Draw bounding box overlay."
arguments:
- - name: "duration"
- type: number
+ - position: 1
+ name: "entity"
+ type: Entity
+ - position: 2
+ name: "duration"
+ type: number
returns:
---
diff --git a/docs/classes/Entity/DrawClientHitboxes.md b/docs/classes/Entity/DrawClientHitboxes.md
index 2ee9509947..d824bf2e6a 100644
--- a/docs/classes/Entity/DrawClientHitboxes.md
+++ b/docs/classes/Entity/DrawClientHitboxes.md
@@ -14,12 +14,17 @@ lua:
description: "Draw the client hitboxes."
arguments:
- - name: "duration"
- type: number
- default: "0.0f"
- - name: "monoColor"
- type: boolean
- default: "false"
+ - position: 1
+ name: "entity"
+ type: Entity
+ - position: 2
+ name: "duration"
+ type: number
+ default: "0.0f"
+ - position: 3
+ name: "monoColor"
+ type: boolean
+ default: "false"
returns:
---
diff --git a/docs/classes/Entity/DrawDebugGeometryOverlays.md b/docs/classes/Entity/DrawDebugGeometryOverlays.md
index cd22384893..98583accd9 100644
--- a/docs/classes/Entity/DrawDebugGeometryOverlays.md
+++ b/docs/classes/Entity/DrawDebugGeometryOverlays.md
@@ -13,7 +13,10 @@ lua:
realm: server
description: "Draw debug geometry overlays."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Entity
returns:
---
diff --git a/docs/classes/Entity/DrawDebugTextOverlays.md b/docs/classes/Entity/DrawDebugTextOverlays.md
index ec47baf12b..e9263f9fb1 100644
--- a/docs/classes/Entity/DrawDebugTextOverlays.md
+++ b/docs/classes/Entity/DrawDebugTextOverlays.md
@@ -13,7 +13,10 @@ lua:
realm: server
description: "Draw debug text overlays."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Entity
returns:
- type: integer
description: "The number of overlays"
diff --git a/docs/classes/Entity/DrawModel.md b/docs/classes/Entity/DrawModel.md
index f6519e6d4f..e71de84571 100644
--- a/docs/classes/Entity/DrawModel.md
+++ b/docs/classes/Entity/DrawModel.md
@@ -14,9 +14,13 @@ lua:
description: "Draw model."
arguments:
- - name: "flags"
- type: number
- default: "STUDIO_RENDER"
+ - position: 1
+ name: "entity"
+ type: Entity
+ - position: 2
+ name: "flags"
+ type: number
+ default: "STUDIO_RENDER"
returns:
- type: integer
description: "Draw model result."
diff --git a/docs/classes/Entity/DrawRBoxOverlay.md b/docs/classes/Entity/DrawRBoxOverlay.md
index 83c85afaf6..fb2e6113dc 100644
--- a/docs/classes/Entity/DrawRBoxOverlay.md
+++ b/docs/classes/Entity/DrawRBoxOverlay.md
@@ -13,7 +13,10 @@ lua:
realm: server
description: "Draw rotated box overlay."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Entity
returns:
---
diff --git a/docs/classes/Entity/DrawTimedOverlays.md b/docs/classes/Entity/DrawTimedOverlays.md
index 078ef5cc73..05ee6c2a29 100644
--- a/docs/classes/Entity/DrawTimedOverlays.md
+++ b/docs/classes/Entity/DrawTimedOverlays.md
@@ -13,7 +13,10 @@ lua:
realm: server
description: "Draw timed overlays."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Entity
returns:
---
diff --git a/docs/classes/Entity/DropToFloor.md b/docs/classes/Entity/DropToFloor.md
index 32c7c973ea..186fd37683 100644
--- a/docs/classes/Entity/DropToFloor.md
+++ b/docs/classes/Entity/DropToFloor.md
@@ -14,12 +14,17 @@ lua:
description: "Drops the entity to the floor."
arguments:
- - name: "mask"
- type: integer
- default: "MASK_SOLID"
- - name: "ignore"
- type: Entity
- default: "NULL"
+ - position: 1
+ name: "entity"
+ type: Entity
+ - position: 2
+ name: "mask"
+ type: integer
+ default: "MASK_SOLID"
+ - position: 3
+ name: "ignore"
+ type: Entity
+ default: "NULL"
returns:
- type: integer
description: "-1 if the floor to drop to isn't valid. 0 if nothing changed. 1 if the entity dropped to the floor"
diff --git a/docs/classes/Entity/DumpResponseCriteria.md b/docs/classes/Entity/DumpResponseCriteria.md
index a11cf5ec03..eea14678db 100644
--- a/docs/classes/Entity/DumpResponseCriteria.md
+++ b/docs/classes/Entity/DumpResponseCriteria.md
@@ -13,7 +13,10 @@ lua:
realm: server
description: "Dump response criteria."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Entity
returns:
---
diff --git a/docs/classes/Entity/EmitAmbientSound.md b/docs/classes/Entity/EmitAmbientSound.md
index 2ca0394b55..7cca29772a 100644
--- a/docs/classes/Entity/EmitAmbientSound.md
+++ b/docs/classes/Entity/EmitAmbientSound.md
@@ -15,18 +15,23 @@ lua:
static: true
arguments:
- - name: "soundIndex"
- type: number
- - name: "origin"
- type: Vector
- - name: "soundName"
- type: string
- - name: "flags"
- type: number
- default: "0"
- - name: "soundTime"
- type: number
- default: "0"
+ - position: 1
+ name: "soundIndex"
+ type: number
+ - position: 2
+ name: "origin"
+ type: Vector
+ - position: 3
+ name: "soundName"
+ type: string
+ - position: 4
+ name: "flags"
+ type: number
+ default: "0"
+ - position: 5
+ name: "soundTime"
+ type: number
+ default: "0"
returns:
---
diff --git a/docs/classes/Entity/EmitSound.md b/docs/classes/Entity/EmitSound.md
index 16e62d35ec..a9334055a5 100644
--- a/docs/classes/Entity/EmitSound.md
+++ b/docs/classes/Entity/EmitSound.md
@@ -14,29 +14,40 @@ lua:
description: "Emit sound."
arguments:
- - name: "soundName"
- type: string
- - name: "soundLevel"
- type: enumeration/SOUND_LEVEL
- default: "SNDLVL_NORM"
- - name: "pitchPercent"
- type: number
- default: "100"
- - name: "volume"
- type: number
- default: "1"
- - name: "channel"
- type: number
- default: "pEntity->IsWeapon() ? CHAN_WEAPON : CHAN_AUTO"
- - name: "soundFlags"
- type: number
- default: "0"
- - name: "dsp"
- type: number
- default: "0"
- - name: "filter"
- type: RecipientFilter
- nillable: true
+ - position: 1
+ name: "entity"
+ type: Entity
+ - position: 2
+ name: "soundName"
+ type: string
+ - position: 3
+ name: "soundLevel"
+ type: enumeration/SOUND_LEVEL
+ default: "SNDLVL_NORM"
+ - position: 4
+ name: "pitchPercent"
+ type: number
+ default: "100"
+ - position: 5
+ name: "volume"
+ type: number
+ default: "1"
+ - position: 6
+ name: "channel"
+ type: number
+ default: "pEntity->IsWeapon() ? CHAN_WEAPON : CHAN_AUTO"
+ - position: 7
+ name: "soundFlags"
+ type: number
+ default: "0"
+ - position: 8
+ name: "dsp"
+ type: number
+ default: "0"
+ - position: 9
+ name: "filter"
+ type: RecipientFilter
+ nillable: true
returns:
- type: number
description: "The sound duration."
diff --git a/docs/classes/Entity/EnableInToolView.md b/docs/classes/Entity/EnableInToolView.md
index e5b654381b..cd778c1e72 100644
--- a/docs/classes/Entity/EnableInToolView.md
+++ b/docs/classes/Entity/EnableInToolView.md
@@ -14,8 +14,12 @@ lua:
description: "Enable in tool view."
arguments:
- - name: "enable"
- type: boolean
+ - position: 1
+ name: "entity"
+ type: Entity
+ - position: 2
+ name: "enable"
+ type: boolean
returns:
---
diff --git a/docs/classes/Entity/EndBlockedByEntity.md b/docs/classes/Entity/EndBlockedByEntity.md
index bd3b0b1c0a..c80f49cefd 100644
--- a/docs/classes/Entity/EndBlockedByEntity.md
+++ b/docs/classes/Entity/EndBlockedByEntity.md
@@ -13,7 +13,10 @@ lua:
realm: server
description: "End blocked."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Entity
returns:
---
diff --git a/docs/classes/Entity/EndGroundContact.md b/docs/classes/Entity/EndGroundContact.md
index 861db92338..a075fb4fb9 100644
--- a/docs/classes/Entity/EndGroundContact.md
+++ b/docs/classes/Entity/EndGroundContact.md
@@ -14,8 +14,12 @@ lua:
description: "End ground contact."
arguments:
- - name: "ground"
- type: Entity
+ - position: 1
+ name: "entity"
+ type: Entity
+ - position: 2
+ name: "ground"
+ type: Entity
returns:
---
diff --git a/docs/classes/Entity/EndTouch.md b/docs/classes/Entity/EndTouch.md
index 47389efe5b..0d0470a4eb 100644
--- a/docs/classes/Entity/EndTouch.md
+++ b/docs/classes/Entity/EndTouch.md
@@ -14,8 +14,12 @@ lua:
description: "End touch."
arguments:
- - name: "other"
- type: Entity
+ - position: 1
+ name: "entity"
+ type: Entity
+ - position: 2
+ name: "other"
+ type: Entity
returns:
---
diff --git a/docs/classes/Entity/EntityText.md b/docs/classes/Entity/EntityText.md
index 0730245e74..7299a9066c 100644
--- a/docs/classes/Entity/EntityText.md
+++ b/docs/classes/Entity/EntityText.md
@@ -14,20 +14,30 @@ lua:
description: "Entity text."
arguments:
- - name: "textOffset"
- type: number
- - name: "text"
- type: string
- - name: "duration"
- type: number
- - name: "r"
- type: number
- - name: "g"
- type: number
- - name: "b"
- type: number
- - name: "a"
- type: number
+ - position: 1
+ name: "entity"
+ type: Entity
+ - position: 2
+ name: "textOffset"
+ type: number
+ - position: 3
+ name: "text"
+ type: string
+ - position: 4
+ name: "duration"
+ type: number
+ - position: 5
+ name: "r"
+ type: number
+ - position: 6
+ name: "g"
+ type: number
+ - position: 7
+ name: "b"
+ type: number
+ - position: 8
+ name: "a"
+ type: number
returns:
---
diff --git a/docs/classes/Entity/EntityToWorldSpace.md b/docs/classes/Entity/EntityToWorldSpace.md
index 1f4ec91237..1ef192b482 100644
--- a/docs/classes/Entity/EntityToWorldSpace.md
+++ b/docs/classes/Entity/EntityToWorldSpace.md
@@ -14,8 +14,12 @@ lua:
description: "Entity to world space."
arguments:
- - name: "local"
- type: Vector
+ - position: 1
+ name: "entity"
+ type: Entity
+ - position: 2
+ name: "local"
+ type: Vector
returns:
- type: Vector
description: "The world space vector."
diff --git a/docs/classes/Entity/Extinguish.md b/docs/classes/Entity/Extinguish.md
index 4b683dae4f..3361775939 100644
--- a/docs/classes/Entity/Extinguish.md
+++ b/docs/classes/Entity/Extinguish.md
@@ -13,7 +13,10 @@ lua:
realm: server
description: "Extinguish the entity."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Entity
returns:
---
diff --git a/docs/classes/Entity/FadeOut.md b/docs/classes/Entity/FadeOut.md
index e9d9cf0b00..db9eb37bb1 100644
--- a/docs/classes/Entity/FadeOut.md
+++ b/docs/classes/Entity/FadeOut.md
@@ -13,7 +13,10 @@ lua:
realm: server
description: "Fade out."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Entity
returns:
---
diff --git a/docs/classes/Entity/FindBodyGroupByName.md b/docs/classes/Entity/FindBodyGroupByName.md
index b3871cceee..b715456388 100644
--- a/docs/classes/Entity/FindBodyGroupByName.md
+++ b/docs/classes/Entity/FindBodyGroupByName.md
@@ -14,8 +14,12 @@ lua:
description: "Find the bodygroup id by the bodygroup name"
arguments:
- - name: "bodyGroupName"
- type: string
+ - position: 1
+ name: "entity"
+ type: Entity
+ - position: 2
+ name: "bodyGroupName"
+ type: string
returns:
- type: integer
description: "The bodygroup id"
diff --git a/docs/classes/Entity/FindFollowedEntity.md b/docs/classes/Entity/FindFollowedEntity.md
index 3cee796d45..38ee362dc7 100644
--- a/docs/classes/Entity/FindFollowedEntity.md
+++ b/docs/classes/Entity/FindFollowedEntity.md
@@ -13,7 +13,10 @@ lua:
realm: client
description: "Find the followed entity."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Entity
returns:
- type: Entity
description: "The followed entity"
diff --git a/docs/classes/Entity/FindTransitionSequence.md b/docs/classes/Entity/FindTransitionSequence.md
index dde78fff8c..027dbe3e0f 100644
--- a/docs/classes/Entity/FindTransitionSequence.md
+++ b/docs/classes/Entity/FindTransitionSequence.md
@@ -14,10 +14,15 @@ lua:
description: "Find the transition sequence."
arguments:
- - name: "sequence"
- type: number
- - name: "goalSequence"
- type: number
+ - position: 1
+ name: "entity"
+ type: Entity
+ - position: 2
+ name: "sequence"
+ type: number
+ - position: 3
+ name: "goalSequence"
+ type: number
returns:
- type: integer
description: "The transition sequence"
diff --git a/docs/classes/Entity/FireBullets.md b/docs/classes/Entity/FireBullets.md
index 58fdfbf98c..c9d68935d6 100644
--- a/docs/classes/Entity/FireBullets.md
+++ b/docs/classes/Entity/FireBullets.md
@@ -14,8 +14,12 @@ lua:
description: "Fire bullets."
arguments:
- - name: "info"
- type: FireBulletsInfo
+ - position: 1
+ name: "entity"
+ type: Entity
+ - position: 2
+ name: "info"
+ type: FireBulletsInfo
returns:
---
diff --git a/docs/classes/Entity/FireEvent.md b/docs/classes/Entity/FireEvent.md
index 05e88b0deb..09c1bc23a7 100644
--- a/docs/classes/Entity/FireEvent.md
+++ b/docs/classes/Entity/FireEvent.md
@@ -14,14 +14,21 @@ lua:
description: "Fire an event."
arguments:
- - name: "origin"
- type: Vector
- - name: "angles"
- type: Angle
- - name: "event"
- type: number
- - name: "options"
- type: string
+ - position: 1
+ name: "entity"
+ type: Entity
+ - position: 2
+ name: "origin"
+ type: Vector
+ - position: 3
+ name: "angles"
+ type: Angle
+ - position: 4
+ name: "event"
+ type: number
+ - position: 5
+ name: "options"
+ type: string
returns:
---
diff --git a/docs/classes/Entity/FireObsoleteEvent.md b/docs/classes/Entity/FireObsoleteEvent.md
index 1cc763f0e6..572d9a3f42 100644
--- a/docs/classes/Entity/FireObsoleteEvent.md
+++ b/docs/classes/Entity/FireObsoleteEvent.md
@@ -14,14 +14,21 @@ lua:
description: "These events are all obsolete events, left here to support old games. Their systems have all been replaced with better ones."
arguments:
- - name: "origin"
- type: Vector
- - name: "angles"
- type: Angle
- - name: "event"
- type: number
- - name: "options"
- type: string
+ - position: 1
+ name: "entity"
+ type: Entity
+ - position: 2
+ name: "origin"
+ type: Vector
+ - position: 3
+ name: "angles"
+ type: Angle
+ - position: 4
+ name: "event"
+ type: number
+ - position: 5
+ name: "options"
+ type: string
returns:
---
diff --git a/docs/classes/Entity/FollowEntity.md b/docs/classes/Entity/FollowEntity.md
index 33c935acda..70563b88ec 100644
--- a/docs/classes/Entity/FollowEntity.md
+++ b/docs/classes/Entity/FollowEntity.md
@@ -14,10 +14,15 @@ lua:
description: "Follow entity."
arguments:
- - name: "target"
- type: Entity
- - name: "boneMerge"
- type: boolean
+ - position: 1
+ name: "entity"
+ type: Entity
+ - position: 2
+ name: "target"
+ type: Entity
+ - position: 3
+ name: "boneMerge"
+ type: boolean
returns:
---
diff --git a/docs/classes/Entity/ForceClientSideAnimationOn.md b/docs/classes/Entity/ForceClientSideAnimationOn.md
index 43039086e1..5a0637b6a3 100644
--- a/docs/classes/Entity/ForceClientSideAnimationOn.md
+++ b/docs/classes/Entity/ForceClientSideAnimationOn.md
@@ -13,7 +13,10 @@ lua:
realm: client
description: "This can be used to force client side animation to be on. Only use if you know what you're doing! Normally, the server entity should set this."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Entity
returns:
---
diff --git a/docs/classes/Entity/FrameAdvance.md b/docs/classes/Entity/FrameAdvance.md
index 449990b9c0..15653bd63c 100644
--- a/docs/classes/Entity/FrameAdvance.md
+++ b/docs/classes/Entity/FrameAdvance.md
@@ -14,9 +14,13 @@ lua:
description: "Advance the frame."
arguments:
- - name: "interval"
- type: number
- default: "0.0f"
+ - position: 1
+ name: "entity"
+ type: Entity
+ - position: 2
+ name: "interval"
+ type: number
+ default: "0.0f"
returns:
- type: number
description: "The new cycle"
diff --git a/docs/classes/Entity/GenderExpandString.md b/docs/classes/Entity/GenderExpandString.md
index e8ab456170..08e7ea946f 100644
--- a/docs/classes/Entity/GenderExpandString.md
+++ b/docs/classes/Entity/GenderExpandString.md
@@ -14,8 +14,12 @@ lua:
description: "Expands any $gender tags in the string into male or female tags based on the gender of the actor (based on his/her .mdl). Used for filesnames only. The returned string is at most 260 characters long."
arguments:
- - name: "string"
- type: string
+ - position: 1
+ name: "entity"
+ type: Entity
+ - position: 2
+ name: "string"
+ type: string
returns:
- type: string
description: "The expanded string."
diff --git a/docs/classes/Entity/GetAimEntOrigin.md b/docs/classes/Entity/GetAimEntOrigin.md
index d59c9cc97e..dcd1feee49 100644
--- a/docs/classes/Entity/GetAimEntOrigin.md
+++ b/docs/classes/Entity/GetAimEntOrigin.md
@@ -14,8 +14,12 @@ lua:
description: "Get the aim entity origin."
arguments:
- - name: "attachedTo"
- type: Entity
+ - position: 1
+ name: "entity"
+ type: Entity
+ - position: 2
+ name: "attachedTo"
+ type: Entity
returns:
- type: Vector
description: "The aim entity origin"
diff --git a/docs/classes/Entity/GetAngles.md b/docs/classes/Entity/GetAngles.md
index 59d239bdf2..1d1d7e126f 100644
--- a/docs/classes/Entity/GetAngles.md
+++ b/docs/classes/Entity/GetAngles.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Get absolute angles."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Entity
returns:
- type: Angle
description: "The absolute angles."
diff --git a/docs/classes/Entity/GetAnimTimeInterval.md b/docs/classes/Entity/GetAnimTimeInterval.md
index 7b6a76aa45..b0463488d5 100644
--- a/docs/classes/Entity/GetAnimTimeInterval.md
+++ b/docs/classes/Entity/GetAnimTimeInterval.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Get the animation time interval."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Entity
returns:
- type: number
description: "The animation time interval"
diff --git a/docs/classes/Entity/GetAnimationTime.md b/docs/classes/Entity/GetAnimationTime.md
index 7befb582fd..94a749ac6a 100644
--- a/docs/classes/Entity/GetAnimationTime.md
+++ b/docs/classes/Entity/GetAnimationTime.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Get animation time."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Entity
returns:
- type: number
description: "The animation time."
diff --git a/docs/classes/Entity/GetAttachment.md b/docs/classes/Entity/GetAttachment.md
index dac02c7332..3aa898a1ca 100644
--- a/docs/classes/Entity/GetAttachment.md
+++ b/docs/classes/Entity/GetAttachment.md
@@ -13,11 +13,14 @@ lua:
realm: shared
description: "Get the attachment table for the specified attachment (by bone id or attachment name)"
- argumentSets:
- - arguments:
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Entity
+ - position: 2
+ types:
- name: "boneId"
type: number
- - arguments:
- name: "attachmentName"
type: string
returns:
diff --git a/docs/classes/Entity/GetAttachmentLocal.md b/docs/classes/Entity/GetAttachmentLocal.md
index 45ffd75f07..f9c8ffba9d 100644
--- a/docs/classes/Entity/GetAttachmentLocal.md
+++ b/docs/classes/Entity/GetAttachmentLocal.md
@@ -14,8 +14,12 @@ lua:
description: "Get the local attachment."
arguments:
- - name: "attachment"
- type: number
+ - position: 1
+ name: "entity"
+ type: Entity
+ - position: 2
+ name: "attachment"
+ type: number
returns:
- type: boolean
description: "Whether the operation was successful"
diff --git a/docs/classes/Entity/GetAttachmentVelocity.md b/docs/classes/Entity/GetAttachmentVelocity.md
index 54d2348be6..b9ea932f94 100644
--- a/docs/classes/Entity/GetAttachmentVelocity.md
+++ b/docs/classes/Entity/GetAttachmentVelocity.md
@@ -14,8 +14,12 @@ lua:
description: "Get the attachment velocity."
arguments:
- - name: "attachment"
- type: number
+ - position: 1
+ name: "entity"
+ type: Entity
+ - position: 2
+ name: "attachment"
+ type: number
returns:
- type: boolean
description: "Whether the operation was successful"
diff --git a/docs/classes/Entity/GetAutoAimCenter.md b/docs/classes/Entity/GetAutoAimCenter.md
index 7de6f262d5..b6e948c727 100644
--- a/docs/classes/Entity/GetAutoAimCenter.md
+++ b/docs/classes/Entity/GetAutoAimCenter.md
@@ -13,7 +13,10 @@ lua:
realm: server
description: "Get auto aim center."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Entity
returns:
- type: Vector
description: "The auto aim center"
diff --git a/docs/classes/Entity/GetAutoAimRadius.md b/docs/classes/Entity/GetAutoAimRadius.md
index f414756b73..713cb77b03 100644
--- a/docs/classes/Entity/GetAutoAimRadius.md
+++ b/docs/classes/Entity/GetAutoAimRadius.md
@@ -13,7 +13,10 @@ lua:
realm: server
description: "Get auto aim radius."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Entity
returns:
- type: number
description: "The auto aim radius"
diff --git a/docs/classes/Entity/GetBaseVelocity.md b/docs/classes/Entity/GetBaseVelocity.md
index fb80445bc5..cef81c7fac 100644
--- a/docs/classes/Entity/GetBaseVelocity.md
+++ b/docs/classes/Entity/GetBaseVelocity.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Get base velocity."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Entity
returns:
- type: Vector
description: "The base velocity."
diff --git a/docs/classes/Entity/GetBlendedLinearVelocity.md b/docs/classes/Entity/GetBlendedLinearVelocity.md
index 7f9bc321c7..e17532e228 100644
--- a/docs/classes/Entity/GetBlendedLinearVelocity.md
+++ b/docs/classes/Entity/GetBlendedLinearVelocity.md
@@ -13,7 +13,10 @@ lua:
realm: client
description: "Get the blended linear velocity."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Entity
returns:
- type: Vector
description: "The blended linear velocity"
diff --git a/docs/classes/Entity/GetBlocksLineOfSight.md b/docs/classes/Entity/GetBlocksLineOfSight.md
index 18b0f9deab..9cdb7ee1fe 100644
--- a/docs/classes/Entity/GetBlocksLineOfSight.md
+++ b/docs/classes/Entity/GetBlocksLineOfSight.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Whether this entity blocks line of sight."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Entity
returns:
- type: boolean
description: "True if the entity blocks line of sight, false otherwise."
diff --git a/docs/classes/Entity/GetBloodColorType.md b/docs/classes/Entity/GetBloodColorType.md
index 123c8c8179..b97184127f 100644
--- a/docs/classes/Entity/GetBloodColorType.md
+++ b/docs/classes/Entity/GetBloodColorType.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Blood type."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Entity
returns:
- type: enumeration/BLOOD_COLOR
description: "The blood type."
diff --git a/docs/classes/Entity/GetBody.md b/docs/classes/Entity/GetBody.md
index 029badbd9c..dc296d996a 100644
--- a/docs/classes/Entity/GetBody.md
+++ b/docs/classes/Entity/GetBody.md
@@ -13,7 +13,10 @@ lua:
realm: client
description: "Get the body (internally described as 'Object bodygroup'?)."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Entity
returns:
- type: integer
description: "The body"
diff --git a/docs/classes/Entity/GetBodyGroup.md b/docs/classes/Entity/GetBodyGroup.md
index 9e9629d769..8506c8e8c0 100644
--- a/docs/classes/Entity/GetBodyGroup.md
+++ b/docs/classes/Entity/GetBodyGroup.md
@@ -14,8 +14,12 @@ lua:
description: "Get the bodygroup value by the bodygroup id"
arguments:
- - name: "bodyGroupId"
- type: number
+ - position: 1
+ name: "entity"
+ type: Entity
+ - position: 2
+ name: "bodyGroupId"
+ type: number
returns:
- type: integer
description: "The bodygroup value"
diff --git a/docs/classes/Entity/GetBodyGroupCount.md b/docs/classes/Entity/GetBodyGroupCount.md
index d09cf3dd13..297d8c8278 100644
--- a/docs/classes/Entity/GetBodyGroupCount.md
+++ b/docs/classes/Entity/GetBodyGroupCount.md
@@ -14,8 +14,12 @@ lua:
description: "Get the number of bodygroups"
arguments:
- - name: "bodyGroupId"
- type: number
+ - position: 1
+ name: "entity"
+ type: Entity
+ - position: 2
+ name: "bodyGroupId"
+ type: number
returns:
- type: integer
description: "The number of bodygroups"
diff --git a/docs/classes/Entity/GetBodyGroupName.md b/docs/classes/Entity/GetBodyGroupName.md
index f66e3aa2b6..e928b776f3 100644
--- a/docs/classes/Entity/GetBodyGroupName.md
+++ b/docs/classes/Entity/GetBodyGroupName.md
@@ -14,8 +14,12 @@ lua:
description: "Get the bodygroup name by the bodygroup id"
arguments:
- - name: "bodyGroupId"
- type: number
+ - position: 1
+ name: "entity"
+ type: Entity
+ - position: 2
+ name: "bodyGroupId"
+ type: number
returns:
- type: string
description: "The bodygroup name"
diff --git a/docs/classes/Entity/GetBodyGroups.md b/docs/classes/Entity/GetBodyGroups.md
index b934e35a06..7c0d8775be 100644
--- a/docs/classes/Entity/GetBodyGroups.md
+++ b/docs/classes/Entity/GetBodyGroups.md
@@ -11,14 +11,17 @@ lua:
library: Entity
function: GetBodyGroups
realm: shared
- description: "Get the bodygroup values as a string of hexadecimal values. Each hexadecimal character represents the bodygroup at its index, e.g: 0a00001 means bodygroup 1 is 10(a) and bodygroup 6 is 1, the rest are 0"
-
+ description: "Get the bodygroup values as a table"
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Entity
returns:
- - type: string
- description: "The bodygroup values as a string of hexadecimal values"
+ - type: table
+ description: "The bodygroup values"
---
-Entity:GetBodyGroups – Get the bodygroup values as a string of hexadecimal values. Each hexadecimal character represents the bodygroup at its index, e.g: 0a00001 means bodygroup 1 is 10(a) and bodygroup 6 is 1, the rest are 0
+Entity:GetBodyGroups – Get the bodygroup values as a table
diff --git a/docs/classes/Entity/GetBodyGroupsAsString.md b/docs/classes/Entity/GetBodyGroupsAsString.md
new file mode 100644
index 0000000000..c6474bbf4d
--- /dev/null
+++ b/docs/classes/Entity/GetBodyGroupsAsString.md
@@ -0,0 +1,27 @@
+---
+template: lua-class-function.html
+title: GetBodyGroupsAsString
+icon: lua-shared
+tags:
+ - lua
+ - shared
+ - needs-verification
+ - needs-example
+lua:
+ library: Entity
+ function: GetBodyGroupsAsString
+ realm: shared
+ description: "Get the bodygroup values as a string of hexadecimal values. Each hexadecimal character represents the bodygroup at its index, e.g: 0a00001 means bodygroup 1 is 10(a) and bodygroup 6 is 1, the rest are 0"
+
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Entity
+ returns:
+ - type: string
+ description: "The bodygroup values as a string of hexadecimal values"
+---
+
+
+Entity:GetBodyGroupsAsString – Get the bodygroup values as a string of hexadecimal values. Each hexadecimal character represents the bodygroup at its index, e.g: 0a00001 means bodygroup 1 is 10(a) and bodygroup 6 is 1, the rest are 0
+
diff --git a/docs/classes/Entity/GetBodyGroupsCount.md b/docs/classes/Entity/GetBodyGroupsCount.md
index 29ad60d21b..850c290c07 100644
--- a/docs/classes/Entity/GetBodyGroupsCount.md
+++ b/docs/classes/Entity/GetBodyGroupsCount.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Get the number of bodygroups"
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Entity
returns:
- type: integer
description: "The number of bodygroups this model has"
diff --git a/docs/classes/Entity/GetBoneControllers.md b/docs/classes/Entity/GetBoneControllers.md
index 148443989b..88bce6eca7 100644
--- a/docs/classes/Entity/GetBoneControllers.md
+++ b/docs/classes/Entity/GetBoneControllers.md
@@ -13,7 +13,10 @@ lua:
realm: client
description: "Get all bone controller values."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Entity
returns:
- type: table
description: "The bone controller values"
diff --git a/docs/classes/Entity/GetBoneCount.md b/docs/classes/Entity/GetBoneCount.md
new file mode 100644
index 0000000000..76a2967b91
--- /dev/null
+++ b/docs/classes/Entity/GetBoneCount.md
@@ -0,0 +1,27 @@
+---
+template: lua-class-function.html
+title: GetBoneCount
+icon: lua-shared
+tags:
+ - lua
+ - shared
+ - needs-verification
+ - needs-example
+lua:
+ library: Entity
+ function: GetBoneCount
+ realm: shared
+ description: "Get the amount of bones this entity has in its model."
+
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Entity
+ returns:
+ - type: integer
+ description: "The amount of bones"
+---
+
+
-Entity:GetEntityIndex – Get entity index.
+Entity:GetEntityIndex – Get entity index. Returns 0 for NULL entities.
diff --git a/docs/classes/Entity/GetEntityName.md b/docs/classes/Entity/GetEntityName.md
index 04a0a79a5e..40c1455fc9 100644
--- a/docs/classes/Entity/GetEntityName.md
+++ b/docs/classes/Entity/GetEntityName.md
@@ -13,7 +13,10 @@ lua:
realm: server
description: "Get entity name."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Entity
returns:
- type: string
description: "The entity name"
diff --git a/docs/classes/Entity/GetEntitySkybox.md b/docs/classes/Entity/GetEntitySkybox.md
index 86537d8941..ddb6616349 100644
--- a/docs/classes/Entity/GetEntitySkybox.md
+++ b/docs/classes/Entity/GetEntitySkybox.md
@@ -13,7 +13,10 @@ lua:
realm: server
description: "Returns the sky camera of the skybox the entity is in."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Entity
returns:
---
diff --git a/docs/classes/Entity/GetEyeAngles.md b/docs/classes/Entity/GetEyeAngles.md
index 1fef59c71f..7b8821ced8 100644
--- a/docs/classes/Entity/GetEyeAngles.md
+++ b/docs/classes/Entity/GetEyeAngles.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Get eye angles."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Entity
returns:
- type: Angle
description: "The eye angles."
diff --git a/docs/classes/Entity/GetEyePosition.md b/docs/classes/Entity/GetEyePosition.md
index 4484dffed0..c968ad6d6f 100644
--- a/docs/classes/Entity/GetEyePosition.md
+++ b/docs/classes/Entity/GetEyePosition.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Get eye position."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Entity
returns:
- type: Vector
description: "The eye position."
diff --git a/docs/classes/Entity/GetFirstMoveChild.md b/docs/classes/Entity/GetFirstMoveChild.md
index b8263effb1..0847c7a434 100644
--- a/docs/classes/Entity/GetFirstMoveChild.md
+++ b/docs/classes/Entity/GetFirstMoveChild.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Get first move child."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Entity
returns:
- type: Entity
description: "The first move child."
diff --git a/docs/classes/Entity/GetFirstThinkTick.md b/docs/classes/Entity/GetFirstThinkTick.md
index 0db43cbd63..7c1f28c743 100644
--- a/docs/classes/Entity/GetFirstThinkTick.md
+++ b/docs/classes/Entity/GetFirstThinkTick.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Get first think tick."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Entity
returns:
- type: integer
description: "The first think tick."
diff --git a/docs/classes/Entity/GetFlags.md b/docs/classes/Entity/GetFlags.md
index 79db9f26e4..f0770fffa7 100644
--- a/docs/classes/Entity/GetFlags.md
+++ b/docs/classes/Entity/GetFlags.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Get flags."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Entity
returns:
- type: integer
description: "The flags."
diff --git a/docs/classes/Entity/GetFlexBounds.md b/docs/classes/Entity/GetFlexBounds.md
index 29b8e6d1a0..02486a9076 100644
--- a/docs/classes/Entity/GetFlexBounds.md
+++ b/docs/classes/Entity/GetFlexBounds.md
@@ -14,8 +14,12 @@ lua:
description: "Returns the min and max values for the target flex controller"
arguments:
- - name: "flexControllerIndex"
- type: number
+ - position: 1
+ name: "entity"
+ type: Entity
+ - position: 2
+ name: "flexControllerIndex"
+ type: number
returns:
- type: number
description: "The min value"
diff --git a/docs/classes/Entity/GetFlexControllerName.md b/docs/classes/Entity/GetFlexControllerName.md
index e661c8c86e..4ba216a26d 100644
--- a/docs/classes/Entity/GetFlexControllerName.md
+++ b/docs/classes/Entity/GetFlexControllerName.md
@@ -14,8 +14,12 @@ lua:
description: "Get the flex controller name."
arguments:
- - name: "flexControllerIndex"
- type: number
+ - position: 1
+ name: "entity"
+ type: Entity
+ - position: 2
+ name: "flexControllerIndex"
+ type: number
returns:
- type: string
description: "The flex controller name"
diff --git a/docs/classes/Entity/GetFlexControllerType.md b/docs/classes/Entity/GetFlexControllerType.md
index cc5c706ebb..0d62c596df 100644
--- a/docs/classes/Entity/GetFlexControllerType.md
+++ b/docs/classes/Entity/GetFlexControllerType.md
@@ -14,8 +14,12 @@ lua:
description: "Get the flex controller type."
arguments:
- - name: "flexControllerIndex"
- type: number
+ - position: 1
+ name: "entity"
+ type: Entity
+ - position: 2
+ name: "flexControllerIndex"
+ type: number
returns:
- type: string
description: "The flex controller type"
diff --git a/docs/classes/Entity/GetFlexCount.md b/docs/classes/Entity/GetFlexCount.md
index 7c7ffadb65..dbc1000fee 100644
--- a/docs/classes/Entity/GetFlexCount.md
+++ b/docs/classes/Entity/GetFlexCount.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Get the number of flex controllers"
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Entity
returns:
- type: integer
description: "The number of flex controllers"
diff --git a/docs/classes/Entity/GetFlexDescFacs.md b/docs/classes/Entity/GetFlexDescFacs.md
index 239bc9daf4..01f149cb5b 100644
--- a/docs/classes/Entity/GetFlexDescFacs.md
+++ b/docs/classes/Entity/GetFlexDescFacs.md
@@ -14,8 +14,12 @@ lua:
description: "Get the flex desc facs."
arguments:
- - name: "flexDescIndex"
- type: number
+ - position: 1
+ name: "entity"
+ type: Entity
+ - position: 2
+ name: "flexDescIndex"
+ type: number
returns:
- type: string
description: "The flex desc facs"
diff --git a/docs/classes/Entity/GetFlexIdByName.md b/docs/classes/Entity/GetFlexIdByName.md
index 9bc75a9da8..546555dac7 100644
--- a/docs/classes/Entity/GetFlexIdByName.md
+++ b/docs/classes/Entity/GetFlexIdByName.md
@@ -14,8 +14,12 @@ lua:
description: "Get flex ID by name."
arguments:
- - name: "flexName"
- type: string
+ - position: 1
+ name: "entity"
+ type: Entity
+ - position: 2
+ name: "flexName"
+ type: string
returns:
- type: integer
description: "Flex ID."
diff --git a/docs/classes/Entity/GetFlexName.md b/docs/classes/Entity/GetFlexName.md
index 47dc6a9e70..d466ca75bf 100644
--- a/docs/classes/Entity/GetFlexName.md
+++ b/docs/classes/Entity/GetFlexName.md
@@ -14,8 +14,12 @@ lua:
description: "Get the flex controller name by the flex controller index"
arguments:
- - name: "flexControllerIndex"
- type: number
+ - position: 1
+ name: "entity"
+ type: Entity
+ - position: 2
+ name: "flexControllerIndex"
+ type: number
returns:
- type: string
description: "The flex controller name"
diff --git a/docs/classes/Entity/GetFlexWeight.md b/docs/classes/Entity/GetFlexWeight.md
index e45e006ed0..de1cec491e 100644
--- a/docs/classes/Entity/GetFlexWeight.md
+++ b/docs/classes/Entity/GetFlexWeight.md
@@ -14,8 +14,12 @@ lua:
description: "Get flex weight."
arguments:
- - name: "flexId"
- type: number
+ - position: 1
+ name: "entity"
+ type: Entity
+ - position: 2
+ name: "flexId"
+ type: number
returns:
- type: number
description: "Flex weight."
diff --git a/docs/classes/Entity/GetFollowedEntity.md b/docs/classes/Entity/GetFollowedEntity.md
index ef0b1cd1ee..136044f70e 100644
--- a/docs/classes/Entity/GetFollowedEntity.md
+++ b/docs/classes/Entity/GetFollowedEntity.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Get followed entity."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Entity
returns:
- type: Entity
description: "The followed entity."
diff --git a/docs/classes/Entity/GetFriction.md b/docs/classes/Entity/GetFriction.md
index 186ac29b88..77a7566b1a 100644
--- a/docs/classes/Entity/GetFriction.md
+++ b/docs/classes/Entity/GetFriction.md
@@ -13,7 +13,10 @@ lua:
realm: server
description: "Get friction."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Entity
returns:
- type: number
description: "The friction"
diff --git a/docs/classes/Entity/GetGravity.md b/docs/classes/Entity/GetGravity.md
index 3bc61a9721..a6b1eddffb 100644
--- a/docs/classes/Entity/GetGravity.md
+++ b/docs/classes/Entity/GetGravity.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Get gravity."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Entity
returns:
- type: number
description: "The gravity."
diff --git a/docs/classes/Entity/GetGroundChangeTime.md b/docs/classes/Entity/GetGroundChangeTime.md
index b00764d603..b891f324ed 100644
--- a/docs/classes/Entity/GetGroundChangeTime.md
+++ b/docs/classes/Entity/GetGroundChangeTime.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Get ground change time."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Entity
returns:
- type: number
description: "The ground change time."
diff --git a/docs/classes/Entity/GetGroundEntity.md b/docs/classes/Entity/GetGroundEntity.md
index 08d500a721..90dd6a2f1f 100644
--- a/docs/classes/Entity/GetGroundEntity.md
+++ b/docs/classes/Entity/GetGroundEntity.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Get ground entity."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Entity
returns:
- type: Entity
description: "The ground entity."
diff --git a/docs/classes/Entity/GetGroundVelocityToApply.md b/docs/classes/Entity/GetGroundVelocityToApply.md
index ee33c95b96..20c198cc69 100644
--- a/docs/classes/Entity/GetGroundVelocityToApply.md
+++ b/docs/classes/Entity/GetGroundVelocityToApply.md
@@ -13,7 +13,10 @@ lua:
realm: server
description: "Gets the velocity we impart to a player standing on us."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Entity
returns:
- type: Vector
description: "The ground velocity to apply"
diff --git a/docs/classes/Entity/GetHealth.md b/docs/classes/Entity/GetHealth.md
index b4aaf08b88..19e4c8cb67 100644
--- a/docs/classes/Entity/GetHealth.md
+++ b/docs/classes/Entity/GetHealth.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Get health."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Entity
returns:
- type: integer
description: "The health."
diff --git a/docs/classes/Entity/GetHitboxSet.md b/docs/classes/Entity/GetHitboxSet.md
index 79aba274f4..6adef8b021 100644
--- a/docs/classes/Entity/GetHitboxSet.md
+++ b/docs/classes/Entity/GetHitboxSet.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Get the index of the hitbox set in use."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Entity
returns:
- type: integer
description: "The hitbox set"
diff --git a/docs/classes/Entity/GetHitboxSetCount.md b/docs/classes/Entity/GetHitboxSetCount.md
index 397c87af6a..bcfee2d6ea 100644
--- a/docs/classes/Entity/GetHitboxSetCount.md
+++ b/docs/classes/Entity/GetHitboxSetCount.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Get the hitbox set count."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Entity
returns:
- type: integer
description: "The hitbox set count"
diff --git a/docs/classes/Entity/GetHitboxSetName.md b/docs/classes/Entity/GetHitboxSetName.md
index a54e043fcb..aa42e206ce 100644
--- a/docs/classes/Entity/GetHitboxSetName.md
+++ b/docs/classes/Entity/GetHitboxSetName.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Get the hitbox set name."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Entity
returns:
- type: string
description: "The hitbox set name"
diff --git a/docs/classes/Entity/GetInputDispatchEffectPosition.md b/docs/classes/Entity/GetInputDispatchEffectPosition.md
index b07920b1a8..dd199bb1b5 100644
--- a/docs/classes/Entity/GetInputDispatchEffectPosition.md
+++ b/docs/classes/Entity/GetInputDispatchEffectPosition.md
@@ -14,8 +14,12 @@ lua:
description: "Get input dispatch effect position."
arguments:
- - name: "input"
- type: string
+ - position: 1
+ name: "entity"
+ type: Entity
+ - position: 2
+ name: "input"
+ type: string
returns:
- type: vector, angle
description: "The position and angles"
diff --git a/docs/classes/Entity/GetKeyValue.md b/docs/classes/Entity/GetKeyValue.md
index d2fa733c77..2a84322dd8 100644
--- a/docs/classes/Entity/GetKeyValue.md
+++ b/docs/classes/Entity/GetKeyValue.md
@@ -14,8 +14,12 @@ lua:
description: "Get key value (the value is limited to 256 bytes)."
arguments:
- - name: "key"
- type: string
+ - position: 1
+ name: "entity"
+ type: Entity
+ - position: 2
+ name: "key"
+ type: string
returns:
- type: boolean
description: "True if key value exists, false otherwise."
diff --git a/docs/classes/Entity/GetLastThink.md b/docs/classes/Entity/GetLastThink.md
index 620f277462..3a24958a1c 100644
--- a/docs/classes/Entity/GetLastThink.md
+++ b/docs/classes/Entity/GetLastThink.md
@@ -14,9 +14,13 @@ lua:
description: "Get last think."
arguments:
- - name: "name"
- type: string
- default: "nullptr"
+ - position: 1
+ name: "entity"
+ type: Entity
+ - position: 2
+ name: "name"
+ type: string
+ default: "nullptr"
returns:
- type: number
description: "The last think."
diff --git a/docs/classes/Entity/GetLastThinkTick.md b/docs/classes/Entity/GetLastThinkTick.md
index 0ad194f8db..2645d05798 100644
--- a/docs/classes/Entity/GetLastThinkTick.md
+++ b/docs/classes/Entity/GetLastThinkTick.md
@@ -14,8 +14,12 @@ lua:
description: "Get last think tick."
arguments:
- - name: "name"
- type: string
+ - position: 1
+ name: "entity"
+ type: Entity
+ - position: 2
+ name: "name"
+ type: string
returns:
- type: integer
description: "The last think tick."
diff --git a/docs/classes/Entity/GetLifeState.md b/docs/classes/Entity/GetLifeState.md
index 138f0f4acd..cc2e5d0bf6 100644
--- a/docs/classes/Entity/GetLifeState.md
+++ b/docs/classes/Entity/GetLifeState.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Get the life state."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Entity
returns:
- type: enumeration/LIFE
description: "The life state."
diff --git a/docs/classes/Entity/GetLocalAngles.md b/docs/classes/Entity/GetLocalAngles.md
index 5f825286b4..fbf4c66c1b 100644
--- a/docs/classes/Entity/GetLocalAngles.md
+++ b/docs/classes/Entity/GetLocalAngles.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Get local angles."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Entity
returns:
- type: Angle
description: "The local angles."
diff --git a/docs/classes/Entity/GetLocalAngularVelocity.md b/docs/classes/Entity/GetLocalAngularVelocity.md
index b84b8b23d9..9323e3d0d9 100644
--- a/docs/classes/Entity/GetLocalAngularVelocity.md
+++ b/docs/classes/Entity/GetLocalAngularVelocity.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Get local angular velocity."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Entity
returns:
- type: Angle
description: "The local angular velocity."
diff --git a/docs/classes/Entity/GetLocalOrigin.md b/docs/classes/Entity/GetLocalOrigin.md
index 22e534f42d..780e4d702b 100644
--- a/docs/classes/Entity/GetLocalOrigin.md
+++ b/docs/classes/Entity/GetLocalOrigin.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Get local origin."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Entity
returns:
- type: Vector
description: "The local origin."
diff --git a/docs/classes/Entity/GetLocalTime.md b/docs/classes/Entity/GetLocalTime.md
index e6002a9882..ac72cf729c 100644
--- a/docs/classes/Entity/GetLocalTime.md
+++ b/docs/classes/Entity/GetLocalTime.md
@@ -13,7 +13,10 @@ lua:
realm: server
description: "Get local time."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Entity
returns:
- type: number
description: "The local time"
diff --git a/docs/classes/Entity/GetLocalVelocity.md b/docs/classes/Entity/GetLocalVelocity.md
index 6608b542d6..9b22803b55 100644
--- a/docs/classes/Entity/GetLocalVelocity.md
+++ b/docs/classes/Entity/GetLocalVelocity.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Get local velocity."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Entity
returns:
- type: Vector
description: "The local velocity."
diff --git a/docs/classes/Entity/GetMaterialOverride.md b/docs/classes/Entity/GetMaterialOverride.md
index 4c7c25718c..2bdd8fbfb0 100644
--- a/docs/classes/Entity/GetMaterialOverride.md
+++ b/docs/classes/Entity/GetMaterialOverride.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Get the material override"
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Entity
returns:
- type: string
description: "The material override"
diff --git a/docs/classes/Entity/GetMaterials.md b/docs/classes/Entity/GetMaterials.md
index ace9d99d07..27daf2f6ce 100644
--- a/docs/classes/Entity/GetMaterials.md
+++ b/docs/classes/Entity/GetMaterials.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Get the materials"
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Entity
returns:
- type: table
description: "The materials"
diff --git a/docs/classes/Entity/GetMaxHealth.md b/docs/classes/Entity/GetMaxHealth.md
index f49fedae68..238f32eb22 100644
--- a/docs/classes/Entity/GetMaxHealth.md
+++ b/docs/classes/Entity/GetMaxHealth.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Get max health."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Entity
returns:
- type: integer
description: "The max health."
diff --git a/docs/classes/Entity/GetModelBounds.md b/docs/classes/Entity/GetModelBounds.md
index f7e09ef7c0..b1f70ce8e0 100644
--- a/docs/classes/Entity/GetModelBounds.md
+++ b/docs/classes/Entity/GetModelBounds.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Get model bounds."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Entity
returns:
- type: Vector
description: "The minimum bounds."
diff --git a/docs/classes/Entity/GetModelIndex.md b/docs/classes/Entity/GetModelIndex.md
index f4860f5997..5cd92cf6c6 100644
--- a/docs/classes/Entity/GetModelIndex.md
+++ b/docs/classes/Entity/GetModelIndex.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Get model index."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Entity
returns:
- type: integer
description: "The model index."
diff --git a/docs/classes/Entity/GetModelName.md b/docs/classes/Entity/GetModelName.md
index 818f744a8d..af44062e7a 100644
--- a/docs/classes/Entity/GetModelName.md
+++ b/docs/classes/Entity/GetModelName.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Get the model path of the entity"
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Entity
returns:
- type: string
description: "The model name"
diff --git a/docs/classes/Entity/GetMoveDoneTime.md b/docs/classes/Entity/GetMoveDoneTime.md
index ec39e03ef5..b6cf5809a1 100644
--- a/docs/classes/Entity/GetMoveDoneTime.md
+++ b/docs/classes/Entity/GetMoveDoneTime.md
@@ -13,7 +13,10 @@ lua:
realm: server
description: "Get move done time."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Entity
returns:
- type: number
description: "The move done time"
diff --git a/docs/classes/Entity/GetMoveParent.md b/docs/classes/Entity/GetMoveParent.md
index 686e5e1960..b7d3cfed9c 100644
--- a/docs/classes/Entity/GetMoveParent.md
+++ b/docs/classes/Entity/GetMoveParent.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Get move parent."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Entity
returns:
- type: Entity
description: "The move parent."
diff --git a/docs/classes/Entity/GetMoveType.md b/docs/classes/Entity/GetMoveType.md
index 05e582c14a..637e39677a 100644
--- a/docs/classes/Entity/GetMoveType.md
+++ b/docs/classes/Entity/GetMoveType.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Get move type."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Entity
returns:
- type: enumeration/MOVE_TYPE
description: "The move type."
diff --git a/docs/classes/Entity/GetNetworkDataValue.md b/docs/classes/Entity/GetNetworkDataValue.md
index bae14ae12f..82fc479a4c 100644
--- a/docs/classes/Entity/GetNetworkDataValue.md
+++ b/docs/classes/Entity/GetNetworkDataValue.md
@@ -14,10 +14,15 @@ lua:
description: "Gets a data table variable of the given type, in the given slot."
arguments:
- - name: "type"
- type: enumeration/NETWORK_VARIABLE_TYPE
- - name: "slot"
- type: number
+ - position: 1
+ name: "entity"
+ type: Entity
+ - position: 2
+ name: "type"
+ type: enumeration/NETWORK_VARIABLE_TYPE
+ - position: 3
+ name: "slot"
+ type: number
returns:
- type: any
description: "The value of the network variable"
diff --git a/docs/classes/Entity/GetNextTarget.md b/docs/classes/Entity/GetNextTarget.md
index c1cbff1a27..b1de7afe44 100644
--- a/docs/classes/Entity/GetNextTarget.md
+++ b/docs/classes/Entity/GetNextTarget.md
@@ -13,7 +13,10 @@ lua:
realm: server
description: "Get next target."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Entity
returns:
- type: Entity
description: "The next target"
diff --git a/docs/classes/Entity/GetNoCollidingWithTeammates.md b/docs/classes/Entity/GetNoCollidingWithTeammates.md
new file mode 100644
index 0000000000..f954a2c6f8
--- /dev/null
+++ b/docs/classes/Entity/GetNoCollidingWithTeammates.md
@@ -0,0 +1,27 @@
+---
+template: lua-class-function.html
+title: GetNoCollidingWithTeammates
+icon: lua-shared
+tags:
+ - lua
+ - shared
+ - needs-verification
+ - needs-example
+lua:
+ library: Entity
+ function: GetNoCollidingWithTeammates
+ realm: shared
+ description: "Get no colliding with teammates."
+
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Entity
+ returns:
+ - type: boolean
+ description: "True if no colliding with teammates, false otherwise."
+---
+
+
+Entity:GetRagdollOwner – Returns the player this ragdoll came from. NULL if this is not a player ragdoll (will warn)
+
diff --git a/docs/classes/Entity/GetReceivedDamageScale.md b/docs/classes/Entity/GetReceivedDamageScale.md
index 71b3db41f8..0b2cd35605 100644
--- a/docs/classes/Entity/GetReceivedDamageScale.md
+++ b/docs/classes/Entity/GetReceivedDamageScale.md
@@ -14,8 +14,12 @@ lua:
description: "Returns a value that scales all damage done to this entity."
arguments:
- - name: "inflictor"
- type: Entity
+ - position: 1
+ name: "entity"
+ type: Entity
+ - position: 2
+ name: "inflictor"
+ type: Entity
returns:
- type: number
description: "The received damage scale"
diff --git a/docs/classes/Entity/GetRefTable.md b/docs/classes/Entity/GetRefTable.md
index 0ea46e9695..8c4c80c3fe 100644
--- a/docs/classes/Entity/GetRefTable.md
+++ b/docs/classes/Entity/GetRefTable.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Get reference table."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Entity
returns:
- type: table
description: "The reference table."
diff --git a/docs/classes/Entity/GetRenderAngles.md b/docs/classes/Entity/GetRenderAngles.md
index 8ed4ca79b3..30acf4fede 100644
--- a/docs/classes/Entity/GetRenderAngles.md
+++ b/docs/classes/Entity/GetRenderAngles.md
@@ -13,7 +13,10 @@ lua:
realm: client
description: "Get render angles."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Entity
returns:
- type: Angle
description: "Render angles."
diff --git a/docs/classes/Entity/GetRenderBounds.md b/docs/classes/Entity/GetRenderBounds.md
index 2b107fe8e2..2205ecf641 100644
--- a/docs/classes/Entity/GetRenderBounds.md
+++ b/docs/classes/Entity/GetRenderBounds.md
@@ -13,7 +13,10 @@ lua:
realm: client
description: "Get the render bounds."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Entity
returns:
- type: Vector
description: "The minimum bounds"
diff --git a/docs/classes/Entity/GetRenderColor.md b/docs/classes/Entity/GetRenderColor.md
new file mode 100644
index 0000000000..b71d73f48c
--- /dev/null
+++ b/docs/classes/Entity/GetRenderColor.md
@@ -0,0 +1,27 @@
+---
+template: lua-class-function.html
+title: GetRenderColor
+icon: lua-shared
+tags:
+ - lua
+ - shared
+ - needs-verification
+ - needs-example
+lua:
+ library: Entity
+ function: GetRenderColor
+ realm: shared
+ description: "Get the entity render color."
+
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Entity
+ returns:
+ - type: Color
+ description: "The entity render color."
+---
+
+
+Entity:GetSubMaterialOverride – Get the sub material override by it's index (which starts at 0 and runs until at most 31)
+
diff --git a/docs/classes/Entity/GetSubModels.md b/docs/classes/Entity/GetSubModels.md
new file mode 100644
index 0000000000..c434b91e8b
--- /dev/null
+++ b/docs/classes/Entity/GetSubModels.md
@@ -0,0 +1,27 @@
+---
+template: lua-class-function.html
+title: GetSubModels
+icon: lua-shared
+tags:
+ - lua
+ - shared
+ - needs-verification
+ - needs-example
+lua:
+ library: Entity
+ function: GetSubModels
+ realm: shared
+ description: "Get the submodels"
+
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Entity
+ returns:
+ - type: table
+ description: "The submodels"
+---
+
+
-Entity:SetRenderColor – Set render color.
+Entity:SetRenderColor – Set the entity render color.
diff --git a/docs/classes/Entity/SetRenderColorA.md b/docs/classes/Entity/SetRenderColorA.md
index f5b2ba3df5..9f6f59e801 100644
--- a/docs/classes/Entity/SetRenderColorA.md
+++ b/docs/classes/Entity/SetRenderColorA.md
@@ -14,8 +14,12 @@ lua:
description: "Set render color alpha."
arguments:
- - name: "alpha"
- type: number
+ - position: 1
+ name: "entity"
+ type: Entity
+ - position: 2
+ name: "alpha"
+ type: number
returns:
---
diff --git a/docs/classes/Entity/SetRenderColorB.md b/docs/classes/Entity/SetRenderColorB.md
index a2ec9a6b00..9afe0039a5 100644
--- a/docs/classes/Entity/SetRenderColorB.md
+++ b/docs/classes/Entity/SetRenderColorB.md
@@ -14,8 +14,12 @@ lua:
description: "Set render color blue."
arguments:
- - name: "blue"
- type: number
+ - position: 1
+ name: "entity"
+ type: Entity
+ - position: 2
+ name: "blue"
+ type: number
returns:
---
diff --git a/docs/classes/Entity/SetRenderColorG.md b/docs/classes/Entity/SetRenderColorG.md
index 09e134df1e..093b27ee5c 100644
--- a/docs/classes/Entity/SetRenderColorG.md
+++ b/docs/classes/Entity/SetRenderColorG.md
@@ -14,8 +14,12 @@ lua:
description: "Set render color green."
arguments:
- - name: "green"
- type: number
+ - position: 1
+ name: "entity"
+ type: Entity
+ - position: 2
+ name: "green"
+ type: number
returns:
---
diff --git a/docs/classes/Entity/SetRenderColorR.md b/docs/classes/Entity/SetRenderColorR.md
index f1e38d5785..2a1f25ec9d 100644
--- a/docs/classes/Entity/SetRenderColorR.md
+++ b/docs/classes/Entity/SetRenderColorR.md
@@ -14,8 +14,12 @@ lua:
description: "Set render color red."
arguments:
- - name: "red"
- type: number
+ - position: 1
+ name: "entity"
+ type: Entity
+ - position: 2
+ name: "red"
+ type: number
returns:
---
diff --git a/docs/classes/Entity/SetRenderMode.md b/docs/classes/Entity/SetRenderMode.md
index a50f032435..e4c5dd9c3e 100644
--- a/docs/classes/Entity/SetRenderMode.md
+++ b/docs/classes/Entity/SetRenderMode.md
@@ -14,8 +14,12 @@ lua:
description: "Set render mode."
arguments:
- - name: "mode"
- type: enumeration/RENDER_MODE
+ - position: 1
+ name: "entity"
+ type: Entity
+ - position: 2
+ name: "mode"
+ type: enumeration/RENDER_MODE
returns:
---
diff --git a/docs/classes/Entity/SetSequence.md b/docs/classes/Entity/SetSequence.md
index d8094679db..3ff162bbe2 100644
--- a/docs/classes/Entity/SetSequence.md
+++ b/docs/classes/Entity/SetSequence.md
@@ -14,8 +14,12 @@ lua:
description: "Set the sequence."
arguments:
- - name: "sequence"
- type: number
+ - position: 1
+ name: "entity"
+ type: Entity
+ - position: 2
+ name: "sequence"
+ type: number
returns:
---
diff --git a/docs/classes/Entity/SetServerIntendedCycle.md b/docs/classes/Entity/SetServerIntendedCycle.md
index 3c2c08ca9e..3f9fb8fb71 100644
--- a/docs/classes/Entity/SetServerIntendedCycle.md
+++ b/docs/classes/Entity/SetServerIntendedCycle.md
@@ -14,8 +14,12 @@ lua:
description: "Set the server intended cycle."
arguments:
- - name: "cycle"
- type: number
+ - position: 1
+ name: "entity"
+ type: Entity
+ - position: 2
+ name: "cycle"
+ type: number
returns:
---
diff --git a/docs/classes/Entity/SetShadowCastDistance.md b/docs/classes/Entity/SetShadowCastDistance.md
index 877108415b..6aaa50dff4 100644
--- a/docs/classes/Entity/SetShadowCastDistance.md
+++ b/docs/classes/Entity/SetShadowCastDistance.md
@@ -14,11 +14,16 @@ lua:
description: "Set shadow cast distance."
arguments:
- - name: "distance"
- type: number
- - name: "maxDistance"
- type: number
- nillable: true
+ - position: 1
+ name: "entity"
+ type: Entity
+ - position: 2
+ name: "distance"
+ type: number
+ - position: 3
+ name: "maxDistance"
+ type: number
+ nillable: true
returns:
---
diff --git a/docs/classes/Entity/SetSimulatedEveryTick.md b/docs/classes/Entity/SetSimulatedEveryTick.md
index 2c8224dc1c..8cf46416c0 100644
--- a/docs/classes/Entity/SetSimulatedEveryTick.md
+++ b/docs/classes/Entity/SetSimulatedEveryTick.md
@@ -14,8 +14,12 @@ lua:
description: "Set simulated every tick."
arguments:
- - name: "simulated"
- type: boolean
+ - position: 1
+ name: "entity"
+ type: Entity
+ - position: 2
+ name: "simulated"
+ type: boolean
returns:
---
diff --git a/docs/classes/Entity/SetSimulationTime.md b/docs/classes/Entity/SetSimulationTime.md
index 65626007df..922ab67742 100644
--- a/docs/classes/Entity/SetSimulationTime.md
+++ b/docs/classes/Entity/SetSimulationTime.md
@@ -14,8 +14,12 @@ lua:
description: "Set simulation time."
arguments:
- - name: "time"
- type: number
+ - position: 1
+ name: "entity"
+ type: Entity
+ - position: 2
+ name: "time"
+ type: number
returns:
---
diff --git a/docs/classes/Entity/SetSize.md b/docs/classes/Entity/SetSize.md
index cb0fb178a5..4ef0f180c6 100644
--- a/docs/classes/Entity/SetSize.md
+++ b/docs/classes/Entity/SetSize.md
@@ -14,10 +14,15 @@ lua:
description: "Set size of bounding box."
arguments:
- - name: "mins"
- type: Vector
- - name: "maxs"
- type: Vector
+ - position: 1
+ name: "entity"
+ type: Entity
+ - position: 2
+ name: "mins"
+ type: Vector
+ - position: 3
+ name: "maxs"
+ type: Vector
returns:
---
diff --git a/docs/classes/Entity/SetSkin.md b/docs/classes/Entity/SetSkin.md
index c4d535889c..1c18443c5b 100644
--- a/docs/classes/Entity/SetSkin.md
+++ b/docs/classes/Entity/SetSkin.md
@@ -14,8 +14,12 @@ lua:
description: "Set the skin of the entity"
arguments:
- - name: "skin"
- type: number
+ - position: 1
+ name: "entity"
+ type: Entity
+ - position: 2
+ name: "skin"
+ type: number
returns:
---
diff --git a/docs/classes/Entity/SetSolid.md b/docs/classes/Entity/SetSolid.md
index 4776830fad..7d5fffeee5 100644
--- a/docs/classes/Entity/SetSolid.md
+++ b/docs/classes/Entity/SetSolid.md
@@ -14,8 +14,12 @@ lua:
description: "Set solid type."
arguments:
- - name: "type"
- type: enumeration/SOLID
+ - position: 1
+ name: "entity"
+ type: Entity
+ - position: 2
+ name: "type"
+ type: enumeration/SOLID
returns:
---
diff --git a/docs/classes/Entity/SetSolidFlags.md b/docs/classes/Entity/SetSolidFlags.md
index 633c3b20bb..61f00cd05c 100644
--- a/docs/classes/Entity/SetSolidFlags.md
+++ b/docs/classes/Entity/SetSolidFlags.md
@@ -14,8 +14,12 @@ lua:
description: "Set solid flags."
arguments:
- - name: "flags"
- type: number
+ - position: 1
+ name: "entity"
+ type: Entity
+ - position: 2
+ name: "flags"
+ type: number
returns:
---
diff --git a/docs/classes/Entity/SetSubMaterialOverride.md b/docs/classes/Entity/SetSubMaterialOverride.md
new file mode 100644
index 0000000000..3835155b98
--- /dev/null
+++ b/docs/classes/Entity/SetSubMaterialOverride.md
@@ -0,0 +1,34 @@
+---
+template: lua-class-function.html
+title: SetSubMaterialOverride
+icon: lua-shared
+tags:
+ - lua
+ - shared
+ - needs-verification
+ - needs-example
+lua:
+ library: Entity
+ function: SetSubMaterialOverride
+ realm: shared
+ description: "Set the sub material override by it's index (which starts at 0 and runs until at most 31). If called without arguments, it will reset all submaterials."
+
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Entity
+ - position: 2
+ name: "subMaterialIndex"
+ type: number
+ nillable: true
+ - position: 3
+ name: "materialName"
+ type: string
+ nillable: true
+ returns:
+
+---
+
+
+Entity:SetSubMaterialOverride – Set the sub material override by it's index (which starts at 0 and runs until at most 31). If called without arguments, it will reset all submaterials.
+
diff --git a/docs/classes/Entity/SetTextureFrameIndex.md b/docs/classes/Entity/SetTextureFrameIndex.md
index 710d2a3e1e..88832303ca 100644
--- a/docs/classes/Entity/SetTextureFrameIndex.md
+++ b/docs/classes/Entity/SetTextureFrameIndex.md
@@ -14,8 +14,12 @@ lua:
description: "Set texture frame index."
arguments:
- - name: "index"
- type: number
+ - position: 1
+ name: "entity"
+ type: Entity
+ - position: 2
+ name: "index"
+ type: number
returns:
---
diff --git a/docs/classes/Entity/SetToolRecording.md b/docs/classes/Entity/SetToolRecording.md
index e969398ca6..dd99ce4cca 100644
--- a/docs/classes/Entity/SetToolRecording.md
+++ b/docs/classes/Entity/SetToolRecording.md
@@ -14,8 +14,12 @@ lua:
description: "Set tool recording."
arguments:
- - name: "recording"
- type: boolean
+ - position: 1
+ name: "entity"
+ type: Entity
+ - position: 2
+ name: "recording"
+ type: boolean
returns:
---
diff --git a/docs/classes/Entity/SetTransmitState.md b/docs/classes/Entity/SetTransmitState.md
index 0587cb341f..56d0536d3c 100644
--- a/docs/classes/Entity/SetTransmitState.md
+++ b/docs/classes/Entity/SetTransmitState.md
@@ -14,8 +14,12 @@ lua:
description: "Set transmit state."
arguments:
- - name: "state"
- type: number
+ - position: 1
+ name: "entity"
+ type: Entity
+ - position: 2
+ name: "state"
+ type: number
returns:
- type: integer
description: "The transmit state"
diff --git a/docs/classes/Entity/SetTransmitWithParent.md b/docs/classes/Entity/SetTransmitWithParent.md
index f0c844240b..ffbcdf04a3 100644
--- a/docs/classes/Entity/SetTransmitWithParent.md
+++ b/docs/classes/Entity/SetTransmitWithParent.md
@@ -14,8 +14,12 @@ lua:
description: "Set transmit with parent."
arguments:
- - name: "transmit"
- type: boolean
+ - position: 1
+ name: "entity"
+ type: Entity
+ - position: 2
+ name: "transmit"
+ type: boolean
returns:
---
diff --git a/docs/classes/Entity/SetVelocity.md b/docs/classes/Entity/SetVelocity.md
index 4e1d098402..e5d2f97340 100644
--- a/docs/classes/Entity/SetVelocity.md
+++ b/docs/classes/Entity/SetVelocity.md
@@ -14,8 +14,12 @@ lua:
description: "Set absolute velocity."
arguments:
- - name: "velocity"
- type: Vector
+ - position: 1
+ name: "entity"
+ type: Entity
+ - position: 2
+ name: "velocity"
+ type: Vector
returns:
---
diff --git a/docs/classes/Entity/SetViewOffset.md b/docs/classes/Entity/SetViewOffset.md
index b5a2350cfb..bc4634cbec 100644
--- a/docs/classes/Entity/SetViewOffset.md
+++ b/docs/classes/Entity/SetViewOffset.md
@@ -14,8 +14,12 @@ lua:
description: "Set view offset."
arguments:
- - name: "offset"
- type: Vector
+ - position: 1
+ name: "entity"
+ type: Entity
+ - position: 2
+ name: "offset"
+ type: Vector
returns:
---
diff --git a/docs/classes/Entity/SetWaterLevel.md b/docs/classes/Entity/SetWaterLevel.md
index 8d1a62360a..37d42fa160 100644
--- a/docs/classes/Entity/SetWaterLevel.md
+++ b/docs/classes/Entity/SetWaterLevel.md
@@ -14,8 +14,12 @@ lua:
description: "Set water level enum."
arguments:
- - name: "level"
- type: number
+ - position: 1
+ name: "entity"
+ type: Entity
+ - position: 2
+ name: "level"
+ type: number
returns:
---
diff --git a/docs/classes/Entity/SetWaterType.md b/docs/classes/Entity/SetWaterType.md
index 83c4229ead..5019d6d881 100644
--- a/docs/classes/Entity/SetWaterType.md
+++ b/docs/classes/Entity/SetWaterType.md
@@ -14,8 +14,12 @@ lua:
description: "Set water type."
arguments:
- - name: "type"
- type: number
+ - position: 1
+ name: "entity"
+ type: Entity
+ - position: 2
+ name: "type"
+ type: number
returns:
---
diff --git a/docs/classes/Entity/SetupBones.md b/docs/classes/Entity/SetupBones.md
new file mode 100644
index 0000000000..cb9bf2835b
--- /dev/null
+++ b/docs/classes/Entity/SetupBones.md
@@ -0,0 +1,26 @@
+---
+template: lua-class-function.html
+title: SetupBones
+icon: lua-client
+tags:
+ - lua
+ - client
+ - needs-verification
+ - needs-example
+lua:
+ library: Entity
+ function: SetupBones
+ realm: client
+ description: "Force the bones to be recalculated."
+
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Entity
+ returns:
+
+---
+
+
-HTML:AddCustomURLHandler – Adds a custom URL handler
+Html:AddCustomURLHandler – Adds a custom URL handler
diff --git a/docs/classes/HTML/AddJavascriptObject.md b/docs/classes/Html/AddJavascriptObject.md
similarity index 64%
rename from docs/classes/HTML/AddJavascriptObject.md
rename to docs/classes/Html/AddJavascriptObject.md
index b58b44ba6a..5ffbcd8251 100644
--- a/docs/classes/HTML/AddJavascriptObject.md
+++ b/docs/classes/Html/AddJavascriptObject.md
@@ -8,18 +8,22 @@ tags:
- needs-verification
- needs-example
lua:
- library: HTML
+ library: Html
function: AddJavascriptObject
realm: client
description: "Adds a JavaScript object"
arguments:
- - name: "objectName"
- type: string
+ - position: 1
+ name: "html"
+ type: Html
+ - position: 2
+ name: "objectName"
+ type: string
returns:
---
-HTML:AddJavascriptObject – Adds a JavaScript object
+Html:AddJavascriptObject – Adds a JavaScript object
diff --git a/docs/classes/HTML/AddJavascriptObjectCallback.md b/docs/classes/Html/AddJavascriptObjectCallback.md
similarity index 60%
rename from docs/classes/HTML/AddJavascriptObjectCallback.md
rename to docs/classes/Html/AddJavascriptObjectCallback.md
index dc179987a1..74a826c53b 100644
--- a/docs/classes/HTML/AddJavascriptObjectCallback.md
+++ b/docs/classes/Html/AddJavascriptObjectCallback.md
@@ -8,20 +8,25 @@ tags:
- needs-verification
- needs-example
lua:
- library: HTML
+ library: Html
function: AddJavascriptObjectCallback
realm: client
description: "Adds a callback to a JavaScript object"
arguments:
- - name: "objectName"
- type: string
- - name: "propertyName"
- type: string
+ - position: 1
+ name: "html"
+ type: Html
+ - position: 2
+ name: "objectName"
+ type: string
+ - position: 3
+ name: "propertyName"
+ type: string
returns:
---
-HTML:AddJavascriptObjectCallback – Adds a callback to a JavaScript object
+Html:AddJavascriptObjectCallback – Adds a callback to a JavaScript object
diff --git a/docs/classes/HTML/CanGoBack.md b/docs/classes/Html/CanGoBack.md
similarity index 73%
rename from docs/classes/HTML/CanGoBack.md
rename to docs/classes/Html/CanGoBack.md
index 51e95411a0..70cb5ed100 100644
--- a/docs/classes/HTML/CanGoBack.md
+++ b/docs/classes/Html/CanGoBack.md
@@ -8,17 +8,20 @@ tags:
- needs-verification
- needs-example
lua:
- library: HTML
+ library: Html
function: CanGoBack
realm: client
description: "Checks if the browser can go back"
-
+ arguments:
+ - position: 1
+ name: "html"
+ type: Html
returns:
- type: boolean
description: "Whether the browser can go back"
---
-HTML:CanGoBack – Checks if the browser can go back
+Html:CanGoBack – Checks if the browser can go back
diff --git a/docs/classes/HTML/CanGoForward.md b/docs/classes/Html/CanGoForward.md
similarity index 72%
rename from docs/classes/HTML/CanGoForward.md
rename to docs/classes/Html/CanGoForward.md
index e692980a6e..3438ba8d39 100644
--- a/docs/classes/HTML/CanGoForward.md
+++ b/docs/classes/Html/CanGoForward.md
@@ -8,17 +8,20 @@ tags:
- needs-verification
- needs-example
lua:
- library: HTML
+ library: Html
function: CanGoForward
realm: client
description: "Checks if the browser can go forward"
-
+ arguments:
+ - position: 1
+ name: "html"
+ type: Html
returns:
- type: boolean
description: "Whether the browser can go forward"
---
-HTML:CanGoForward – Checks if the browser can go forward
+Html:CanGoForward – Checks if the browser can go forward
diff --git a/docs/classes/HTML/Find.md b/docs/classes/Html/Find.md
similarity index 64%
rename from docs/classes/HTML/Find.md
rename to docs/classes/Html/Find.md
index ec7a87e914..c9ba3eb9e1 100644
--- a/docs/classes/HTML/Find.md
+++ b/docs/classes/Html/Find.md
@@ -8,18 +8,22 @@ tags:
- needs-verification
- needs-example
lua:
- library: HTML
+ library: Html
function: Find
realm: client
description: "Finds text in the HTML object"
arguments:
- - name: "text"
- type: string
+ - position: 1
+ name: "html"
+ type: Html
+ - position: 2
+ name: "text"
+ type: string
returns:
---
-HTML:Find – Finds text in the HTML object
+Html:Find – Finds text in the HTML object
diff --git a/docs/classes/HTML/FindDialogVisible.md b/docs/classes/Html/FindDialogVisible.md
similarity index 73%
rename from docs/classes/HTML/FindDialogVisible.md
rename to docs/classes/Html/FindDialogVisible.md
index d85afd62f6..6a2b4c1b26 100644
--- a/docs/classes/HTML/FindDialogVisible.md
+++ b/docs/classes/Html/FindDialogVisible.md
@@ -8,17 +8,20 @@ tags:
- needs-verification
- needs-example
lua:
- library: HTML
+ library: Html
function: FindDialogVisible
realm: client
description: "Checks if the find dialog is visible"
-
+ arguments:
+ - position: 1
+ name: "html"
+ type: Html
returns:
- type: boolean
description: "Whether the find dialog is visible"
---
-HTML:FindDialogVisible – Checks if the find dialog is visible
+Html:FindDialogVisible – Checks if the find dialog is visible
diff --git a/docs/classes/HTML/FindNext.md b/docs/classes/Html/FindNext.md
similarity index 68%
rename from docs/classes/HTML/FindNext.md
rename to docs/classes/Html/FindNext.md
index 2d9c1b5265..963d39c58e 100644
--- a/docs/classes/HTML/FindNext.md
+++ b/docs/classes/Html/FindNext.md
@@ -8,16 +8,19 @@ tags:
- needs-verification
- needs-example
lua:
- library: HTML
+ library: Html
function: FindNext
realm: client
description: "Finds the next occurrence of text"
-
+ arguments:
+ - position: 1
+ name: "html"
+ type: Html
returns:
---
-HTML:FindNext – Finds the next occurrence of text
+Html:FindNext – Finds the next occurrence of text
diff --git a/docs/classes/HTML/FindPrevious.md b/docs/classes/Html/FindPrevious.md
similarity index 68%
rename from docs/classes/HTML/FindPrevious.md
rename to docs/classes/Html/FindPrevious.md
index a6106c96fd..8992e03510 100644
--- a/docs/classes/HTML/FindPrevious.md
+++ b/docs/classes/Html/FindPrevious.md
@@ -8,16 +8,19 @@ tags:
- needs-verification
- needs-example
lua:
- library: HTML
+ library: Html
function: FindPrevious
realm: client
description: "Finds the previous occurrence of text"
-
+ arguments:
+ - position: 1
+ name: "html"
+ type: Html
returns:
---
-HTML:FindPrevious – Finds the previous occurrence of text
+Html:FindPrevious – Finds the previous occurrence of text
diff --git a/docs/classes/HTML/GetLinkAtPosition.md b/docs/classes/Html/GetLinkAtPosition.md
similarity index 60%
rename from docs/classes/HTML/GetLinkAtPosition.md
rename to docs/classes/Html/GetLinkAtPosition.md
index 0c36044e89..df94fcc00d 100644
--- a/docs/classes/HTML/GetLinkAtPosition.md
+++ b/docs/classes/Html/GetLinkAtPosition.md
@@ -8,20 +8,25 @@ tags:
- needs-verification
- needs-example
lua:
- library: HTML
+ library: Html
function: GetLinkAtPosition
realm: client
description: "Gets the link at a specific position"
arguments:
- - name: "x"
- type: number
- - name: "y"
- type: number
+ - position: 1
+ name: "html"
+ type: Html
+ - position: 2
+ name: "x"
+ type: number
+ - position: 3
+ name: "y"
+ type: number
returns:
---
-HTML:GetLinkAtPosition – Gets the link at a specific position
+Html:GetLinkAtPosition – Gets the link at a specific position
diff --git a/docs/classes/HTML/GoBack.md b/docs/classes/Html/GoBack.md
similarity index 68%
rename from docs/classes/HTML/GoBack.md
rename to docs/classes/Html/GoBack.md
index 812356ab8c..cf46d464b0 100644
--- a/docs/classes/HTML/GoBack.md
+++ b/docs/classes/Html/GoBack.md
@@ -8,16 +8,19 @@ tags:
- needs-verification
- needs-example
lua:
- library: HTML
+ library: Html
function: GoBack
realm: client
description: "Navigates back in the browser history"
-
+ arguments:
+ - position: 1
+ name: "html"
+ type: Html
returns:
---
-HTML:GoBack – Navigates back in the browser history
+Html:GoBack – Navigates back in the browser history
diff --git a/docs/classes/HTML/GoForward.md b/docs/classes/Html/GoForward.md
similarity index 68%
rename from docs/classes/HTML/GoForward.md
rename to docs/classes/Html/GoForward.md
index ebdac1bf54..fba92c7ea5 100644
--- a/docs/classes/HTML/GoForward.md
+++ b/docs/classes/Html/GoForward.md
@@ -8,16 +8,19 @@ tags:
- needs-verification
- needs-example
lua:
- library: HTML
+ library: Html
function: GoForward
realm: client
description: "Navigates forward in the browser history"
-
+ arguments:
+ - position: 1
+ name: "html"
+ type: Html
returns:
---
-HTML:GoForward – Navigates forward in the browser history
+Html:GoForward – Navigates forward in the browser history
diff --git a/docs/classes/HTML/HideFindDialog.md b/docs/classes/Html/HideFindDialog.md
similarity index 69%
rename from docs/classes/HTML/HideFindDialog.md
rename to docs/classes/Html/HideFindDialog.md
index 781da60289..9c767f1484 100644
--- a/docs/classes/HTML/HideFindDialog.md
+++ b/docs/classes/Html/HideFindDialog.md
@@ -8,16 +8,19 @@ tags:
- needs-verification
- needs-example
lua:
- library: HTML
+ library: Html
function: HideFindDialog
realm: client
description: "Hides the find dialog"
-
+ arguments:
+ - position: 1
+ name: "html"
+ type: Html
returns:
---
-HTML:HideFindDialog – Hides the find dialog
+Html:HideFindDialog – Hides the find dialog
diff --git a/docs/classes/HTML/HorizontalScrollMax.md b/docs/classes/Html/HorizontalScrollMax.md
similarity index 74%
rename from docs/classes/HTML/HorizontalScrollMax.md
rename to docs/classes/Html/HorizontalScrollMax.md
index 0765599f3a..b8f7d9c2bf 100644
--- a/docs/classes/HTML/HorizontalScrollMax.md
+++ b/docs/classes/Html/HorizontalScrollMax.md
@@ -8,17 +8,20 @@ tags:
- needs-verification
- needs-example
lua:
- library: HTML
+ library: Html
function: HorizontalScrollMax
realm: client
description: "Gets the maximum horizontal scroll value"
-
+ arguments:
+ - position: 1
+ name: "html"
+ type: Html
returns:
- type: integer
description: "The maximum horizontal scroll value"
---
-HTML:HorizontalScrollMax – Gets the maximum horizontal scroll value
+Html:HorizontalScrollMax – Gets the maximum horizontal scroll value
diff --git a/docs/classes/HTML/IsLoading.md b/docs/classes/Html/IsLoading.md
similarity index 72%
rename from docs/classes/HTML/IsLoading.md
rename to docs/classes/Html/IsLoading.md
index 3851b11c78..fc105eb43e 100644
--- a/docs/classes/HTML/IsLoading.md
+++ b/docs/classes/Html/IsLoading.md
@@ -8,17 +8,20 @@ tags:
- needs-verification
- needs-example
lua:
- library: HTML
+ library: Html
function: IsLoading
realm: client
description: "Checks if the HTML is currently loading"
-
+ arguments:
+ - position: 1
+ name: "html"
+ type: Html
returns:
- type: boolean
description: "Whether the HTML is loading"
---
-HTML:IsLoading – Checks if the HTML is currently loading
+Html:IsLoading – Checks if the HTML is currently loading
diff --git a/docs/classes/HTML/IsScrollbarVisible.md b/docs/classes/Html/IsScrollbarVisible.md
similarity index 73%
rename from docs/classes/HTML/IsScrollbarVisible.md
rename to docs/classes/Html/IsScrollbarVisible.md
index f1888b2d6e..19acf96ae0 100644
--- a/docs/classes/HTML/IsScrollbarVisible.md
+++ b/docs/classes/Html/IsScrollbarVisible.md
@@ -8,17 +8,20 @@ tags:
- needs-verification
- needs-example
lua:
- library: HTML
+ library: Html
function: IsScrollbarVisible
realm: client
description: "Checks if the scrollbar is visible"
-
+ arguments:
+ - position: 1
+ name: "html"
+ type: Html
returns:
- type: boolean
description: "Whether the scrollbar is visible"
---
-HTML:IsScrollbarVisible – Checks if the scrollbar is visible
+Html:IsScrollbarVisible – Checks if the scrollbar is visible
diff --git a/docs/classes/HTML/IsScrolledToBottom.md b/docs/classes/Html/IsScrolledToBottom.md
similarity index 74%
rename from docs/classes/HTML/IsScrolledToBottom.md
rename to docs/classes/Html/IsScrolledToBottom.md
index 66fd45554d..7372d982d2 100644
--- a/docs/classes/HTML/IsScrolledToBottom.md
+++ b/docs/classes/Html/IsScrolledToBottom.md
@@ -8,17 +8,20 @@ tags:
- needs-verification
- needs-example
lua:
- library: HTML
+ library: Html
function: IsScrolledToBottom
realm: client
description: "Checks if the HTML is scrolled to the bottom"
-
+ arguments:
+ - position: 1
+ name: "html"
+ type: Html
returns:
- type: boolean
description: "Whether the HTML is scrolled to the bottom"
---
-HTML:IsScrolledToBottom – Checks if the HTML is scrolled to the bottom
+Html:IsScrolledToBottom – Checks if the HTML is scrolled to the bottom
diff --git a/docs/classes/HTML/NewWindowsOnly.md b/docs/classes/Html/NewWindowsOnly.md
similarity index 64%
rename from docs/classes/HTML/NewWindowsOnly.md
rename to docs/classes/Html/NewWindowsOnly.md
index 5ad91031c6..62c4ab8c36 100644
--- a/docs/classes/HTML/NewWindowsOnly.md
+++ b/docs/classes/Html/NewWindowsOnly.md
@@ -8,18 +8,22 @@ tags:
- needs-verification
- needs-example
lua:
- library: HTML
+ library: Html
function: NewWindowsOnly
realm: client
description: "Allows opening new windows only"
arguments:
- - name: "enable"
- type: boolean
+ - position: 1
+ name: "html"
+ type: Html
+ - position: 2
+ name: "enable"
+ type: boolean
returns:
---
-HTML:NewWindowsOnly – Allows opening new windows only
+Html:NewWindowsOnly – Allows opening new windows only
diff --git a/docs/classes/Html/OpenUrl.md b/docs/classes/Html/OpenUrl.md
new file mode 100644
index 0000000000..31e3c2a53b
--- /dev/null
+++ b/docs/classes/Html/OpenUrl.md
@@ -0,0 +1,37 @@
+---
+template: lua-class-function.html
+title: OpenUrl
+icon: lua-client
+tags:
+ - lua
+ - client
+ - needs-verification
+ - needs-example
+lua:
+ library: Html
+ function: OpenUrl
+ realm: client
+ description: "Opens a URL in the HTML object"
+
+ arguments:
+ - position: 1
+ name: "html"
+ type: Html
+ - position: 2
+ name: "url"
+ type: string
+ - position: 3
+ name: "postData"
+ type: string
+ default: "\"\""
+ - position: 4
+ name: "allowJS"
+ type: boolean
+ default: "false"
+ returns:
+
+---
+
+
-HTML:Refresh – Refreshes the current page
+Html:Refresh – Refreshes the current page
diff --git a/docs/classes/HTML/RunJavascript.md b/docs/classes/Html/RunJavascript.md
similarity index 64%
rename from docs/classes/HTML/RunJavascript.md
rename to docs/classes/Html/RunJavascript.md
index da64bed9dc..0632809961 100644
--- a/docs/classes/HTML/RunJavascript.md
+++ b/docs/classes/Html/RunJavascript.md
@@ -8,18 +8,22 @@ tags:
- needs-verification
- needs-example
lua:
- library: HTML
+ library: Html
function: RunJavascript
realm: client
description: "Executes JavaScript in the HTML object"
arguments:
- - name: "jsCode"
- type: string
+ - position: 1
+ name: "html"
+ type: Html
+ - position: 2
+ name: "jsCode"
+ type: string
returns:
---
-HTML:RunJavascript – Executes JavaScript in the HTML object
+Html:RunJavascript – Executes JavaScript in the HTML object
diff --git a/docs/classes/HTML/SetContextMenuEnabled.md b/docs/classes/Html/SetContextMenuEnabled.md
similarity index 65%
rename from docs/classes/HTML/SetContextMenuEnabled.md
rename to docs/classes/Html/SetContextMenuEnabled.md
index 11eb18fd76..a76a243c93 100644
--- a/docs/classes/HTML/SetContextMenuEnabled.md
+++ b/docs/classes/Html/SetContextMenuEnabled.md
@@ -8,18 +8,22 @@ tags:
- needs-verification
- needs-example
lua:
- library: HTML
+ library: Html
function: SetContextMenuEnabled
realm: client
description: "Enables or disables the context menu"
arguments:
- - name: "enable"
- type: boolean
+ - position: 1
+ name: "html"
+ type: Html
+ - position: 2
+ name: "enable"
+ type: boolean
returns:
---
-HTML:SetContextMenuEnabled – Enables or disables the context menu
+Html:SetContextMenuEnabled – Enables or disables the context menu
diff --git a/docs/classes/Html/SetHtml.md b/docs/classes/Html/SetHtml.md
new file mode 100644
index 0000000000..47cc890bce
--- /dev/null
+++ b/docs/classes/Html/SetHtml.md
@@ -0,0 +1,29 @@
+---
+template: lua-class-function.html
+title: SetHtml
+icon: lua-client
+tags:
+ - lua
+ - client
+ - needs-verification
+ - needs-example
+lua:
+ library: Html
+ function: SetHtml
+ realm: client
+ description: "Sets the HTML content of the object"
+
+ arguments:
+ - position: 1
+ name: "html"
+ type: Html
+ - position: 2
+ name: "htmlContent"
+ type: string
+ returns:
+
+---
+
+
-HTML:SetScrollbarsEnabled – Enables or disables scrollbars
+Html:SetScrollbarsEnabled – Enables or disables scrollbars
diff --git a/docs/classes/HTML/SetViewSourceEnabled.md b/docs/classes/Html/SetViewSourceEnabled.md
similarity index 65%
rename from docs/classes/HTML/SetViewSourceEnabled.md
rename to docs/classes/Html/SetViewSourceEnabled.md
index 0ebb6cafd9..009ecbe9c2 100644
--- a/docs/classes/HTML/SetViewSourceEnabled.md
+++ b/docs/classes/Html/SetViewSourceEnabled.md
@@ -8,18 +8,22 @@ tags:
- needs-verification
- needs-example
lua:
- library: HTML
+ library: Html
function: SetViewSourceEnabled
realm: client
description: "Enables or disables view source option"
arguments:
- - name: "enable"
- type: boolean
+ - position: 1
+ name: "html"
+ type: Html
+ - position: 2
+ name: "enable"
+ type: boolean
returns:
---
-HTML:SetViewSourceEnabled – Enables or disables view source option
+Html:SetViewSourceEnabled – Enables or disables view source option
diff --git a/docs/classes/HTML/ShowFindDialog.md b/docs/classes/Html/ShowFindDialog.md
similarity index 69%
rename from docs/classes/HTML/ShowFindDialog.md
rename to docs/classes/Html/ShowFindDialog.md
index 86ae57a6f9..9d2a86d635 100644
--- a/docs/classes/HTML/ShowFindDialog.md
+++ b/docs/classes/Html/ShowFindDialog.md
@@ -8,16 +8,19 @@ tags:
- needs-verification
- needs-example
lua:
- library: HTML
+ library: Html
function: ShowFindDialog
realm: client
description: "Shows the find dialog"
-
+ arguments:
+ - position: 1
+ name: "html"
+ type: Html
returns:
---
-HTML:ShowFindDialog – Shows the find dialog
+Html:ShowFindDialog – Shows the find dialog
diff --git a/docs/classes/HTML/StopFind.md b/docs/classes/Html/StopFind.md
similarity index 70%
rename from docs/classes/HTML/StopFind.md
rename to docs/classes/Html/StopFind.md
index 7637e0047e..fd61410db3 100644
--- a/docs/classes/HTML/StopFind.md
+++ b/docs/classes/Html/StopFind.md
@@ -8,16 +8,19 @@ tags:
- needs-verification
- needs-example
lua:
- library: HTML
+ library: Html
function: StopFind
realm: client
description: "Stops finding text"
-
+ arguments:
+ - position: 1
+ name: "html"
+ type: Html
returns:
---
-HTML:StopLoading – Stops loading the current page
+Html:StopLoading – Stops loading the current page
diff --git a/docs/classes/HTML/VerticalScrollMax.md b/docs/classes/Html/VerticalScrollMax.md
similarity index 73%
rename from docs/classes/HTML/VerticalScrollMax.md
rename to docs/classes/Html/VerticalScrollMax.md
index 7f1ad64de3..da43b6b2c4 100644
--- a/docs/classes/HTML/VerticalScrollMax.md
+++ b/docs/classes/Html/VerticalScrollMax.md
@@ -8,17 +8,20 @@ tags:
- needs-verification
- needs-example
lua:
- library: HTML
+ library: Html
function: VerticalScrollMax
realm: client
description: "Gets the maximum vertical scroll value"
-
+ arguments:
+ - position: 1
+ name: "html"
+ type: Html
returns:
- type: integer
description: "The maximum vertical scroll value"
---
-HTML:VerticalScrollMax – Gets the maximum vertical scroll value
+Html:VerticalScrollMax – Gets the maximum vertical scroll value
diff --git a/docs/classes/HTML/__eq.md b/docs/classes/Html/__eq.md
similarity index 67%
rename from docs/classes/HTML/__eq.md
rename to docs/classes/Html/__eq.md
index 3c081a8ff1..b3474ab7cc 100644
--- a/docs/classes/HTML/__eq.md
+++ b/docs/classes/Html/__eq.md
@@ -8,17 +8,23 @@ tags:
- needs-verification
- needs-example
lua:
- library: HTML
+ library: Html
function: __eq
realm: client
description: "Metamethod called when two HTML objects are compared"
-
+ arguments:
+ - position: 1
+ name: "html"
+ type: Html
+ - position: 2
+ name: "other"
+ type: Html
returns:
- type: boolean
description: "Whether the HTML objects are equal"
---
-HTML:__eq – Metamethod called when two HTML objects are compared
+Html:__eq – Metamethod called when two HTML objects are compared
diff --git a/docs/classes/HTML/__index.md b/docs/classes/Html/__index.md
similarity index 68%
rename from docs/classes/HTML/__index.md
rename to docs/classes/Html/__index.md
index 56ada666e7..0a87726cab 100644
--- a/docs/classes/HTML/__index.md
+++ b/docs/classes/Html/__index.md
@@ -8,19 +8,23 @@ tags:
- needs-verification
- needs-example
lua:
- library: HTML
+ library: Html
function: __index
realm: client
description: "Metamethod called when a non-existent field is indexed"
arguments:
- - name: "field"
- type: string
+ - position: 1
+ name: "html"
+ type: Html
+ - position: 2
+ name: "field"
+ type: string
returns:
- type: any
description: "The value of the field"
---
-HTML:__index – Metamethod called when a non-existent field is indexed
+Html:__index – Metamethod called when a non-existent field is indexed
diff --git a/docs/classes/HTML/__newindex.md b/docs/classes/Html/__newindex.md
similarity index 64%
rename from docs/classes/HTML/__newindex.md
rename to docs/classes/Html/__newindex.md
index df077ca1ef..1533be9c0c 100644
--- a/docs/classes/HTML/__newindex.md
+++ b/docs/classes/Html/__newindex.md
@@ -8,18 +8,22 @@ tags:
- needs-verification
- needs-example
lua:
- library: HTML
+ library: Html
function: __newindex
realm: client
description: "Metamethod called when a new field is added"
arguments:
- - name: "field"
- type: string
+ - position: 1
+ name: "html"
+ type: Html
+ - position: 2
+ name: "field"
+ type: string
returns:
---
-HTML:__newindex – Metamethod called when a new field is added
+Html:__newindex – Metamethod called when a new field is added
diff --git a/docs/classes/HTML/__tostring.md b/docs/classes/Html/__tostring.md
similarity index 75%
rename from docs/classes/HTML/__tostring.md
rename to docs/classes/Html/__tostring.md
index 44a8aeccfb..f07b6458e8 100644
--- a/docs/classes/HTML/__tostring.md
+++ b/docs/classes/Html/__tostring.md
@@ -8,17 +8,20 @@ tags:
- needs-verification
- needs-example
lua:
- library: HTML
+ library: Html
function: __tostring
realm: client
description: "Metamethod called when the HTML object is converted to a string"
-
+ arguments:
+ - position: 1
+ name: "html"
+ type: Html
returns:
- type: string
description: "The string representation of the HTML object"
---
-HTML:__tostring – Metamethod called when the HTML object is converted to a string
+Html:__tostring – Metamethod called when the HTML object is converted to a string
diff --git a/docs/classes/HTML/index.md b/docs/classes/Html/index.md
similarity index 72%
rename from docs/classes/HTML/index.md
rename to docs/classes/Html/index.md
index b35f21bafd..c5ad038e79 100644
--- a/docs/classes/HTML/index.md
+++ b/docs/classes/Html/index.md
@@ -2,9 +2,9 @@
template: lua-index.html
childrenTitle: Methods
include:
- startsWith: classes/HTML/
+ startsWith: classes/Html/
exclude:
isIndex: true
---
-# HTML
+# Html
diff --git a/docs/classes/KeyValuesHandle/AddSubKey.md b/docs/classes/KeyValuesHandle/AddSubKey.md
index 0eed065af7..c10563338f 100644
--- a/docs/classes/KeyValuesHandle/AddSubKey.md
+++ b/docs/classes/KeyValuesHandle/AddSubKey.md
@@ -14,8 +14,12 @@ lua:
description: "Add a subkey to the keyvalues."
arguments:
- - name: "subKey"
- type: KeyValuesHandle
+ - position: 1
+ name: "keyValues"
+ type: KeyValuesHandle
+ - position: 2
+ name: "subKey"
+ type: KeyValuesHandle
returns:
---
diff --git a/docs/classes/KeyValuesHandle/ChainKeyValue.md b/docs/classes/KeyValuesHandle/ChainKeyValue.md
index 6d435a356b..a3e4affa0f 100644
--- a/docs/classes/KeyValuesHandle/ChainKeyValue.md
+++ b/docs/classes/KeyValuesHandle/ChainKeyValue.md
@@ -14,8 +14,12 @@ lua:
description: "Chain a keyvalue to the keyvalues."
arguments:
- - name: "keyValue"
- type: KeyValuesHandle
+ - position: 1
+ name: "keyValues"
+ type: KeyValuesHandle
+ - position: 2
+ name: "keyValue"
+ type: KeyValuesHandle
returns:
---
diff --git a/docs/classes/KeyValuesHandle/Clear.md b/docs/classes/KeyValuesHandle/Clear.md
index d6d563084d..8f97b363cf 100644
--- a/docs/classes/KeyValuesHandle/Clear.md
+++ b/docs/classes/KeyValuesHandle/Clear.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Clear the keyvalues."
-
+ arguments:
+ - position: 1
+ name: "keyValues"
+ type: KeyValuesHandle
returns:
---
diff --git a/docs/classes/KeyValuesHandle/CopySubkeys.md b/docs/classes/KeyValuesHandle/CopySubkeys.md
index 83ca341991..66b5fa5722 100644
--- a/docs/classes/KeyValuesHandle/CopySubkeys.md
+++ b/docs/classes/KeyValuesHandle/CopySubkeys.md
@@ -14,8 +14,12 @@ lua:
description: "Copy the subkeys from another keyvalues."
arguments:
- - name: "subKey"
- type: KeyValuesHandle
+ - position: 1
+ name: "keyValues"
+ type: KeyValuesHandle
+ - position: 2
+ name: "subKey"
+ type: KeyValuesHandle
returns:
---
diff --git a/docs/classes/KeyValuesHandle/CreateNewKey.md b/docs/classes/KeyValuesHandle/CreateNewKey.md
index af9e24666f..1d00b64763 100644
--- a/docs/classes/KeyValuesHandle/CreateNewKey.md
+++ b/docs/classes/KeyValuesHandle/CreateNewKey.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Create a new keyvalues key."
-
+ arguments:
+ - position: 1
+ name: "keyValues"
+ type: KeyValuesHandle
returns:
- type: KeyValuesHandle
description: "The new keyvalues key."
diff --git a/docs/classes/KeyValuesHandle/DeleteThis.md b/docs/classes/KeyValuesHandle/DeleteThis.md
index e63f8c14c5..8761445f3d 100644
--- a/docs/classes/KeyValuesHandle/DeleteThis.md
+++ b/docs/classes/KeyValuesHandle/DeleteThis.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Delete the keyvalues."
-
+ arguments:
+ - position: 1
+ name: "keyValues"
+ type: KeyValuesHandle
returns:
---
diff --git a/docs/classes/KeyValuesHandle/FindKey.md b/docs/classes/KeyValuesHandle/FindKey.md
index 9f6396557c..3320550781 100644
--- a/docs/classes/KeyValuesHandle/FindKey.md
+++ b/docs/classes/KeyValuesHandle/FindKey.md
@@ -13,16 +13,20 @@ lua:
realm: shared
description: "Find a key in the keyvalues."
- argumentSets:
- - arguments:
+ arguments:
+ - position: 1
+ name: "keyValues"
+ type: KeyValuesHandle
+ - position: 2
+ types:
- name: "key"
type: number
- - arguments:
- name: "key"
type: string
- - name: "recursive"
- type: boolean
- default: "false"
+ - position: 3
+ name: "recursive"
+ type: boolean
+ default: "false"
returns:
- type: KeyValuesHandle
description: "The keyvalues key."
diff --git a/docs/classes/KeyValuesHandle/GetColor.md b/docs/classes/KeyValuesHandle/GetColor.md
index 411d020897..94010faff6 100644
--- a/docs/classes/KeyValuesHandle/GetColor.md
+++ b/docs/classes/KeyValuesHandle/GetColor.md
@@ -13,14 +13,17 @@ lua:
realm: shared
description: "Get a color from the keyvalues."
- argumentSets:
- - arguments:
+ arguments:
+ - position: 1
+ name: "keyValues"
+ type: KeyValuesHandle
+ - position: 2
+ types:
- name: "key"
type: number
- - arguments:
- name: "key"
type: string
- default: "0"
+ default: "0"
returns:
- type: Color
description: "The value as a color."
diff --git a/docs/classes/KeyValuesHandle/GetDataType.md b/docs/classes/KeyValuesHandle/GetDataType.md
index edaadd19ee..18b1d8deb3 100644
--- a/docs/classes/KeyValuesHandle/GetDataType.md
+++ b/docs/classes/KeyValuesHandle/GetDataType.md
@@ -14,9 +14,13 @@ lua:
description: "Get the data type of a key in the keyvalues."
arguments:
- - name: "key"
- type: string
- default: "0"
+ - position: 1
+ name: "keyValues"
+ type: KeyValuesHandle
+ - position: 2
+ name: "key"
+ type: string
+ default: "0"
returns:
- type: integer
description: "The data type."
diff --git a/docs/classes/KeyValuesHandle/GetFirstSubKey.md b/docs/classes/KeyValuesHandle/GetFirstSubKey.md
index 906b7e7ca4..6d9143ad6f 100644
--- a/docs/classes/KeyValuesHandle/GetFirstSubKey.md
+++ b/docs/classes/KeyValuesHandle/GetFirstSubKey.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Get the first subkey of the keyvalues."
-
+ arguments:
+ - position: 1
+ name: "keyValues"
+ type: KeyValuesHandle
returns:
- type: KeyValuesHandle
description: "The first subkey."
diff --git a/docs/classes/KeyValuesHandle/GetFirstTrueSubKey.md b/docs/classes/KeyValuesHandle/GetFirstTrueSubKey.md
index ffd046b33e..8c07a59637 100644
--- a/docs/classes/KeyValuesHandle/GetFirstTrueSubKey.md
+++ b/docs/classes/KeyValuesHandle/GetFirstTrueSubKey.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Get the first true subkey of the keyvalues."
-
+ arguments:
+ - position: 1
+ name: "keyValues"
+ type: KeyValuesHandle
returns:
- type: KeyValuesHandle
description: "The first true subkey."
diff --git a/docs/classes/KeyValuesHandle/GetFirstValue.md b/docs/classes/KeyValuesHandle/GetFirstValue.md
index 002486737f..94cad8c38b 100644
--- a/docs/classes/KeyValuesHandle/GetFirstValue.md
+++ b/docs/classes/KeyValuesHandle/GetFirstValue.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Get the first value of the keyvalues."
-
+ arguments:
+ - position: 1
+ name: "keyValues"
+ type: KeyValuesHandle
returns:
- type: KeyValuesHandle
description: "The first value."
diff --git a/docs/classes/KeyValuesHandle/GetFloat.md b/docs/classes/KeyValuesHandle/GetFloat.md
index 1015ff9e26..306ef51d35 100644
--- a/docs/classes/KeyValuesHandle/GetFloat.md
+++ b/docs/classes/KeyValuesHandle/GetFloat.md
@@ -13,20 +13,25 @@ lua:
realm: shared
description: "Get a float from the keyvalues."
- argumentSets:
- - arguments:
+ arguments:
+ - position: 1
+ name: "keyValues"
+ type: KeyValuesHandle
+ - position: 2
+ types:
- name: "key"
type: number
- - name: "default"
- type: number
- default: "0.0f"
- - arguments:
- name: "key"
type: string
- default: "0"
+ default: "0"
+ - position: 3
+ types:
+ - name: "default"
+ type: number
+ default: "0.0f"
- name: "default"
type: number
- default: "0.0f"
+ default: "0.0f"
returns:
- type: number
description: "The value as a float."
diff --git a/docs/classes/KeyValuesHandle/GetInt.md b/docs/classes/KeyValuesHandle/GetInt.md
index 943b327798..1084ba2cfc 100644
--- a/docs/classes/KeyValuesHandle/GetInt.md
+++ b/docs/classes/KeyValuesHandle/GetInt.md
@@ -13,20 +13,25 @@ lua:
realm: shared
description: "Get an integer from the keyvalues."
- argumentSets:
- - arguments:
+ arguments:
+ - position: 1
+ name: "keyValues"
+ type: KeyValuesHandle
+ - position: 2
+ types:
- name: "key"
type: number
- - name: "default"
- type: number
- default: "0"
- - arguments:
- name: "key"
type: string
- default: "0"
+ default: "0"
+ - position: 3
+ types:
+ - name: "default"
+ type: number
+ default: "0"
- name: "default"
type: number
- default: "0"
+ default: "0"
returns:
- type: integer
description: "The value as an integer."
diff --git a/docs/classes/KeyValuesHandle/GetName.md b/docs/classes/KeyValuesHandle/GetName.md
index 616ab93a44..2808b58728 100644
--- a/docs/classes/KeyValuesHandle/GetName.md
+++ b/docs/classes/KeyValuesHandle/GetName.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Get the name of the keyvalues."
-
+ arguments:
+ - position: 1
+ name: "keyValues"
+ type: KeyValuesHandle
returns:
- type: string
description: "The name."
diff --git a/docs/classes/KeyValuesHandle/GetNameSymbol.md b/docs/classes/KeyValuesHandle/GetNameSymbol.md
index f6ad5a6fb7..46fedcb605 100644
--- a/docs/classes/KeyValuesHandle/GetNameSymbol.md
+++ b/docs/classes/KeyValuesHandle/GetNameSymbol.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Get the name symbol of the keyvalues."
-
+ arguments:
+ - position: 1
+ name: "keyValues"
+ type: KeyValuesHandle
returns:
- type: integer
description: "The name symbol."
diff --git a/docs/classes/KeyValuesHandle/GetNextKey.md b/docs/classes/KeyValuesHandle/GetNextKey.md
index d535af31eb..5a2042d723 100644
--- a/docs/classes/KeyValuesHandle/GetNextKey.md
+++ b/docs/classes/KeyValuesHandle/GetNextKey.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Get the next key of the keyvalues."
-
+ arguments:
+ - position: 1
+ name: "keyValues"
+ type: KeyValuesHandle
returns:
- type: KeyValuesHandle
description: "The next key."
diff --git a/docs/classes/KeyValuesHandle/GetNextTrueSubKey.md b/docs/classes/KeyValuesHandle/GetNextTrueSubKey.md
index 18bf2e6fdb..eabb346769 100644
--- a/docs/classes/KeyValuesHandle/GetNextTrueSubKey.md
+++ b/docs/classes/KeyValuesHandle/GetNextTrueSubKey.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Get the next true subkey of the keyvalues."
-
+ arguments:
+ - position: 1
+ name: "keyValues"
+ type: KeyValuesHandle
returns:
- type: KeyValuesHandle
description: "The next true subkey."
diff --git a/docs/classes/KeyValuesHandle/GetNextValue.md b/docs/classes/KeyValuesHandle/GetNextValue.md
index fdf53e45c3..5f5f46e98f 100644
--- a/docs/classes/KeyValuesHandle/GetNextValue.md
+++ b/docs/classes/KeyValuesHandle/GetNextValue.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Get the next value of the keyvalues."
-
+ arguments:
+ - position: 1
+ name: "keyValues"
+ type: KeyValuesHandle
returns:
- type: KeyValuesHandle
description: "The next value."
diff --git a/docs/classes/KeyValuesHandle/GetString.md b/docs/classes/KeyValuesHandle/GetString.md
index 18f4cb54b2..ca1767d19a 100644
--- a/docs/classes/KeyValuesHandle/GetString.md
+++ b/docs/classes/KeyValuesHandle/GetString.md
@@ -13,20 +13,25 @@ lua:
realm: shared
description: "Get a string from the keyvalues."
- argumentSets:
- - arguments:
+ arguments:
+ - position: 1
+ name: "keyValues"
+ type: KeyValuesHandle
+ - position: 2
+ types:
- name: "key"
type: number
- - name: "default"
- type: string
- default: "\"\""
- - arguments:
- name: "key"
type: string
- default: "0"
+ default: "0"
+ - position: 3
+ types:
+ - name: "default"
+ type: string
+ default: "\"\""
- name: "default"
type: string
- default: "\"\""
+ default: "\"\""
returns:
- type: string
description: "The value as a string."
diff --git a/docs/classes/KeyValuesHandle/IsEmpty.md b/docs/classes/KeyValuesHandle/IsEmpty.md
index 67eb76aec7..c4ba17bf4d 100644
--- a/docs/classes/KeyValuesHandle/IsEmpty.md
+++ b/docs/classes/KeyValuesHandle/IsEmpty.md
@@ -13,14 +13,17 @@ lua:
realm: shared
description: "Check if the keyvalues is empty."
- argumentSets:
- - arguments:
+ arguments:
+ - position: 1
+ name: "keyValues"
+ type: KeyValuesHandle
+ - position: 2
+ types:
- name: "key"
type: number
- - arguments:
- name: "key"
type: string
- default: "0"
+ default: "0"
returns:
- type: boolean
description: "true if the keyvalues is empty, false otherwise."
diff --git a/docs/classes/KeyValuesHandle/LoadFromFile.md b/docs/classes/KeyValuesHandle/LoadFromFile.md
index ddff092737..25b7dc4dcf 100644
--- a/docs/classes/KeyValuesHandle/LoadFromFile.md
+++ b/docs/classes/KeyValuesHandle/LoadFromFile.md
@@ -14,11 +14,16 @@ lua:
description: "Load keyvalues from a file."
arguments:
- - name: "filename"
- type: string
- - name: "pathID"
- type: string
- default: "0"
+ - position: 1
+ name: "keyValues"
+ type: KeyValuesHandle
+ - position: 2
+ name: "filename"
+ type: string
+ - position: 3
+ name: "pathID"
+ type: string
+ default: "0"
returns:
- type: boolean
description: "true if the keyvalues were loaded, false otherwise."
diff --git a/docs/classes/KeyValuesHandle/MakeCopy.md b/docs/classes/KeyValuesHandle/MakeCopy.md
index 6faf3a504b..d36b42d7d8 100644
--- a/docs/classes/KeyValuesHandle/MakeCopy.md
+++ b/docs/classes/KeyValuesHandle/MakeCopy.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Make a copy of the keyvalues."
-
+ arguments:
+ - position: 1
+ name: "keyValues"
+ type: KeyValuesHandle
returns:
- type: KeyValuesHandle
description: "The copy."
diff --git a/docs/classes/KeyValuesHandle/ProcessResolutionKeys.md b/docs/classes/KeyValuesHandle/ProcessResolutionKeys.md
index a96c1a43fa..a45a3f8517 100644
--- a/docs/classes/KeyValuesHandle/ProcessResolutionKeys.md
+++ b/docs/classes/KeyValuesHandle/ProcessResolutionKeys.md
@@ -14,8 +14,12 @@ lua:
description: "Process resolution keys in the keyvalues."
arguments:
- - name: "key"
- type: string
+ - position: 1
+ name: "keyValues"
+ type: KeyValuesHandle
+ - position: 2
+ name: "key"
+ type: string
returns:
- type: boolean
description: "true if the resolution keys were processed, false otherwise."
diff --git a/docs/classes/KeyValuesHandle/RemoveSubKey.md b/docs/classes/KeyValuesHandle/RemoveSubKey.md
index c9eac80b44..40acc63858 100644
--- a/docs/classes/KeyValuesHandle/RemoveSubKey.md
+++ b/docs/classes/KeyValuesHandle/RemoveSubKey.md
@@ -14,8 +14,12 @@ lua:
description: "Remove a subkey from the keyvalues."
arguments:
- - name: "subKey"
- type: KeyValuesHandle
+ - position: 1
+ name: "keyValues"
+ type: KeyValuesHandle
+ - position: 2
+ name: "subKey"
+ type: KeyValuesHandle
returns:
---
diff --git a/docs/classes/KeyValuesHandle/SaveToFile.md b/docs/classes/KeyValuesHandle/SaveToFile.md
index 6f7eeb5249..46ae150731 100644
--- a/docs/classes/KeyValuesHandle/SaveToFile.md
+++ b/docs/classes/KeyValuesHandle/SaveToFile.md
@@ -14,11 +14,16 @@ lua:
description: "Save keyvalues to a file."
arguments:
- - name: "filename"
- type: string
- - name: "pathID"
- type: string
- default: "0"
+ - position: 1
+ name: "keyValues"
+ type: KeyValuesHandle
+ - position: 2
+ name: "filename"
+ type: string
+ - position: 3
+ name: "pathID"
+ type: string
+ default: "0"
returns:
- type: boolean
description: "true if the keyvalues were saved, false otherwise."
diff --git a/docs/classes/KeyValuesHandle/SetColor.md b/docs/classes/KeyValuesHandle/SetColor.md
index 0f4f4d5062..0b5c543346 100644
--- a/docs/classes/KeyValuesHandle/SetColor.md
+++ b/docs/classes/KeyValuesHandle/SetColor.md
@@ -14,10 +14,15 @@ lua:
description: "Set a color in the keyvalues."
arguments:
- - name: "key"
- type: string
- - name: "color"
- type: Color
+ - position: 1
+ name: "keyValues"
+ type: KeyValuesHandle
+ - position: 2
+ name: "key"
+ type: string
+ - position: 3
+ name: "color"
+ type: Color
returns:
---
diff --git a/docs/classes/KeyValuesHandle/SetFloat.md b/docs/classes/KeyValuesHandle/SetFloat.md
index af0e702724..195f51a076 100644
--- a/docs/classes/KeyValuesHandle/SetFloat.md
+++ b/docs/classes/KeyValuesHandle/SetFloat.md
@@ -14,10 +14,15 @@ lua:
description: "Set a float in the keyvalues."
arguments:
- - name: "key"
- type: string
- - name: "value"
- type: number
+ - position: 1
+ name: "keyValues"
+ type: KeyValuesHandle
+ - position: 2
+ name: "key"
+ type: string
+ - position: 3
+ name: "value"
+ type: number
returns:
---
diff --git a/docs/classes/KeyValuesHandle/SetInt.md b/docs/classes/KeyValuesHandle/SetInt.md
index 866d99b633..35b62a99ab 100644
--- a/docs/classes/KeyValuesHandle/SetInt.md
+++ b/docs/classes/KeyValuesHandle/SetInt.md
@@ -14,10 +14,15 @@ lua:
description: "Set an integer in the keyvalues."
arguments:
- - name: "key"
- type: string
- - name: "value"
- type: number
+ - position: 1
+ name: "keyValues"
+ type: KeyValuesHandle
+ - position: 2
+ name: "key"
+ type: string
+ - position: 3
+ name: "value"
+ type: number
returns:
---
diff --git a/docs/classes/KeyValuesHandle/SetName.md b/docs/classes/KeyValuesHandle/SetName.md
index fce0b4a39d..cdcb99c39c 100644
--- a/docs/classes/KeyValuesHandle/SetName.md
+++ b/docs/classes/KeyValuesHandle/SetName.md
@@ -14,8 +14,12 @@ lua:
description: "Set the name of the keyvalues."
arguments:
- - name: "name"
- type: string
+ - position: 1
+ name: "keyValues"
+ type: KeyValuesHandle
+ - position: 2
+ name: "name"
+ type: string
returns:
---
diff --git a/docs/classes/KeyValuesHandle/SetNextKey.md b/docs/classes/KeyValuesHandle/SetNextKey.md
index 4077c05f6c..db354e3c06 100644
--- a/docs/classes/KeyValuesHandle/SetNextKey.md
+++ b/docs/classes/KeyValuesHandle/SetNextKey.md
@@ -14,8 +14,12 @@ lua:
description: "Set the next key of the keyvalues."
arguments:
- - name: "nextKey"
- type: KeyValuesHandle
+ - position: 1
+ name: "keyValues"
+ type: KeyValuesHandle
+ - position: 2
+ name: "nextKey"
+ type: KeyValuesHandle
returns:
---
diff --git a/docs/classes/KeyValuesHandle/SetString.md b/docs/classes/KeyValuesHandle/SetString.md
index ba278aa071..48bc06243e 100644
--- a/docs/classes/KeyValuesHandle/SetString.md
+++ b/docs/classes/KeyValuesHandle/SetString.md
@@ -14,10 +14,15 @@ lua:
description: "Set a string in the keyvalues."
arguments:
- - name: "key"
- type: string
- - name: "value"
- type: string
+ - position: 1
+ name: "keyValues"
+ type: KeyValuesHandle
+ - position: 2
+ name: "key"
+ type: string
+ - position: 3
+ name: "value"
+ type: string
returns:
---
diff --git a/docs/classes/KeyValuesHandle/SetStringValue.md b/docs/classes/KeyValuesHandle/SetStringValue.md
index 86b197f740..261b5bfc84 100644
--- a/docs/classes/KeyValuesHandle/SetStringValue.md
+++ b/docs/classes/KeyValuesHandle/SetStringValue.md
@@ -14,8 +14,12 @@ lua:
description: "Set a string value in the keyvalues."
arguments:
- - name: "value"
- type: string
+ - position: 1
+ name: "keyValues"
+ type: KeyValuesHandle
+ - position: 2
+ name: "value"
+ type: string
returns:
---
diff --git a/docs/classes/KeyValuesHandle/UsesEscapeSequences.md b/docs/classes/KeyValuesHandle/UsesEscapeSequences.md
index 5e33d108b4..37523de0c9 100644
--- a/docs/classes/KeyValuesHandle/UsesEscapeSequences.md
+++ b/docs/classes/KeyValuesHandle/UsesEscapeSequences.md
@@ -14,8 +14,12 @@ lua:
description: "Set if the keyvalues uses escape sequences."
arguments:
- - name: "usesEscapeSequences"
- type: boolean
+ - position: 1
+ name: "keyValues"
+ type: KeyValuesHandle
+ - position: 2
+ name: "usesEscapeSequences"
+ type: boolean
returns:
---
diff --git a/docs/classes/KeyValuesHandle/__eq.md b/docs/classes/KeyValuesHandle/__eq.md
index ccc11e036d..437ed06471 100644
--- a/docs/classes/KeyValuesHandle/__eq.md
+++ b/docs/classes/KeyValuesHandle/__eq.md
@@ -14,8 +14,12 @@ lua:
description: "Check if two keyvalues are equal."
arguments:
- - name: "keyValues"
- type: KeyValuesHandle
+ - position: 1
+ name: "keyValues"
+ type: KeyValuesHandle
+ - position: 2
+ name: "other"
+ type: KeyValuesHandle
returns:
- type: boolean
description: "true if the keyvalues are equal, false otherwise."
diff --git a/docs/classes/KeyValuesHandle/__tostring.md b/docs/classes/KeyValuesHandle/__tostring.md
index 41a7ddb65a..9b46c6cd10 100644
--- a/docs/classes/KeyValuesHandle/__tostring.md
+++ b/docs/classes/KeyValuesHandle/__tostring.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Get the string representation of the keyvalues."
-
+ arguments:
+ - position: 1
+ name: "keyValues"
+ type: KeyValuesHandle
returns:
- type: string
description: "The string representation."
diff --git a/docs/classes/Label/ClearImages.md b/docs/classes/Label/ClearImages.md
index 38e81e3aa8..6482f4047b 100644
--- a/docs/classes/Label/ClearImages.md
+++ b/docs/classes/Label/ClearImages.md
@@ -13,7 +13,10 @@ lua:
realm: client
description: "Clears the images of the label"
-
+ arguments:
+ - position: 1
+ name: "label"
+ type: Label
returns:
---
diff --git a/docs/classes/Label/GetContentSize.md b/docs/classes/Label/GetContentSize.md
index e02797f81c..cb9f8defef 100644
--- a/docs/classes/Label/GetContentSize.md
+++ b/docs/classes/Label/GetContentSize.md
@@ -13,7 +13,10 @@ lua:
realm: client
description: "Gets the size of the content"
-
+ arguments:
+ - position: 1
+ name: "label"
+ type: Label
returns:
- type: integer
description: "The width of the content"
diff --git a/docs/classes/Label/GetFont.md b/docs/classes/Label/GetFont.md
index 8e16b0cb72..75b2003af2 100644
--- a/docs/classes/Label/GetFont.md
+++ b/docs/classes/Label/GetFont.md
@@ -13,7 +13,10 @@ lua:
realm: client
description: "Gets the font of the label"
-
+ arguments:
+ - position: 1
+ name: "label"
+ type: Label
returns:
- type: font
description: "The font of the label"
diff --git a/docs/classes/Label/GetForegroundColor.md b/docs/classes/Label/GetForegroundColor.md
deleted file mode 100644
index e4a9eb2d34..0000000000
--- a/docs/classes/Label/GetForegroundColor.md
+++ /dev/null
@@ -1,24 +0,0 @@
----
-template: lua-class-function.html
-title: GetForegroundColor
-icon: lua-client
-tags:
- - lua
- - client
- - needs-verification
- - needs-example
-lua:
- library: Label
- function: GetForegroundColor
- realm: client
- description: "Gets the foreground color of the label"
-
-
- returns:
- - type: color
- description: "The foreground color of the label"
----
-
-
+MessageReader:ReadBitLong – Reads an signed/unsigned number of the specified bits long.
+
diff --git a/docs/classes/MessageReader/ReadBool.md b/docs/classes/MessageReader/ReadBool.md
new file mode 100644
index 0000000000..87a163755e
--- /dev/null
+++ b/docs/classes/MessageReader/ReadBool.md
@@ -0,0 +1,27 @@
+---
+template: lua-class-function.html
+title: ReadBool
+icon: lua-shared
+tags:
+ - lua
+ - shared
+ - needs-verification
+ - needs-example
+lua:
+ library: MessageReader
+ function: ReadBool
+ realm: shared
+ description: "Reads a boolean."
+
+ arguments:
+ - position: 1
+ name: "reader"
+ type: MessageReader
+ returns:
+ - type: boolean
+ description: "The boolean read."
+---
+
+
+MessageWriter:WriteBitLong – Writes an signed/unsigned number of the specified bits long.
+
diff --git a/docs/classes/MessageWriter/WriteBool.md b/docs/classes/MessageWriter/WriteBool.md
new file mode 100644
index 0000000000..6a6508039d
--- /dev/null
+++ b/docs/classes/MessageWriter/WriteBool.md
@@ -0,0 +1,29 @@
+---
+template: lua-class-function.html
+title: WriteBool
+icon: lua-shared
+tags:
+ - lua
+ - shared
+ - needs-verification
+ - needs-example
+lua:
+ library: MessageWriter
+ function: WriteBool
+ realm: shared
+ description: "Writes a boolean."
+
+ arguments:
+ - position: 1
+ name: "writer"
+ type: MessageWriter
+ - position: 2
+ name: "boolean"
+ type: boolean
+ returns:
+
+---
+
+
-_R.ModelImagePanel.GetPanelBaseClassName – Gets the base class name of the panel
-
diff --git a/docs/classes/ModelImagePanel/GetPanelClassName.md b/docs/classes/ModelImagePanel/GetPanelClassName.md
deleted file mode 100644
index 74b7d05c30..0000000000
--- a/docs/classes/ModelImagePanel/GetPanelClassName.md
+++ /dev/null
@@ -1,25 +0,0 @@
----
-template: lua-class-function.html
-title: GetPanelClassName
-icon: lua-client
-tags:
- - lua
- - client
- - needs-verification
- - needs-example
-lua:
- library: ModelImagePanel
- function: GetPanelClassName
- realm: client
- description: "Gets the class name of the panel"
-
- static: true
-
- returns:
- - type: string
- description: "The class name of the panel"
----
-
-
-Label:RequestInfo – OutputData - keyName is the name of the attribute requested. for Labels 'text' is an option that returns the default text image text returns true on success in finding the requested value. false on failure.
+Panel:RequestInfo – OutputData - keyName is the name of the attribute requested. for Labels 'text' is an option that returns the default text image text returns true on success in finding the requested value. false on failure.
diff --git a/docs/classes/Panel/RevertKeyBindingsToDefault.md b/docs/classes/Panel/RevertKeyBindingsToDefault.md
index 836d59de08..0bfa374cb6 100644
--- a/docs/classes/Panel/RevertKeyBindingsToDefault.md
+++ b/docs/classes/Panel/RevertKeyBindingsToDefault.md
@@ -13,7 +13,10 @@ lua:
realm: client
description: "Reverts the key bindings to default"
-
+ arguments:
+ - position: 1
+ name: "panel"
+ type: Panel
returns:
---
diff --git a/docs/classes/Panel/ScreenToLocal.md b/docs/classes/Panel/ScreenToLocal.md
index 9d18642323..950ea5eb00 100644
--- a/docs/classes/Panel/ScreenToLocal.md
+++ b/docs/classes/Panel/ScreenToLocal.md
@@ -13,7 +13,10 @@ lua:
realm: client
description: "Converts a screen position to a local position"
-
+ arguments:
+ - position: 1
+ name: "panel"
+ type: Panel
returns:
- type: integer
description: "The x position of the local"
diff --git a/docs/classes/Panel/SetAllowKeyBindingChainToParent.md b/docs/classes/Panel/SetAllowKeyBindingChainToParent.md
index a889717d92..6bfd6a6b74 100644
--- a/docs/classes/Panel/SetAllowKeyBindingChainToParent.md
+++ b/docs/classes/Panel/SetAllowKeyBindingChainToParent.md
@@ -14,8 +14,12 @@ lua:
description: "Sets whether the key binding chain is allowed to go to the parent"
arguments:
- - name: "allow"
- type: boolean
+ - position: 1
+ name: "panel"
+ type: Panel
+ - position: 2
+ name: "allow"
+ type: boolean
returns:
---
diff --git a/docs/classes/Panel/SetAlpha.md b/docs/classes/Panel/SetAlpha.md
index 1757a7f706..ed7e204522 100644
--- a/docs/classes/Panel/SetAlpha.md
+++ b/docs/classes/Panel/SetAlpha.md
@@ -14,8 +14,12 @@ lua:
description: "Sets the panel alpha"
arguments:
- - name: "alpha"
- type: number
+ - position: 1
+ name: "panel"
+ type: Panel
+ - position: 2
+ name: "alpha"
+ type: number
returns:
---
diff --git a/docs/classes/Panel/SetAutoDelete.md b/docs/classes/Panel/SetAutoDelete.md
index 55e32e775e..54c7d94ea7 100644
--- a/docs/classes/Panel/SetAutoDelete.md
+++ b/docs/classes/Panel/SetAutoDelete.md
@@ -14,8 +14,12 @@ lua:
description: "Sets whether the panel is auto deleted"
arguments:
- - name: "autoDelete"
- type: boolean
+ - position: 1
+ name: "panel"
+ type: Panel
+ - position: 2
+ name: "autoDelete"
+ type: boolean
returns:
---
diff --git a/docs/classes/Panel/SetAutoResize.md b/docs/classes/Panel/SetAutoResize.md
index ec1a62e4bd..a2f0f0c5e3 100644
--- a/docs/classes/Panel/SetAutoResize.md
+++ b/docs/classes/Panel/SetAutoResize.md
@@ -14,14 +14,27 @@ lua:
description: "Sets the auto resize"
arguments:
- - name: "pinOffsetX"
- type: number
- - name: "pinOffsetY"
- type: number
- - name: "unpinnedCornerOffsetX"
- type: number
- - name: "unpinnedCornerOffsetY"
- type: number
+ - position: 1
+ name: "panel"
+ type: Panel
+ - position: 2
+ name: "pinCorner"
+ type: enumeration/PIN_CORNER
+ - position: 3
+ name: "autoResize"
+ type: enumeration/AUTO_RESIZE
+ - position: 4
+ name: "pinOffsetX"
+ type: number
+ - position: 5
+ name: "pinOffsetY"
+ type: number
+ - position: 6
+ name: "unpinnedCornerOffsetX"
+ type: number
+ - position: 7
+ name: "unpinnedCornerOffsetY"
+ type: number
returns:
---
diff --git a/docs/classes/Panel/SetBackgroundColor.md b/docs/classes/Panel/SetBackgroundColor.md
index 4d9ec7ffda..7853c3cca9 100644
--- a/docs/classes/Panel/SetBackgroundColor.md
+++ b/docs/classes/Panel/SetBackgroundColor.md
@@ -14,8 +14,12 @@ lua:
description: "Sets the background color"
arguments:
- - name: "color"
- type: Color
+ - position: 1
+ name: "panel"
+ type: Panel
+ - position: 2
+ name: "color"
+ type: Color
returns:
---
diff --git a/docs/classes/Panel/SetBlockDragChaining.md b/docs/classes/Panel/SetBlockDragChaining.md
index 65fd73595d..e0c7c99e19 100644
--- a/docs/classes/Panel/SetBlockDragChaining.md
+++ b/docs/classes/Panel/SetBlockDragChaining.md
@@ -14,8 +14,12 @@ lua:
description: "Sets whether the drag chaining is blocked"
arguments:
- - name: "block"
- type: boolean
+ - position: 1
+ name: "panel"
+ type: Panel
+ - position: 2
+ name: "block"
+ type: boolean
returns:
---
diff --git a/docs/classes/Panel/SetBounds.md b/docs/classes/Panel/SetBounds.md
index 599d81987c..6d1b0e0675 100644
--- a/docs/classes/Panel/SetBounds.md
+++ b/docs/classes/Panel/SetBounds.md
@@ -14,14 +14,21 @@ lua:
description: "Sets the bounds"
arguments:
- - name: "x"
- type: number
- - name: "y"
- type: number
- - name: "width"
- type: number
- - name: "height"
- type: number
+ - position: 1
+ name: "panel"
+ type: Panel
+ - position: 2
+ name: "x"
+ type: number
+ - position: 3
+ name: "y"
+ type: number
+ - position: 4
+ name: "width"
+ type: number
+ - position: 5
+ name: "height"
+ type: number
returns:
---
diff --git a/docs/classes/Panel/SetBuildModeDeletable.md b/docs/classes/Panel/SetBuildModeDeletable.md
index d314bc0f2e..adf06bac8d 100644
--- a/docs/classes/Panel/SetBuildModeDeletable.md
+++ b/docs/classes/Panel/SetBuildModeDeletable.md
@@ -14,8 +14,12 @@ lua:
description: "Sets whether the build mode is deletable"
arguments:
- - name: "deletable"
- type: boolean
+ - position: 1
+ name: "panel"
+ type: Panel
+ - position: 2
+ name: "deletable"
+ type: boolean
returns:
---
diff --git a/docs/classes/Panel/SetBuildModeEditable.md b/docs/classes/Panel/SetBuildModeEditable.md
index 3270f9d97a..3e8e1ee4b2 100644
--- a/docs/classes/Panel/SetBuildModeEditable.md
+++ b/docs/classes/Panel/SetBuildModeEditable.md
@@ -14,8 +14,12 @@ lua:
description: "Sets whether the build mode is editable"
arguments:
- - name: "editable"
- type: boolean
+ - position: 1
+ name: "panel"
+ type: Panel
+ - position: 2
+ name: "editable"
+ type: boolean
returns:
---
diff --git a/docs/classes/Panel/SetCursor.md b/docs/classes/Panel/SetCursor.md
index 49f858d141..3dce8c137f 100644
--- a/docs/classes/Panel/SetCursor.md
+++ b/docs/classes/Panel/SetCursor.md
@@ -14,8 +14,12 @@ lua:
description: "Sets the cursor"
arguments:
- - name: "cursorCode"
- type: enumeration/CURSOR
+ - position: 1
+ name: "panel"
+ type: Panel
+ - position: 2
+ name: "cursorCode"
+ type: enumeration/CURSOR
returns:
---
diff --git a/docs/classes/Panel/SetDock.md b/docs/classes/Panel/SetDock.md
index a854d10aae..e41f4deee8 100644
--- a/docs/classes/Panel/SetDock.md
+++ b/docs/classes/Panel/SetDock.md
@@ -13,7 +13,13 @@ lua:
realm: client
description: "Sets the dock"
-
+ arguments:
+ - position: 1
+ name: "panel"
+ type: Panel
+ - position: 2
+ name: "dock"
+ type: enumeration/DOCK_TYPE
returns:
---
diff --git a/docs/classes/Panel/SetDockMargin.md b/docs/classes/Panel/SetDockMargin.md
index 2b0b8408d5..c2fee29e38 100644
--- a/docs/classes/Panel/SetDockMargin.md
+++ b/docs/classes/Panel/SetDockMargin.md
@@ -14,14 +14,21 @@ lua:
description: "Sets the dock margin"
arguments:
- - name: "left"
- type: number
- - name: "top"
- type: number
- - name: "right"
- type: number
- - name: "bottom"
- type: number
+ - position: 1
+ name: "panel"
+ type: Panel
+ - position: 2
+ name: "left"
+ type: number
+ - position: 3
+ name: "top"
+ type: number
+ - position: 4
+ name: "right"
+ type: number
+ - position: 5
+ name: "bottom"
+ type: number
returns:
---
diff --git a/docs/classes/Panel/SetDockPadding.md b/docs/classes/Panel/SetDockPadding.md
index b2da5153e9..02ea8e9bfe 100644
--- a/docs/classes/Panel/SetDockPadding.md
+++ b/docs/classes/Panel/SetDockPadding.md
@@ -14,14 +14,21 @@ lua:
description: "Sets the dock padding"
arguments:
- - name: "left"
- type: number
- - name: "top"
- type: number
- - name: "right"
- type: number
- - name: "bottom"
- type: number
+ - position: 1
+ name: "panel"
+ type: Panel
+ - position: 2
+ name: "left"
+ type: number
+ - position: 3
+ name: "top"
+ type: number
+ - position: 4
+ name: "right"
+ type: number
+ - position: 5
+ name: "bottom"
+ type: number
returns:
---
diff --git a/docs/classes/Panel/SetDragEnabled.md b/docs/classes/Panel/SetDragEnabled.md
index 608b8a49b1..fac266fa0c 100644
--- a/docs/classes/Panel/SetDragEnabled.md
+++ b/docs/classes/Panel/SetDragEnabled.md
@@ -14,8 +14,12 @@ lua:
description: "Sets whether the drag is enabled"
arguments:
- - name: "enabled"
- type: boolean
+ - position: 1
+ name: "panel"
+ type: Panel
+ - position: 2
+ name: "enabled"
+ type: boolean
returns:
---
diff --git a/docs/classes/Panel/SetDragStartTolerance.md b/docs/classes/Panel/SetDragStartTolerance.md
index adcee90b2d..dd71fa5d68 100644
--- a/docs/classes/Panel/SetDragStartTolerance.md
+++ b/docs/classes/Panel/SetDragStartTolerance.md
@@ -14,8 +14,12 @@ lua:
description: "Sets the drag start tolerance"
arguments:
- - name: "tolerance"
- type: number
+ - position: 1
+ name: "panel"
+ type: Panel
+ - position: 2
+ name: "tolerance"
+ type: number
returns:
---
diff --git a/docs/classes/Panel/SetDropEnabled.md b/docs/classes/Panel/SetDropEnabled.md
index 2ea1961c71..fecb1e4520 100644
--- a/docs/classes/Panel/SetDropEnabled.md
+++ b/docs/classes/Panel/SetDropEnabled.md
@@ -14,11 +14,16 @@ lua:
description: "Sets whether the drop is enabled"
arguments:
- - name: "enabled"
- type: boolean
- - name: "radius"
- type: number
- default: "0.0f"
+ - position: 1
+ name: "panel"
+ type: Panel
+ - position: 2
+ name: "enabled"
+ type: boolean
+ - position: 3
+ name: "radius"
+ type: number
+ default: "0.0f"
returns:
---
diff --git a/docs/classes/Panel/SetEnabled.md b/docs/classes/Panel/SetEnabled.md
index 8d14f2085f..4f44e89e65 100644
--- a/docs/classes/Panel/SetEnabled.md
+++ b/docs/classes/Panel/SetEnabled.md
@@ -14,8 +14,12 @@ lua:
description: "Sets whether the panel is enabled"
arguments:
- - name: "enabled"
- type: boolean
+ - position: 1
+ name: "panel"
+ type: Panel
+ - position: 2
+ name: "enabled"
+ type: boolean
returns:
---
diff --git a/docs/classes/Panel/SetForegroundColor.md b/docs/classes/Panel/SetForegroundColor.md
index d261910e7e..644c819a24 100644
--- a/docs/classes/Panel/SetForegroundColor.md
+++ b/docs/classes/Panel/SetForegroundColor.md
@@ -14,8 +14,12 @@ lua:
description: "Sets the foreground color"
arguments:
- - name: "color"
- type: Color
+ - position: 1
+ name: "panel"
+ type: Panel
+ - position: 2
+ name: "color"
+ type: Color
returns:
---
diff --git a/docs/classes/Panel/SetKeyboardInputEnabled.md b/docs/classes/Panel/SetKeyboardInputEnabled.md
index 3200ac2b75..9e096604cc 100644
--- a/docs/classes/Panel/SetKeyboardInputEnabled.md
+++ b/docs/classes/Panel/SetKeyboardInputEnabled.md
@@ -14,8 +14,12 @@ lua:
description: "Sets whether the keyboard input is enabled"
arguments:
- - name: "enabled"
- type: boolean
+ - position: 1
+ name: "panel"
+ type: Panel
+ - position: 2
+ name: "enabled"
+ type: boolean
returns:
---
diff --git a/docs/classes/Panel/SetMinimumSize.md b/docs/classes/Panel/SetMinimumSize.md
index 50d261c163..d9dc8eb743 100644
--- a/docs/classes/Panel/SetMinimumSize.md
+++ b/docs/classes/Panel/SetMinimumSize.md
@@ -14,10 +14,15 @@ lua:
description: "Sets the minimum size"
arguments:
- - name: "width"
- type: number
- - name: "height"
- type: number
+ - position: 1
+ name: "panel"
+ type: Panel
+ - position: 2
+ name: "width"
+ type: number
+ - position: 3
+ name: "height"
+ type: number
returns:
---
diff --git a/docs/classes/Panel/SetMouseInputEnabled.md b/docs/classes/Panel/SetMouseInputEnabled.md
index 76ffd8903b..70effcbef3 100644
--- a/docs/classes/Panel/SetMouseInputEnabled.md
+++ b/docs/classes/Panel/SetMouseInputEnabled.md
@@ -14,8 +14,12 @@ lua:
description: "Sets whether the mouse input is enabled"
arguments:
- - name: "enabled"
- type: boolean
+ - position: 1
+ name: "panel"
+ type: Panel
+ - position: 2
+ name: "enabled"
+ type: boolean
returns:
---
diff --git a/docs/classes/Panel/SetName.md b/docs/classes/Panel/SetName.md
index 2d6493b9fe..c8abdf101d 100644
--- a/docs/classes/Panel/SetName.md
+++ b/docs/classes/Panel/SetName.md
@@ -14,8 +14,12 @@ lua:
description: "Sets the name"
arguments:
- - name: "name"
- type: string
+ - position: 1
+ name: "panel"
+ type: Panel
+ - position: 2
+ name: "name"
+ type: string
returns:
---
diff --git a/docs/classes/Panel/SetPaintBackgroundEnabled.md b/docs/classes/Panel/SetPaintBackgroundEnabled.md
index cf30f933cb..19d639b8c8 100644
--- a/docs/classes/Panel/SetPaintBackgroundEnabled.md
+++ b/docs/classes/Panel/SetPaintBackgroundEnabled.md
@@ -14,8 +14,12 @@ lua:
description: "Sets whether the background is painted"
arguments:
- - name: "enabled"
- type: boolean
+ - position: 1
+ name: "panel"
+ type: Panel
+ - position: 2
+ name: "enabled"
+ type: boolean
returns:
---
diff --git a/docs/classes/Panel/SetPaintBackgroundType.md b/docs/classes/Panel/SetPaintBackgroundType.md
index 874dce3c2d..d64354f05f 100644
--- a/docs/classes/Panel/SetPaintBackgroundType.md
+++ b/docs/classes/Panel/SetPaintBackgroundType.md
@@ -14,8 +14,12 @@ lua:
description: "Sets the background type"
arguments:
- - name: "type"
- type: number
+ - position: 1
+ name: "panel"
+ type: Panel
+ - position: 2
+ name: "type"
+ type: number
returns:
---
diff --git a/docs/classes/Panel/SetPaintBorderEnabled.md b/docs/classes/Panel/SetPaintBorderEnabled.md
index 80544d13ee..a01899997d 100644
--- a/docs/classes/Panel/SetPaintBorderEnabled.md
+++ b/docs/classes/Panel/SetPaintBorderEnabled.md
@@ -14,8 +14,12 @@ lua:
description: "Sets whether the border is painted"
arguments:
- - name: "enabled"
- type: boolean
+ - position: 1
+ name: "panel"
+ type: Panel
+ - position: 2
+ name: "enabled"
+ type: boolean
returns:
---
diff --git a/docs/classes/Panel/SetPaintClippingEnabled.md b/docs/classes/Panel/SetPaintClippingEnabled.md
index 62f772ea28..57fa7bcf03 100644
--- a/docs/classes/Panel/SetPaintClippingEnabled.md
+++ b/docs/classes/Panel/SetPaintClippingEnabled.md
@@ -14,8 +14,12 @@ lua:
description: "Sets whether the clipping is painted"
arguments:
- - name: "enabled"
- type: boolean
+ - position: 1
+ name: "panel"
+ type: Panel
+ - position: 2
+ name: "enabled"
+ type: boolean
returns:
---
diff --git a/docs/classes/Panel/SetPaintEnabled.md b/docs/classes/Panel/SetPaintEnabled.md
index 58f6cf2485..541aadd3ab 100644
--- a/docs/classes/Panel/SetPaintEnabled.md
+++ b/docs/classes/Panel/SetPaintEnabled.md
@@ -14,8 +14,12 @@ lua:
description: "Sets whether the panel is painted"
arguments:
- - name: "enabled"
- type: boolean
+ - position: 1
+ name: "panel"
+ type: Panel
+ - position: 2
+ name: "enabled"
+ type: boolean
returns:
---
diff --git a/docs/classes/Panel/SetPaintedManually.md b/docs/classes/Panel/SetPaintedManually.md
new file mode 100644
index 0000000000..4ad27afaf6
--- /dev/null
+++ b/docs/classes/Panel/SetPaintedManually.md
@@ -0,0 +1,29 @@
+---
+template: lua-class-function.html
+title: SetPaintedManually
+icon: lua-client
+tags:
+ - lua
+ - client
+ - needs-verification
+ - needs-example
+lua:
+ library: Panel
+ function: SetPaintedManually
+ realm: client
+ description: "Sets whether the panel is painted manually"
+
+ arguments:
+ - position: 1
+ name: "panel"
+ type: Panel
+ - position: 2
+ name: "isPaintedManually"
+ type: boolean
+ returns:
+
+---
+
+
+Player:IsFlashlightEnabled – Check if the flashlight is enabled for the player.
+
diff --git a/docs/classes/Player/IsFlashlightOn.md b/docs/classes/Player/IsFlashlightOn.md
index c0afae7d8c..5fd454651d 100644
--- a/docs/classes/Player/IsFlashlightOn.md
+++ b/docs/classes/Player/IsFlashlightOn.md
@@ -1,22 +1,25 @@
---
template: lua-class-function.html
title: IsFlashlightOn
-icon: lua-server
+icon: lua-shared
tags:
- lua
- - server
+ - shared
- needs-verification
- needs-example
lua:
library: Player
function: IsFlashlightOn
- realm: server
+ realm: shared
description: "Check if the flashlight is on for the player."
-
+ arguments:
+ - position: 1
+ name: "player"
+ type: Player
returns:
- - type: integer
- description: "The flashlight state."
+ - type: boolean
+ description: "True if the flashlight is on, false otherwise."
---
diff --git a/docs/classes/Player/IsHltv.md b/docs/classes/Player/IsHltv.md
index 0a5754a3e0..218a6e92da 100644
--- a/docs/classes/Player/IsHltv.md
+++ b/docs/classes/Player/IsHltv.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Check if the player is HLTV."
-
+ arguments:
+ - position: 1
+ name: "player"
+ type: Player
returns:
- type: boolean
description: "Whether the player is HLTV."
diff --git a/docs/classes/Player/IsIlluminatedByFlashlight.md b/docs/classes/Player/IsIlluminatedByFlashlight.md
index 47a8308faa..35632e996d 100644
--- a/docs/classes/Player/IsIlluminatedByFlashlight.md
+++ b/docs/classes/Player/IsIlluminatedByFlashlight.md
@@ -14,8 +14,12 @@ lua:
description: "Check if the player is illuminated by the flashlight."
arguments:
- - name: "entity"
- type: Entity
+ - position: 1
+ name: "player"
+ type: Player
+ - position: 2
+ name: "entity"
+ type: Entity
returns:
- type: boolean
description: "Whether the player is illuminated by the flashlight."
diff --git a/docs/classes/Player/IsInVehicle.md b/docs/classes/Player/IsInVehicle.md
index bd38cc8e01..27354d75fc 100644
--- a/docs/classes/Player/IsInVehicle.md
+++ b/docs/classes/Player/IsInVehicle.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Check if the player is in a vehicle."
-
+ arguments:
+ - position: 1
+ name: "player"
+ type: Player
returns:
- type: boolean
description: "Whether the player is in a vehicle."
diff --git a/docs/classes/Player/IsKeyDown.md b/docs/classes/Player/IsKeyDown.md
index bf4cb4fae6..0043c36d36 100644
--- a/docs/classes/Player/IsKeyDown.md
+++ b/docs/classes/Player/IsKeyDown.md
@@ -14,8 +14,12 @@ lua:
description: "Check if a key is down."
arguments:
- - name: "keys"
- type: number
+ - position: 1
+ name: "player"
+ type: Player
+ - position: 2
+ name: "keys"
+ type: number
returns:
- type: boolean
description: "Whether the key is down."
diff --git a/docs/classes/Player/IsObserver.md b/docs/classes/Player/IsObserver.md
index bc4c0e18c2..e7342bf437 100644
--- a/docs/classes/Player/IsObserver.md
+++ b/docs/classes/Player/IsObserver.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Check if the player is an observer."
-
+ arguments:
+ - position: 1
+ name: "player"
+ type: Player
returns:
- type: boolean
description: "Whether the player is an observer."
diff --git a/docs/classes/Player/IsOnLadder.md b/docs/classes/Player/IsOnLadder.md
index d4b24bef0a..80892f7e4d 100644
--- a/docs/classes/Player/IsOnLadder.md
+++ b/docs/classes/Player/IsOnLadder.md
@@ -13,7 +13,10 @@ lua:
realm: server
description: "Check if the player is on a ladder."
-
+ arguments:
+ - position: 1
+ name: "player"
+ type: Player
returns:
- type: boolean
description: "Whether the player is on a ladder."
diff --git a/docs/classes/Player/IsPlayerUnderwater.md b/docs/classes/Player/IsPlayerUnderwater.md
index daa52930f7..bae35123cd 100644
--- a/docs/classes/Player/IsPlayerUnderwater.md
+++ b/docs/classes/Player/IsPlayerUnderwater.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Check if the player is underwater."
-
+ arguments:
+ - position: 1
+ name: "player"
+ type: Player
returns:
- type: boolean
description: "Whether the player is underwater."
diff --git a/docs/classes/Player/IsSinglePlayerGameEnding.md b/docs/classes/Player/IsSinglePlayerGameEnding.md
index 3a9164448b..670f598dc0 100644
--- a/docs/classes/Player/IsSinglePlayerGameEnding.md
+++ b/docs/classes/Player/IsSinglePlayerGameEnding.md
@@ -13,7 +13,10 @@ lua:
realm: server
description: "Check if the single player game is ending for the player."
-
+ arguments:
+ - position: 1
+ name: "player"
+ type: Player
returns:
- type: boolean
description: "Whether the single player game is ending."
diff --git a/docs/classes/Player/IsSpeaking.md b/docs/classes/Player/IsSpeaking.md
index 6699cf904e..88699e3812 100644
--- a/docs/classes/Player/IsSpeaking.md
+++ b/docs/classes/Player/IsSpeaking.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Check if the player is speaking."
-
+ arguments:
+ - position: 1
+ name: "player"
+ type: Player
returns:
- type: boolean
description: "Whether the player is speaking."
diff --git a/docs/classes/Player/IsSuitEquipped.md b/docs/classes/Player/IsSuitEquipped.md
index cdf8a7dea1..63f2fa2eba 100644
--- a/docs/classes/Player/IsSuitEquipped.md
+++ b/docs/classes/Player/IsSuitEquipped.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Check if the player has the HEV suit equipped."
-
+ arguments:
+ - position: 1
+ name: "player"
+ type: Player
returns:
- type: boolean
description: "Whether the player has the HEV suit equipped."
diff --git a/docs/classes/Player/IsUseableEntity.md b/docs/classes/Player/IsUseableEntity.md
index 5f72d40595..cb8cb2d301 100644
--- a/docs/classes/Player/IsUseableEntity.md
+++ b/docs/classes/Player/IsUseableEntity.md
@@ -14,10 +14,15 @@ lua:
description: "Check if the player can use an entity."
arguments:
- - name: "entity"
- type: Entity
- - name: "use type"
- type: number
+ - position: 1
+ name: "player"
+ type: Player
+ - position: 2
+ name: "entity"
+ type: Entity
+ - position: 3
+ name: "use type"
+ type: number
returns:
- type: boolean
description: "Whether the player can use the entity."
diff --git a/docs/classes/Player/IsValidObserverTarget.md b/docs/classes/Player/IsValidObserverTarget.md
index 7d7ca55541..09c98edd79 100644
--- a/docs/classes/Player/IsValidObserverTarget.md
+++ b/docs/classes/Player/IsValidObserverTarget.md
@@ -14,8 +14,12 @@ lua:
description: "Check if the observer target is valid for the player."
arguments:
- - name: "target"
- type: Entity
+ - position: 1
+ name: "player"
+ type: Player
+ - position: 2
+ name: "target"
+ type: Entity
returns:
- type: boolean
description: "Whether the observer target is valid."
diff --git a/docs/classes/Player/ItemPostFrame.md b/docs/classes/Player/ItemPostFrame.md
index bc0da6fa05..d76ff0fb5d 100644
--- a/docs/classes/Player/ItemPostFrame.md
+++ b/docs/classes/Player/ItemPostFrame.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Call the player's item post frame."
-
+ arguments:
+ - position: 1
+ name: "player"
+ type: Player
returns:
---
diff --git a/docs/classes/Player/ItemPreFrame.md b/docs/classes/Player/ItemPreFrame.md
index 2ff21e2105..50d183ee19 100644
--- a/docs/classes/Player/ItemPreFrame.md
+++ b/docs/classes/Player/ItemPreFrame.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Call the player's item pre frame."
-
+ arguments:
+ - position: 1
+ name: "player"
+ type: Player
returns:
---
diff --git a/docs/classes/Player/Jump.md b/docs/classes/Player/Jump.md
index 6004f922d0..2ede3765d9 100644
--- a/docs/classes/Player/Jump.md
+++ b/docs/classes/Player/Jump.md
@@ -13,7 +13,10 @@ lua:
realm: server
description: "Make the player jump."
-
+ arguments:
+ - position: 1
+ name: "player"
+ type: Player
returns:
---
diff --git a/docs/classes/Player/JumpToPosition.md b/docs/classes/Player/JumpToPosition.md
index 92446fee55..b550b595c3 100644
--- a/docs/classes/Player/JumpToPosition.md
+++ b/docs/classes/Player/JumpToPosition.md
@@ -14,10 +14,15 @@ lua:
description: "Jump to the specified position for the player."
arguments:
- - name: "position"
- type: Vector
- - name: "angle"
- type: Angle
+ - position: 1
+ name: "player"
+ type: Player
+ - position: 2
+ name: "position"
+ type: Vector
+ - position: 3
+ name: "angle"
+ type: Angle
returns:
---
diff --git a/docs/classes/Player/KeyDown.md b/docs/classes/Player/KeyDown.md
index 1417a4d455..bb261e202b 100644
--- a/docs/classes/Player/KeyDown.md
+++ b/docs/classes/Player/KeyDown.md
@@ -14,8 +14,12 @@ lua:
description: "Key down."
arguments:
- - name: "key"
- type: number
+ - position: 1
+ name: "entity"
+ type: Player
+ - position: 2
+ name: "key"
+ type: number
returns:
---
diff --git a/docs/classes/Player/Kill.md b/docs/classes/Player/Kill.md
new file mode 100644
index 0000000000..59ac1f391c
--- /dev/null
+++ b/docs/classes/Player/Kill.md
@@ -0,0 +1,30 @@
+---
+template: lua-class-function.html
+title: Kill
+icon: lua-server
+tags:
+ - lua
+ - server
+ - needs-verification
+ - needs-example
+lua:
+ library: Player
+ function: Kill
+ realm: server
+ description: "Force the player character to die, optionally with an explosion."
+
+ arguments:
+ - position: 1
+ name: "player"
+ type: Player
+ - position: 2
+ name: "shouldExplode"
+ type: boolean
+ default: "false"
+ returns:
+
+---
+
+
+Player:Kill – Force the player character to die, optionally with an explosion.
+
diff --git a/docs/classes/Player/KillSilent.md b/docs/classes/Player/KillSilent.md
new file mode 100644
index 0000000000..e0ee2368fb
--- /dev/null
+++ b/docs/classes/Player/KillSilent.md
@@ -0,0 +1,26 @@
+---
+template: lua-class-function.html
+title: KillSilent
+icon: lua-server
+tags:
+ - lua
+ - server
+ - needs-verification
+ - needs-example
+lua:
+ library: Player
+ function: KillSilent
+ realm: server
+ description: "Force the player character to die silently."
+
+ arguments:
+ - position: 1
+ name: "player"
+ type: Player
+ returns:
+
+---
+
+
+Player:KillSilent – Force the player character to die silently.
+
diff --git a/docs/classes/Player/LeaveVehicle.md b/docs/classes/Player/LeaveVehicle.md
index ef1a71af17..c6f39cb2af 100644
--- a/docs/classes/Player/LeaveVehicle.md
+++ b/docs/classes/Player/LeaveVehicle.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Make the player leave their vehicle."
-
+ arguments:
+ - position: 1
+ name: "player"
+ type: Player
returns:
---
diff --git a/docs/classes/Player/LockPlayerInPlace.md b/docs/classes/Player/Lock.md
similarity index 65%
rename from docs/classes/Player/LockPlayerInPlace.md
rename to docs/classes/Player/Lock.md
index b00615fca8..d914ba0106 100644
--- a/docs/classes/Player/LockPlayerInPlace.md
+++ b/docs/classes/Player/Lock.md
@@ -1,6 +1,6 @@
---
template: lua-class-function.html
-title: LockPlayerInPlace
+title: Lock
icon: lua-server
tags:
- lua
@@ -9,15 +9,18 @@ tags:
- needs-example
lua:
library: Player
- function: LockPlayerInPlace
+ function: Lock
realm: server
description: "Lock the player in place."
-
+ arguments:
+ - position: 1
+ name: "player"
+ type: Player
returns:
---
-Player:LockPlayerInPlace – Lock the player in place.
+Player:Lock – Lock the player in place.
diff --git a/docs/classes/Player/ModeWantsSpectatorGui.md b/docs/classes/Player/ModeWantsSpectatorGui.md
index d0cb37f7fa..47126c1a6a 100644
--- a/docs/classes/Player/ModeWantsSpectatorGui.md
+++ b/docs/classes/Player/ModeWantsSpectatorGui.md
@@ -14,8 +14,12 @@ lua:
description: "Check if the observer mode wants the spectator GUI for the player."
arguments:
- - name: "mode"
- type: enumeration/OBSERVER_MODE
+ - position: 1
+ name: "player"
+ type: Player
+ - position: 2
+ name: "mode"
+ type: enumeration/OBSERVER_MODE
returns:
- type: boolean
description: "Whether the observer mode wants the spectator GUI."
diff --git a/docs/classes/Player/NotifySinglePlayerGameEnding.md b/docs/classes/Player/NotifySinglePlayerGameEnding.md
index 9c239a2b16..cde2d4ac67 100644
--- a/docs/classes/Player/NotifySinglePlayerGameEnding.md
+++ b/docs/classes/Player/NotifySinglePlayerGameEnding.md
@@ -13,7 +13,10 @@ lua:
realm: server
description: "Notify the player that the single player game is ending."
-
+ arguments:
+ - position: 1
+ name: "player"
+ type: Player
returns:
---
diff --git a/docs/classes/Player/OnEventDying.md b/docs/classes/Player/OnEventDying.md
index 0905472e41..4b7ecda933 100644
--- a/docs/classes/Player/OnEventDying.md
+++ b/docs/classes/Player/OnEventDying.md
@@ -14,8 +14,12 @@ lua:
description: "Call to handle dying for the player."
arguments:
- - name: "info"
- type: DamageInfo
+ - position: 1
+ name: "player"
+ type: Player
+ - position: 2
+ name: "info"
+ type: DamageInfo
returns:
---
diff --git a/docs/classes/Player/OnEventTakeDamageAlive.md b/docs/classes/Player/OnEventTakeDamageAlive.md
index 4a0681f946..f6a408e124 100644
--- a/docs/classes/Player/OnEventTakeDamageAlive.md
+++ b/docs/classes/Player/OnEventTakeDamageAlive.md
@@ -14,8 +14,12 @@ lua:
description: "Call to handle taking damage while alive for the player."
arguments:
- - name: "info"
- type: DamageInfo
+ - position: 1
+ name: "player"
+ type: Player
+ - position: 2
+ name: "info"
+ type: DamageInfo
returns:
- type: integer
description: "The result of taking damage."
diff --git a/docs/classes/Player/OnVehicleStart.md b/docs/classes/Player/OnVehicleStart.md
index 0d94417b4a..34d2cfddf7 100644
--- a/docs/classes/Player/OnVehicleStart.md
+++ b/docs/classes/Player/OnVehicleStart.md
@@ -13,7 +13,10 @@ lua:
realm: server
description: "Handle the vehicle start for the player."
-
+ arguments:
+ - position: 1
+ name: "player"
+ type: Player
returns:
---
diff --git a/docs/classes/Player/OwnsWeaponOfType.md b/docs/classes/Player/OwnsWeaponOfType.md
index 5a01561723..3a96e71c09 100644
--- a/docs/classes/Player/OwnsWeaponOfType.md
+++ b/docs/classes/Player/OwnsWeaponOfType.md
@@ -14,13 +14,18 @@ lua:
description: "Check if the player owns a weapon of a certain type."
arguments:
- - name: "type"
- type: string
- - name: "subType"
- type: number
- default: "0"
+ - position: 1
+ name: "player"
+ type: Player
+ - position: 2
+ name: "type"
+ type: string
+ - position: 3
+ name: "subType"
+ type: number
+ default: "0"
returns:
- - type: Player
+ - type: Weapon
description: "The weapon the player owns of the specified type."
---
diff --git a/docs/classes/Player/PackDeadPlayerItems.md b/docs/classes/Player/PackDeadPlayerItems.md
index 2e5faebad9..30d1c5311c 100644
--- a/docs/classes/Player/PackDeadPlayerItems.md
+++ b/docs/classes/Player/PackDeadPlayerItems.md
@@ -13,7 +13,10 @@ lua:
realm: server
description: "Pack the dead player items."
-
+ arguments:
+ - position: 1
+ name: "player"
+ type: Player
returns:
---
diff --git a/docs/classes/Player/PauseBonusProgress.md b/docs/classes/Player/PauseBonusProgress.md
index 00f112d274..f1ef0f60e5 100644
--- a/docs/classes/Player/PauseBonusProgress.md
+++ b/docs/classes/Player/PauseBonusProgress.md
@@ -14,9 +14,13 @@ lua:
description: "Pause or unpause the bonus progress for the player."
arguments:
- - name: "shouldPause"
- type: boolean
- default: "true"
+ - position: 1
+ name: "player"
+ type: Player
+ - position: 2
+ name: "shouldPause"
+ type: boolean
+ default: "true"
returns:
---
diff --git a/docs/classes/Player/PlayDeathSound.md b/docs/classes/Player/PlayDeathSound.md
index c3b52203f4..a1ddf9301d 100644
--- a/docs/classes/Player/PlayDeathSound.md
+++ b/docs/classes/Player/PlayDeathSound.md
@@ -14,8 +14,12 @@ lua:
description: "Play the death sound for the player."
arguments:
- - name: "info"
- type: DamageInfo
+ - position: 1
+ name: "player"
+ type: Player
+ - position: 2
+ name: "info"
+ type: DamageInfo
returns:
---
diff --git a/docs/classes/Player/PlayStepSound.md b/docs/classes/Player/PlayStepSound.md
index bf99055584..f3a91d6296 100644
--- a/docs/classes/Player/PlayStepSound.md
+++ b/docs/classes/Player/PlayStepSound.md
@@ -14,14 +14,21 @@ lua:
description: "Play a step sound for the player."
arguments:
- - name: "origin"
- type: Vector
- - name: "surface data"
- type: SurfaceData
- - name: "volume"
- type: number
- - name: "force"
- type: boolean
+ - position: 1
+ name: "player"
+ type: Player
+ - position: 2
+ name: "origin"
+ type: Vector
+ - position: 3
+ name: "surface data"
+ type: SurfaceData
+ - position: 4
+ name: "volume"
+ type: number
+ - position: 5
+ name: "force"
+ type: boolean
returns:
---
diff --git a/docs/classes/Player/PlayerDeathThink.md b/docs/classes/Player/PlayerDeathThink.md
index 1d04505180..654c2ef79d 100644
--- a/docs/classes/Player/PlayerDeathThink.md
+++ b/docs/classes/Player/PlayerDeathThink.md
@@ -13,7 +13,10 @@ lua:
realm: server
description: "Think about death for the player."
-
+ arguments:
+ - position: 1
+ name: "player"
+ type: Player
returns:
---
diff --git a/docs/classes/Player/PlayerUse.md b/docs/classes/Player/PlayerUse.md
index 46714e3d2d..07b966616b 100644
--- a/docs/classes/Player/PlayerUse.md
+++ b/docs/classes/Player/PlayerUse.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Make the player use an entity."
-
+ arguments:
+ - position: 1
+ name: "player"
+ type: Player
returns:
---
diff --git a/docs/classes/Player/PostThink.md b/docs/classes/Player/PostThink.md
index f87cb98d63..87426044c1 100644
--- a/docs/classes/Player/PostThink.md
+++ b/docs/classes/Player/PostThink.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Call the player's post think."
-
+ arguments:
+ - position: 1
+ name: "player"
+ type: Player
returns:
---
diff --git a/docs/classes/Player/PreThink.md b/docs/classes/Player/PreThink.md
index 99a02c3d2e..b88282d338 100644
--- a/docs/classes/Player/PreThink.md
+++ b/docs/classes/Player/PreThink.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Call the player's pre think."
-
+ arguments:
+ - position: 1
+ name: "player"
+ type: Player
returns:
---
diff --git a/docs/classes/Player/RemoveAllAmmo.md b/docs/classes/Player/RemoveAllAmmo.md
index 1fb2692460..676fbbaeff 100644
--- a/docs/classes/Player/RemoveAllAmmo.md
+++ b/docs/classes/Player/RemoveAllAmmo.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Remove all ammo from the player."
-
+ arguments:
+ - position: 1
+ name: "player"
+ type: Player
returns:
---
diff --git a/docs/classes/Player/RemoveAllItems.md b/docs/classes/Player/RemoveAllItems.md
index 727672a223..a1ae39e9b0 100644
--- a/docs/classes/Player/RemoveAllItems.md
+++ b/docs/classes/Player/RemoveAllItems.md
@@ -14,9 +14,13 @@ lua:
description: "Remove all items from the player."
arguments:
- - name: "shouldRemoveSuit"
- type: boolean
- default: "false"
+ - position: 1
+ name: "player"
+ type: Player
+ - position: 2
+ name: "shouldRemoveSuit"
+ type: boolean
+ default: "false"
returns:
---
diff --git a/docs/classes/Player/RemoveAmmo.md b/docs/classes/Player/RemoveAmmo.md
index 4458af3d66..c1e32c0596 100644
--- a/docs/classes/Player/RemoveAmmo.md
+++ b/docs/classes/Player/RemoveAmmo.md
@@ -13,15 +13,20 @@ lua:
realm: shared
description: "Remove ammo from the player."
- argumentSets:
- - arguments:
+ arguments:
+ - position: 1
+ name: "player"
+ type: Player
+ - position: 2
+ types:
- name: "amount"
type: number
- - name: "ammo type"
- type: number
- - arguments:
- name: "amount"
type: number
+ - position: 3
+ types:
+ - name: "ammo type"
+ type: number
- name: "ammo name"
type: string
returns:
diff --git a/docs/classes/Player/RemoveFromPlayerSimulationList.md b/docs/classes/Player/RemoveFromPlayerSimulationList.md
index b4e8197ab9..90e960d8fd 100644
--- a/docs/classes/Player/RemoveFromPlayerSimulationList.md
+++ b/docs/classes/Player/RemoveFromPlayerSimulationList.md
@@ -14,8 +14,12 @@ lua:
description: "Remove an entity from the player's simulation list."
arguments:
- - name: "entity"
- type: Entity
+ - position: 1
+ name: "player"
+ type: Player
+ - position: 2
+ name: "entity"
+ type: Entity
returns:
---
diff --git a/docs/classes/Player/RemoveSuit.md b/docs/classes/Player/RemoveSuit.md
index c9afd9234f..ef89392fe5 100644
--- a/docs/classes/Player/RemoveSuit.md
+++ b/docs/classes/Player/RemoveSuit.md
@@ -13,7 +13,10 @@ lua:
realm: server
description: "Remove the suit for the player."
-
+ arguments:
+ - position: 1
+ name: "player"
+ type: Player
returns:
---
diff --git a/docs/classes/Player/RemoveWeapon.md b/docs/classes/Player/RemoveWeapon.md
index 2ea69dd29d..1cbbdf584e 100644
--- a/docs/classes/Player/RemoveWeapon.md
+++ b/docs/classes/Player/RemoveWeapon.md
@@ -14,8 +14,12 @@ lua:
description: "Remove the weapon for the player."
arguments:
- - name: "weapon"
- type: Weapon
+ - position: 1
+ name: "player"
+ type: Player
+ - position: 2
+ name: "weapon"
+ type: Weapon
returns:
- type: boolean
description: "Whether the weapon was removed."
diff --git a/docs/classes/Player/ResetAutoAim.md b/docs/classes/Player/ResetAutoAim.md
index 8ce4c083c0..40048cb87e 100644
--- a/docs/classes/Player/ResetAutoAim.md
+++ b/docs/classes/Player/ResetAutoAim.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Reset the player's autoaim."
-
+ arguments:
+ - position: 1
+ name: "player"
+ type: Player
returns:
---
diff --git a/docs/classes/Player/ResetObserverMode.md b/docs/classes/Player/ResetObserverMode.md
index d60d6a4479..60ffcb500d 100644
--- a/docs/classes/Player/ResetObserverMode.md
+++ b/docs/classes/Player/ResetObserverMode.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Reset the player's observer mode."
-
+ arguments:
+ - position: 1
+ name: "player"
+ type: Player
returns:
---
diff --git a/docs/classes/Player/RumbleEffect.md b/docs/classes/Player/RumbleEffect.md
index 3129f657d6..3e07a1ed41 100644
--- a/docs/classes/Player/RumbleEffect.md
+++ b/docs/classes/Player/RumbleEffect.md
@@ -14,12 +14,18 @@ lua:
description: "Apply a rumble effect to the player."
arguments:
- - name: "index"
- type: number
- - name: "duration"
- type: number
- - name: "flags"
- type: number
+ - position: 1
+ name: "player"
+ type: Player
+ - position: 2
+ name: "index"
+ type: number
+ - position: 3
+ name: "duration"
+ type: number
+ - position: 4
+ name: "flags"
+ type: number
returns:
---
diff --git a/docs/classes/Player/SelectItem.md b/docs/classes/Player/SelectItem.md
index 0a2e6edf1c..df33db5e92 100644
--- a/docs/classes/Player/SelectItem.md
+++ b/docs/classes/Player/SelectItem.md
@@ -14,11 +14,16 @@ lua:
description: "Select an item for the player."
arguments:
- - name: "item name"
- type: string
- - name: "slot"
- type: number
- default: "0"
+ - position: 1
+ name: "player"
+ type: Player
+ - position: 2
+ name: "item name"
+ type: string
+ - position: 3
+ name: "slot"
+ type: number
+ default: "0"
returns:
---
diff --git a/docs/classes/Player/SelectLastItem.md b/docs/classes/Player/SelectLastItem.md
index 527aec9daa..0611c49c90 100644
--- a/docs/classes/Player/SelectLastItem.md
+++ b/docs/classes/Player/SelectLastItem.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Select the player's last item."
-
+ arguments:
+ - position: 1
+ name: "player"
+ type: Player
returns:
---
diff --git a/docs/classes/Player/SelectSpawnPoint.md b/docs/classes/Player/SelectSpawnPoint.md
index ce074c457f..7feff4579e 100644
--- a/docs/classes/Player/SelectSpawnPoint.md
+++ b/docs/classes/Player/SelectSpawnPoint.md
@@ -13,7 +13,10 @@ lua:
realm: server
description: "Select a spawn point for the player."
-
+ arguments:
+ - position: 1
+ name: "player"
+ type: Player
returns:
---
diff --git a/docs/classes/Player/SetAmmoCount.md b/docs/classes/Player/SetAmmoCount.md
index cd66a91455..e2baa0b27e 100644
--- a/docs/classes/Player/SetAmmoCount.md
+++ b/docs/classes/Player/SetAmmoCount.md
@@ -14,10 +14,15 @@ lua:
description: "Set the player's ammo count."
arguments:
- - name: "amount"
- type: number
- - name: "ammo type"
- type: number
+ - position: 1
+ name: "player"
+ type: Player
+ - position: 2
+ name: "amount"
+ type: number
+ - position: 3
+ name: "ammo type"
+ type: number
returns:
---
diff --git a/docs/classes/Player/SetAnimation.md b/docs/classes/Player/SetAnimation.md
index d4fae689f6..e5746ad7f7 100644
--- a/docs/classes/Player/SetAnimation.md
+++ b/docs/classes/Player/SetAnimation.md
@@ -14,8 +14,12 @@ lua:
description: "Set the player's animation."
arguments:
- - name: "animation"
- type: enumeration/PLAYER_ANIMATION
+ - position: 1
+ name: "player"
+ type: Player
+ - position: 2
+ name: "animation"
+ type: enumeration/PLAYER_ANIMATION
returns:
---
diff --git a/docs/classes/Player/SetAnimationExtension.md b/docs/classes/Player/SetAnimationExtension.md
index cf9ef750b7..c5131391a5 100644
--- a/docs/classes/Player/SetAnimationExtension.md
+++ b/docs/classes/Player/SetAnimationExtension.md
@@ -14,8 +14,12 @@ lua:
description: "Set the player's animation extension."
arguments:
- - name: "extension"
- type: string
+ - position: 1
+ name: "player"
+ type: Player
+ - position: 2
+ name: "extension"
+ type: string
returns:
---
diff --git a/docs/classes/Player/SetBloodColor.md b/docs/classes/Player/SetBloodColor.md
index 3229b99151..ec8729004a 100644
--- a/docs/classes/Player/SetBloodColor.md
+++ b/docs/classes/Player/SetBloodColor.md
@@ -14,8 +14,12 @@ lua:
description: "Set the player's blood color."
arguments:
- - name: "color"
- type: number
+ - position: 1
+ name: "player"
+ type: Player
+ - position: 2
+ name: "color"
+ type: number
returns:
---
diff --git a/docs/classes/Player/SetBodyPitch.md b/docs/classes/Player/SetBodyPitch.md
index d21c0eb522..9e253c1dda 100644
--- a/docs/classes/Player/SetBodyPitch.md
+++ b/docs/classes/Player/SetBodyPitch.md
@@ -14,8 +14,12 @@ lua:
description: "Set the body pitch of the player."
arguments:
- - name: "pitch"
- type: number
+ - position: 1
+ name: "player"
+ type: Player
+ - position: 2
+ name: "pitch"
+ type: number
returns:
---
diff --git a/docs/classes/Player/SetBonusChallenge.md b/docs/classes/Player/SetBonusChallenge.md
index cd28a125a9..c1e2484b90 100644
--- a/docs/classes/Player/SetBonusChallenge.md
+++ b/docs/classes/Player/SetBonusChallenge.md
@@ -14,8 +14,12 @@ lua:
description: "Set the bonus challenge for the player."
arguments:
- - name: "challenge"
- type: number
+ - position: 1
+ name: "player"
+ type: Player
+ - position: 2
+ name: "challenge"
+ type: number
returns:
---
diff --git a/docs/classes/Player/SetBonusProgress.md b/docs/classes/Player/SetBonusProgress.md
index b31760a0d6..5cdaa80abe 100644
--- a/docs/classes/Player/SetBonusProgress.md
+++ b/docs/classes/Player/SetBonusProgress.md
@@ -14,8 +14,12 @@ lua:
description: "Set the bonus progress for the player."
arguments:
- - name: "progress"
- type: number
+ - position: 1
+ name: "player"
+ type: Player
+ - position: 2
+ name: "progress"
+ type: number
returns:
---
diff --git a/docs/classes/Player/SetCrouchWalkFraction.md b/docs/classes/Player/SetCrouchWalkFraction.md
index 25f2b16a61..25614713f9 100644
--- a/docs/classes/Player/SetCrouchWalkFraction.md
+++ b/docs/classes/Player/SetCrouchWalkFraction.md
@@ -14,8 +14,12 @@ lua:
description: "Set the fraction by which player's walk speed will be multiplied when crouched."
arguments:
- - name: "speed"
- type: number
+ - position: 1
+ name: "player"
+ type: Player
+ - position: 2
+ name: "speed"
+ type: number
returns:
---
diff --git a/docs/classes/Player/SetDropActiveWeaponOnDeath.md b/docs/classes/Player/SetDropActiveWeaponOnDeath.md
new file mode 100644
index 0000000000..1ca085adac
--- /dev/null
+++ b/docs/classes/Player/SetDropActiveWeaponOnDeath.md
@@ -0,0 +1,29 @@
+---
+template: lua-class-function.html
+title: SetDropActiveWeaponOnDeath
+icon: lua-server
+tags:
+ - lua
+ - server
+ - needs-verification
+ - needs-example
+lua:
+ library: Player
+ function: SetDropActiveWeaponOnDeath
+ realm: server
+ description: "Specify if the player should drop their active weapon when they die."
+
+ arguments:
+ - position: 1
+ name: "player"
+ type: Player
+ - position: 2
+ name: "dropActiveWeaponOnDeath"
+ type: boolean
+ returns:
+
+---
+
+
+Player:SetDropActiveWeaponOnDeath – Specify if the player should drop their active weapon when they die.
+
diff --git a/docs/classes/Player/SetDsp.md b/docs/classes/Player/SetDsp.md
new file mode 100644
index 0000000000..01277c2fdd
--- /dev/null
+++ b/docs/classes/Player/SetDsp.md
@@ -0,0 +1,33 @@
+---
+template: lua-class-function.html
+title: SetDsp
+icon: lua-shared
+tags:
+ - lua
+ - shared
+ - needs-verification
+ - needs-example
+lua:
+ library: Player
+ function: SetDsp
+ realm: shared
+ description: "Set the player's DSP."
+
+ arguments:
+ - position: 1
+ name: "player"
+ type: Player
+ - position: 2
+ name: "dspEffectId"
+ type: integer
+ - position: 3
+ name: "fastReset"
+ type: boolean
+ default: "false"
+ returns:
+
+---
+
+
+Player:SetDsp – Set the player's DSP.
+
diff --git a/docs/classes/Player/SetDuckSpeed.md b/docs/classes/Player/SetDuckSpeed.md
new file mode 100644
index 0000000000..88e8650bcf
--- /dev/null
+++ b/docs/classes/Player/SetDuckSpeed.md
@@ -0,0 +1,29 @@
+---
+template: lua-class-function.html
+title: SetDuckSpeed
+icon: lua-shared
+tags:
+ - lua
+ - shared
+ - needs-verification
+ - needs-example
+lua:
+ library: Player
+ function: SetDuckSpeed
+ realm: shared
+ description: "Set the player's duck speed. This **should not** suffer from this bug that Garry's Mod has: https://github.com/Facepunch/garrysmod-issues/issues/2722"
+
+ arguments:
+ - position: 1
+ name: "player"
+ type: Player
+ - position: 2
+ name: "speedInMilliseconds"
+ type: number
+ returns:
+
+---
+
+
+Player:SetDuckSpeed – Set the player's duck speed. This **should not** suffer from this bug that Garry's Mod has: https://github.com/Facepunch/garrysmod-issues/issues/2722
+
diff --git a/docs/classes/Player/SetFlashlightEnabled.md b/docs/classes/Player/SetFlashlightEnabled.md
index c771b1a825..862ef9a848 100644
--- a/docs/classes/Player/SetFlashlightEnabled.md
+++ b/docs/classes/Player/SetFlashlightEnabled.md
@@ -14,8 +14,12 @@ lua:
description: "Enable or disable the flashlight for the player."
arguments:
- - name: "shouldEnable"
- type: boolean
+ - position: 1
+ name: "player"
+ type: Player
+ - position: 2
+ name: "shouldEnable"
+ type: boolean
returns:
---
diff --git a/docs/classes/Player/SetFov.md b/docs/classes/Player/SetFov.md
index 26297cf454..66939314a2 100644
--- a/docs/classes/Player/SetFov.md
+++ b/docs/classes/Player/SetFov.md
@@ -14,14 +14,20 @@ lua:
description: "Set the player's field of view."
arguments:
- - name: "requester"
- type: Entity
- default: "PLAYER_THEMSELVES"
- - name: "fov"
- type: number
- - name: "transitionTime"
- type: number
- default: "0"
+ - position: 1
+ name: "player"
+ type: Player
+ - position: 2
+ name: "fov"
+ type: number
+ - position: 3
+ name: "transitionTime"
+ type: number
+ default: "0"
+ - position: 4
+ name: "requester"
+ type: Entity
+ default: "PLAYER_THEMSELVES"
returns:
---
diff --git a/docs/classes/Player/SetHands.md b/docs/classes/Player/SetHands.md
index 7cfd4c27d0..e64486a688 100644
--- a/docs/classes/Player/SetHands.md
+++ b/docs/classes/Player/SetHands.md
@@ -14,8 +14,12 @@ lua:
description: "Set the player's hands."
arguments:
- - name: "hands"
- type: Entity
+ - position: 1
+ name: "player"
+ type: Player
+ - position: 2
+ name: "hands"
+ type: Entity
returns:
---
diff --git a/docs/classes/Player/SetJumpPower.md b/docs/classes/Player/SetJumpPower.md
new file mode 100644
index 0000000000..79245357e1
--- /dev/null
+++ b/docs/classes/Player/SetJumpPower.md
@@ -0,0 +1,29 @@
+---
+template: lua-class-function.html
+title: SetJumpPower
+icon: lua-shared
+tags:
+ - lua
+ - shared
+ - needs-verification
+ - needs-example
+lua:
+ library: Player
+ function: SetJumpPower
+ realm: shared
+ description: "Set the player's jump power. Is multiplied by jumpFactor of the surface the player is standing on. Supposedly (according to a Valve comment inside the SDK) 160 power equals about 21 units jump height."
+
+ arguments:
+ - position: 1
+ name: "player"
+ type: Player
+ - position: 2
+ name: "power"
+ type: number
+ returns:
+
+---
+
+
+Player:SetJumpPower – Set the player's jump power. Is multiplied by jumpFactor of the surface the player is standing on. Supposedly (according to a Valve comment inside the SDK) 160 power equals about 21 units jump height.
+
diff --git a/docs/classes/Player/SetLadderClimbSpeed.md b/docs/classes/Player/SetLadderClimbSpeed.md
new file mode 100644
index 0000000000..709e0b5326
--- /dev/null
+++ b/docs/classes/Player/SetLadderClimbSpeed.md
@@ -0,0 +1,29 @@
+---
+template: lua-class-function.html
+title: SetLadderClimbSpeed
+icon: lua-shared
+tags:
+ - lua
+ - shared
+ - needs-verification
+ - needs-example
+lua:
+ library: Player
+ function: SetLadderClimbSpeed
+ realm: shared
+ description: "Set the player's ladder climb speed."
+
+ arguments:
+ - position: 1
+ name: "player"
+ type: Player
+ - position: 2
+ name: "speed"
+ type: number
+ returns:
+
+---
+
+
+Player:SetLadderClimbSpeed – Set the player's ladder climb speed.
+
diff --git a/docs/classes/Player/SetLadderNormal.md b/docs/classes/Player/SetLadderNormal.md
index 4cb9cf3cc5..b2db6eafeb 100644
--- a/docs/classes/Player/SetLadderNormal.md
+++ b/docs/classes/Player/SetLadderNormal.md
@@ -14,8 +14,12 @@ lua:
description: "Set the player's ladder normal."
arguments:
- - name: "normal"
- type: Vector
+ - position: 1
+ name: "player"
+ type: Player
+ - position: 2
+ name: "normal"
+ type: Vector
returns:
---
diff --git a/docs/classes/Player/SetLagCompensated.md b/docs/classes/Player/SetLagCompensated.md
index e3d4d42528..bdbca5f6dd 100644
--- a/docs/classes/Player/SetLagCompensated.md
+++ b/docs/classes/Player/SetLagCompensated.md
@@ -14,8 +14,12 @@ lua:
description: "Set the player's lag compensation."
arguments:
- - name: "lagCompensation"
- type: boolean
+ - position: 1
+ name: "player"
+ type: Player
+ - position: 2
+ name: "lagCompensation"
+ type: boolean
returns:
---
diff --git a/docs/classes/Player/SetLastWeapon.md b/docs/classes/Player/SetLastWeapon.md
index 52b80dd67c..0e46fd8965 100644
--- a/docs/classes/Player/SetLastWeapon.md
+++ b/docs/classes/Player/SetLastWeapon.md
@@ -14,8 +14,12 @@ lua:
description: "Set the player's last weapon."
arguments:
- - name: "weapon"
- type: Weapon
+ - position: 1
+ name: "player"
+ type: Player
+ - position: 2
+ name: "weapon"
+ type: Weapon
returns:
---
diff --git a/docs/classes/Player/SetMaxSpeed.md b/docs/classes/Player/SetMaxSpeed.md
index 611f88f19c..f2eb5d4334 100644
--- a/docs/classes/Player/SetMaxSpeed.md
+++ b/docs/classes/Player/SetMaxSpeed.md
@@ -14,8 +14,12 @@ lua:
description: "Set the player's current max speed."
arguments:
- - name: "speed"
- type: number
+ - position: 1
+ name: "player"
+ type: Player
+ - position: 2
+ name: "speed"
+ type: number
returns:
---
diff --git a/docs/classes/Player/SetNextAttack.md b/docs/classes/Player/SetNextAttack.md
index 0013ce85ea..f4222bcbbf 100644
--- a/docs/classes/Player/SetNextAttack.md
+++ b/docs/classes/Player/SetNextAttack.md
@@ -14,8 +14,12 @@ lua:
description: "Set the player's next attack."
arguments:
- - name: "time"
- type: number
+ - position: 1
+ name: "player"
+ type: Player
+ - position: 2
+ name: "time"
+ type: number
returns:
---
diff --git a/docs/classes/Player/SetNormalSpeed.md b/docs/classes/Player/SetNormalSpeed.md
index 5ebe238cfc..568013a2fe 100644
--- a/docs/classes/Player/SetNormalSpeed.md
+++ b/docs/classes/Player/SetNormalSpeed.md
@@ -14,8 +14,12 @@ lua:
description: "Set the player's normal speed (for when neither sprinting, walking nor crouching)"
arguments:
- - name: "speed"
- type: number
+ - position: 1
+ name: "player"
+ type: Player
+ - position: 2
+ name: "speed"
+ type: number
returns:
---
diff --git a/docs/classes/Player/SetObserverMode.md b/docs/classes/Player/SetObserverMode.md
index 72abb73689..98d464512b 100644
--- a/docs/classes/Player/SetObserverMode.md
+++ b/docs/classes/Player/SetObserverMode.md
@@ -14,8 +14,12 @@ lua:
description: "Set the observer mode for the player."
arguments:
- - name: "mode"
- type: enumeration/OBSERVER_MODE
+ - position: 1
+ name: "player"
+ type: Player
+ - position: 2
+ name: "mode"
+ type: enumeration/OBSERVER_MODE
returns:
---
diff --git a/docs/classes/Player/SetObserverTarget.md b/docs/classes/Player/SetObserverTarget.md
index 172cbcc8d9..bd2f2df412 100644
--- a/docs/classes/Player/SetObserverTarget.md
+++ b/docs/classes/Player/SetObserverTarget.md
@@ -14,8 +14,12 @@ lua:
description: "Set the observer target for the player."
arguments:
- - name: "target"
- type: Entity
+ - position: 1
+ name: "player"
+ type: Player
+ - position: 2
+ name: "target"
+ type: Entity
returns:
---
diff --git a/docs/classes/Player/SetPlayerLocalData.md b/docs/classes/Player/SetPlayerLocalData.md
index 91317a58be..bb012c6175 100644
--- a/docs/classes/Player/SetPlayerLocalData.md
+++ b/docs/classes/Player/SetPlayerLocalData.md
@@ -13,67 +13,53 @@ lua:
realm: shared
description: "Set the player's local data."
- argumentSets:
- - arguments:
- - name: "field"
- type: string
+ arguments:
+ - position: 1
+ name: "player"
+ type: Player
+ - position: 2
+ name: "field"
+ type: string
+ - position: 3
+ types:
- name: "value"
type: number
- - arguments:
- name: "value"
type: number
- - arguments:
- name: "value"
type: boolean
- - arguments:
- name: "value"
type: boolean
- - arguments:
- name: "value"
type: boolean
- - arguments:
- name: "value"
type: number
- - arguments:
- name: "value"
type: number
- - arguments:
- name: "value"
type: number
- - arguments:
- name: "value"
type: number
- - arguments:
- name: "value"
type: number
- - arguments:
- name: "value"
type: number
- - arguments:
- name: "value"
type: Vector
- - arguments:
- name: "value"
type: Angle
- - arguments:
- name: "value"
type: Angle
- - arguments:
- name: "value"
type: boolean
- - arguments:
- name: "value"
type: boolean
- - arguments:
- name: "value"
type: boolean
- - arguments:
- name: "value"
type: number
- - arguments:
- name: "value"
type: boolean
- - arguments:
- name: "value"
type: boolean
returns:
diff --git a/docs/classes/Player/SetPlayerName.md b/docs/classes/Player/SetPlayerName.md
index 959be4b315..9126954090 100644
--- a/docs/classes/Player/SetPlayerName.md
+++ b/docs/classes/Player/SetPlayerName.md
@@ -14,8 +14,12 @@ lua:
description: "Set the name of the player."
arguments:
- - name: "name"
- type: string
+ - position: 1
+ name: "player"
+ type: Player
+ - position: 2
+ name: "name"
+ type: string
returns:
---
diff --git a/docs/classes/Player/SetPlayerUnderwater.md b/docs/classes/Player/SetPlayerUnderwater.md
index c6a0295bd0..ecb4e155f7 100644
--- a/docs/classes/Player/SetPlayerUnderwater.md
+++ b/docs/classes/Player/SetPlayerUnderwater.md
@@ -14,8 +14,12 @@ lua:
description: "Set whether the player is underwater."
arguments:
- - name: "underwater"
- type: boolean
+ - position: 1
+ name: "player"
+ type: Player
+ - position: 2
+ name: "underwater"
+ type: boolean
returns:
---
diff --git a/docs/classes/Player/SetPreviouslyPredictedOrigin.md b/docs/classes/Player/SetPreviouslyPredictedOrigin.md
index 0f8b65fd13..1bd7ecbf5a 100644
--- a/docs/classes/Player/SetPreviouslyPredictedOrigin.md
+++ b/docs/classes/Player/SetPreviouslyPredictedOrigin.md
@@ -14,8 +14,12 @@ lua:
description: "Set the player's previously predicted origin."
arguments:
- - name: "origin"
- type: Vector
+ - position: 1
+ name: "player"
+ type: Player
+ - position: 2
+ name: "origin"
+ type: Vector
returns:
---
diff --git a/docs/classes/Player/SetPunchAngle.md b/docs/classes/Player/SetPunchAngle.md
index 93ee19cd2b..537ab9d9c7 100644
--- a/docs/classes/Player/SetPunchAngle.md
+++ b/docs/classes/Player/SetPunchAngle.md
@@ -14,8 +14,12 @@ lua:
description: "Set the player's punch angle."
arguments:
- - name: "angle"
- type: Angle
+ - position: 1
+ name: "player"
+ type: Player
+ - position: 2
+ name: "angle"
+ type: Angle
returns:
---
diff --git a/docs/classes/Player/SetRunSpeed.md b/docs/classes/Player/SetRunSpeed.md
index 2cc5fb3151..1d50b0e9df 100644
--- a/docs/classes/Player/SetRunSpeed.md
+++ b/docs/classes/Player/SetRunSpeed.md
@@ -14,8 +14,12 @@ lua:
description: "Set the player's sprint speed."
arguments:
- - name: "speed"
- type: number
+ - position: 1
+ name: "player"
+ type: Player
+ - position: 2
+ name: "speed"
+ type: number
returns:
---
diff --git a/docs/classes/Player/SetStepSoundCache.md b/docs/classes/Player/SetStepSoundCache.md
index 9e92befd6a..16e8276d61 100644
--- a/docs/classes/Player/SetStepSoundCache.md
+++ b/docs/classes/Player/SetStepSoundCache.md
@@ -14,10 +14,15 @@ lua:
description: "Set the player's step sound cache."
arguments:
- - name: "index"
- type: number
- - name: "field"
- type: string
+ - position: 1
+ name: "player"
+ type: Player
+ - position: 2
+ name: "index"
+ type: number
+ - position: 3
+ name: "field"
+ type: string
returns:
---
diff --git a/docs/classes/Player/SetSuitUpdate.md b/docs/classes/Player/SetSuitUpdate.md
index af66481629..20593d345b 100644
--- a/docs/classes/Player/SetSuitUpdate.md
+++ b/docs/classes/Player/SetSuitUpdate.md
@@ -14,12 +14,18 @@ lua:
description: "Set the player's suit update."
arguments:
- - name: "name"
- type: string
- - name: "group"
- type: number
- - name: "repeat"
- type: number
+ - position: 1
+ name: "player"
+ type: Player
+ - position: 2
+ name: "name"
+ type: string
+ - position: 3
+ name: "group"
+ type: number
+ - position: 4
+ name: "repeat"
+ type: number
returns:
---
diff --git a/docs/classes/Player/SetSwimSoundTime.md b/docs/classes/Player/SetSwimSoundTime.md
index 1795b21b0c..b1f107d421 100644
--- a/docs/classes/Player/SetSwimSoundTime.md
+++ b/docs/classes/Player/SetSwimSoundTime.md
@@ -14,8 +14,12 @@ lua:
description: "Set the player's swim sound time."
arguments:
- - name: "time"
- type: number
+ - position: 1
+ name: "player"
+ type: Player
+ - position: 2
+ name: "time"
+ type: number
returns:
---
diff --git a/docs/classes/Player/SetTeam.md b/docs/classes/Player/SetTeam.md
index c6a4519d61..0e284801c9 100644
--- a/docs/classes/Player/SetTeam.md
+++ b/docs/classes/Player/SetTeam.md
@@ -14,8 +14,12 @@ lua:
description: "Change the team for the player."
arguments:
- - name: "team"
- type: number
+ - position: 1
+ name: "player"
+ type: Player
+ - position: 2
+ name: "team"
+ type: number
returns:
---
diff --git a/docs/classes/Player/SetUnDuckFraction.md b/docs/classes/Player/SetUnDuckFraction.md
new file mode 100644
index 0000000000..218fd7a87c
--- /dev/null
+++ b/docs/classes/Player/SetUnDuckFraction.md
@@ -0,0 +1,29 @@
+---
+template: lua-class-function.html
+title: SetUnDuckFraction
+icon: lua-shared
+tags:
+ - lua
+ - shared
+ - needs-verification
+ - needs-example
+lua:
+ library: Player
+ function: SetUnDuckFraction
+ realm: shared
+ description: "Set the player's unduck fraction. If it's 0.5 then unducking will take half the time it takes to duck."
+
+ arguments:
+ - position: 1
+ name: "player"
+ type: Player
+ - position: 2
+ name: "fraction"
+ type: number
+ returns:
+
+---
+
+
+Player:SetUnDuckFraction – Set the player's unduck fraction. If it's 0.5 then unducking will take half the time it takes to duck.
+
diff --git a/docs/classes/Player/SetVehicleAnalogControlBias.md b/docs/classes/Player/SetVehicleAnalogControlBias.md
index 5151081543..060cf0ac27 100644
--- a/docs/classes/Player/SetVehicleAnalogControlBias.md
+++ b/docs/classes/Player/SetVehicleAnalogControlBias.md
@@ -14,8 +14,12 @@ lua:
description: "Set the vehicle analog control bias for the player."
arguments:
- - name: "bias"
- type: number
+ - position: 1
+ name: "player"
+ type: Player
+ - position: 2
+ name: "bias"
+ type: number
returns:
---
diff --git a/docs/classes/Player/SetViewPunchAngles.md b/docs/classes/Player/SetViewPunchAngles.md
index 31840ed0d9..9e391b248b 100644
--- a/docs/classes/Player/SetViewPunchAngles.md
+++ b/docs/classes/Player/SetViewPunchAngles.md
@@ -14,8 +14,12 @@ lua:
description: "Set the player's view punch angle."
arguments:
- - name: "angle"
- type: Angle
+ - position: 1
+ name: "player"
+ type: Player
+ - position: 2
+ name: "angle"
+ type: Angle
returns:
---
diff --git a/docs/classes/Player/SetWalkSpeed.md b/docs/classes/Player/SetWalkSpeed.md
index 3f7c6719d0..4f722d2010 100644
--- a/docs/classes/Player/SetWalkSpeed.md
+++ b/docs/classes/Player/SetWalkSpeed.md
@@ -14,8 +14,12 @@ lua:
description: "Set the player's walking speed (for when they press ALT)."
arguments:
- - name: "speed"
- type: number
+ - position: 1
+ name: "player"
+ type: Player
+ - position: 2
+ name: "speed"
+ type: number
returns:
---
diff --git a/docs/classes/Player/SetWaterJumpTime.md b/docs/classes/Player/SetWaterJumpTime.md
index 4e524a7dae..87b0322eb0 100644
--- a/docs/classes/Player/SetWaterJumpTime.md
+++ b/docs/classes/Player/SetWaterJumpTime.md
@@ -14,8 +14,12 @@ lua:
description: "Set the player's water jump time."
arguments:
- - name: "time"
- type: number
+ - position: 1
+ name: "player"
+ type: Player
+ - position: 2
+ name: "time"
+ type: number
returns:
---
diff --git a/docs/classes/Player/SharedSpawn.md b/docs/classes/Player/SharedSpawn.md
index 5d523f8cf2..08356dcd0d 100644
--- a/docs/classes/Player/SharedSpawn.md
+++ b/docs/classes/Player/SharedSpawn.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Shared spawn."
-
+ arguments:
+ - position: 1
+ name: "player"
+ type: Player
returns:
---
diff --git a/docs/classes/Player/ShouldDrawLocalPlayer.md b/docs/classes/Player/ShouldDrawLocalPlayer.md
index ba6e38dd72..b768b9cead 100644
--- a/docs/classes/Player/ShouldDrawLocalPlayer.md
+++ b/docs/classes/Player/ShouldDrawLocalPlayer.md
@@ -13,7 +13,10 @@ lua:
realm: client
description: "Whether the player's player model will be drawn."
-
+ arguments:
+ - position: 1
+ name: "player"
+ type: Player
returns:
- type: boolean
description: "True if the player's player model will be drawn."
diff --git a/docs/classes/Player/ShouldFadeOnDeath.md b/docs/classes/Player/ShouldFadeOnDeath.md
index b9853aafec..598f0d1c96 100644
--- a/docs/classes/Player/ShouldFadeOnDeath.md
+++ b/docs/classes/Player/ShouldFadeOnDeath.md
@@ -13,7 +13,10 @@ lua:
realm: server
description: "Check if the player should fade on death."
-
+ arguments:
+ - position: 1
+ name: "player"
+ type: Player
returns:
- type: boolean
description: "Whether the player should fade on death."
diff --git a/docs/classes/Player/ShouldSelectWeapon.md b/docs/classes/Player/ShouldSelectWeapon.md
index b8ec88013e..7016321e9f 100644
--- a/docs/classes/Player/ShouldSelectWeapon.md
+++ b/docs/classes/Player/ShouldSelectWeapon.md
@@ -13,7 +13,13 @@ lua:
realm: shared
description: "Check if the player should select a weapon."
-
+ arguments:
+ - position: 1
+ name: "player"
+ type: Player
+ - position: 2
+ name: "weapon"
+ type: Weapon
returns:
- type: boolean
description: "Whether the player should select the weapon."
diff --git a/docs/classes/Player/ShouldSetLastWeapon.md b/docs/classes/Player/ShouldSetLastWeapon.md
index 6cd5ca4276..0e977ca27d 100644
--- a/docs/classes/Player/ShouldSetLastWeapon.md
+++ b/docs/classes/Player/ShouldSetLastWeapon.md
@@ -14,10 +14,15 @@ lua:
description: "Check if the player should set the last weapon."
arguments:
- - name: "weapon"
- type: Weapon
- - name: "last"
- type: Weapon
+ - position: 1
+ name: "player"
+ type: Player
+ - position: 2
+ name: "weapon"
+ type: Weapon
+ - position: 3
+ name: "last"
+ type: Weapon
returns:
- type: boolean
description: "Whether the player should set the last weapon."
diff --git a/docs/classes/Player/ShouldShowHints.md b/docs/classes/Player/ShouldShowHints.md
index eb6860395b..a1956e066d 100644
--- a/docs/classes/Player/ShouldShowHints.md
+++ b/docs/classes/Player/ShouldShowHints.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Should show hints."
-
+ arguments:
+ - position: 1
+ name: "player"
+ type: Player
returns:
---
diff --git a/docs/classes/Player/ShowCrosshair.md b/docs/classes/Player/ShowCrosshair.md
index 1740bfa28e..8c1e29a22d 100644
--- a/docs/classes/Player/ShowCrosshair.md
+++ b/docs/classes/Player/ShowCrosshair.md
@@ -14,8 +14,12 @@ lua:
description: "Show or hide the crosshair for the player."
arguments:
- - name: "shouldShow"
- type: boolean
+ - position: 1
+ name: "player"
+ type: Player
+ - position: 2
+ name: "shouldShow"
+ type: boolean
returns:
---
diff --git a/docs/classes/Player/ShowMessage.md b/docs/classes/Player/ShowMessage.md
index b748d16c58..d44dc38711 100644
--- a/docs/classes/Player/ShowMessage.md
+++ b/docs/classes/Player/ShowMessage.md
@@ -14,8 +14,12 @@ lua:
description: "Show a message to the player."
arguments:
- - name: "message"
- type: string
+ - position: 1
+ name: "player"
+ type: Player
+ - position: 2
+ name: "message"
+ type: string
returns:
---
diff --git a/docs/classes/Player/ShowViewModel.md b/docs/classes/Player/ShowViewModel.md
index add843302b..628729f608 100644
--- a/docs/classes/Player/ShowViewModel.md
+++ b/docs/classes/Player/ShowViewModel.md
@@ -14,8 +14,12 @@ lua:
description: "Show or hide the view model for the player."
arguments:
- - name: "shouldShow"
- type: boolean
+ - position: 1
+ name: "player"
+ type: Player
+ - position: 2
+ name: "shouldShow"
+ type: boolean
returns:
---
diff --git a/docs/classes/Player/SimulatePlayerSimulatedEntities.md b/docs/classes/Player/SimulatePlayerSimulatedEntities.md
index 94db81d8e3..e339ded72f 100644
--- a/docs/classes/Player/SimulatePlayerSimulatedEntities.md
+++ b/docs/classes/Player/SimulatePlayerSimulatedEntities.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Simulate player simulated entities."
-
+ arguments:
+ - position: 1
+ name: "player"
+ type: Player
returns:
---
diff --git a/docs/classes/Player/SmoothViewOnStairs.md b/docs/classes/Player/SmoothViewOnStairs.md
index 449279105d..870da382c5 100644
--- a/docs/classes/Player/SmoothViewOnStairs.md
+++ b/docs/classes/Player/SmoothViewOnStairs.md
@@ -14,8 +14,12 @@ lua:
description: "Smooth view on stairs."
arguments:
- - name: "normal"
- type: Vector
+ - position: 1
+ name: "player"
+ type: Player
+ - position: 2
+ name: "normal"
+ type: Vector
returns:
---
diff --git a/docs/classes/Player/SnapEyeAngles.md b/docs/classes/Player/SnapEyeAngles.md
index cf7843e549..81e38ba503 100644
--- a/docs/classes/Player/SnapEyeAngles.md
+++ b/docs/classes/Player/SnapEyeAngles.md
@@ -14,8 +14,12 @@ lua:
description: "Snap the eye angles of the player."
arguments:
- - name: "angles"
- type: Angle
+ - position: 1
+ name: "player"
+ type: Player
+ - position: 2
+ name: "angles"
+ type: Angle
returns:
---
diff --git a/docs/classes/Player/SprayDecal.md b/docs/classes/Player/SprayDecal.md
index d0066d5d24..fa898d45d9 100644
--- a/docs/classes/Player/SprayDecal.md
+++ b/docs/classes/Player/SprayDecal.md
@@ -14,10 +14,15 @@ lua:
description: "Spray a decal for the player based on a trace with start and end."
arguments:
- - name: "traceStart"
- type: Vector
- - name: "traceEnd"
- type: Vector
+ - position: 1
+ name: "player"
+ type: Player
+ - position: 2
+ name: "traceStart"
+ type: Vector
+ - position: 3
+ name: "traceEnd"
+ type: Vector
returns:
---
diff --git a/docs/classes/Player/StartLagCompensation.md b/docs/classes/Player/StartLagCompensation.md
index 89a71ef3f4..256f15e1e0 100644
--- a/docs/classes/Player/StartLagCompensation.md
+++ b/docs/classes/Player/StartLagCompensation.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Set the player's lag compensation. On the client this does nothing."
-
+ arguments:
+ - position: 1
+ name: "player"
+ type: Player
returns:
---
diff --git a/docs/classes/Player/StartObserverMode.md b/docs/classes/Player/StartObserverMode.md
index 3c91b3d6ad..01a4671a3b 100644
--- a/docs/classes/Player/StartObserverMode.md
+++ b/docs/classes/Player/StartObserverMode.md
@@ -14,8 +14,12 @@ lua:
description: "Start the observer mode for the player."
arguments:
- - name: "mode"
- type: enumeration/OBSERVER_MODE
+ - position: 1
+ name: "player"
+ type: Player
+ - position: 2
+ name: "mode"
+ type: enumeration/OBSERVER_MODE
returns:
- type: boolean
description: "Whether the observer mode was started."
diff --git a/docs/classes/Player/StartReplayMode.md b/docs/classes/Player/StartReplayMode.md
index ee8b800351..0edc78661e 100644
--- a/docs/classes/Player/StartReplayMode.md
+++ b/docs/classes/Player/StartReplayMode.md
@@ -14,8 +14,18 @@ lua:
description: "Start the replay mode for the player."
arguments:
- - name: "delay"
- type: number
+ - position: 1
+ name: "player"
+ type: Player
+ - position: 2
+ name: "delay"
+ type: number
+ - position: 3
+ name: "duration"
+ type: number
+ - position: 4
+ name: "entityIndex"
+ type: number
returns:
- type: boolean
description: "Whether the replay mode was started."
diff --git a/docs/classes/Player/StopObserverMode.md b/docs/classes/Player/StopObserverMode.md
index 1fa8b0d2c1..0b40814a9f 100644
--- a/docs/classes/Player/StopObserverMode.md
+++ b/docs/classes/Player/StopObserverMode.md
@@ -13,7 +13,10 @@ lua:
realm: server
description: "Stop the observer mode for the player."
-
+ arguments:
+ - position: 1
+ name: "player"
+ type: Player
returns:
---
diff --git a/docs/classes/Player/StopReplayMode.md b/docs/classes/Player/StopReplayMode.md
index 11d609f97b..304511b2f8 100644
--- a/docs/classes/Player/StopReplayMode.md
+++ b/docs/classes/Player/StopReplayMode.md
@@ -13,7 +13,10 @@ lua:
realm: server
description: "Stop the replay mode for the player."
-
+ arguments:
+ - position: 1
+ name: "player"
+ type: Player
returns:
---
diff --git a/docs/classes/Player/SwitchToNextBestWeapon.md b/docs/classes/Player/SwitchToNextBestWeapon.md
index 1581630d31..fd74c2ab6b 100644
--- a/docs/classes/Player/SwitchToNextBestWeapon.md
+++ b/docs/classes/Player/SwitchToNextBestWeapon.md
@@ -13,7 +13,13 @@ lua:
realm: shared
description: "Switch to the player's next best weapon."
-
+ arguments:
+ - position: 1
+ name: "player"
+ type: Player
+ - position: 2
+ name: "weapon"
+ type: Weapon
returns:
---
diff --git a/docs/classes/Player/SwitchWeapon.md b/docs/classes/Player/SwitchWeapon.md
index 7c339d304b..9f8eb1885a 100644
--- a/docs/classes/Player/SwitchWeapon.md
+++ b/docs/classes/Player/SwitchWeapon.md
@@ -14,11 +14,16 @@ lua:
description: "Switch the player's weapon."
arguments:
- - name: "weapon"
- type: Weapon
- - name: "subType"
- type: number
- default: "0"
+ - position: 1
+ name: "player"
+ type: Player
+ - position: 2
+ name: "weapon"
+ type: Weapon
+ - position: 3
+ name: "subType"
+ type: number
+ default: "0"
returns:
- type: boolean
description: "Whether the weapon was switched."
diff --git a/docs/classes/Player/TranslateWeaponActivity.md b/docs/classes/Player/TranslateWeaponActivity.md
index 356e42a656..6a8ad6d0ea 100644
--- a/docs/classes/Player/TranslateWeaponActivity.md
+++ b/docs/classes/Player/TranslateWeaponActivity.md
@@ -14,8 +14,12 @@ lua:
description: "Translate a weapon activity."
arguments:
- - name: "activity"
- type: enumeration/ACTIVITY
+ - position: 1
+ name: "player"
+ type: Player
+ - position: 2
+ name: "activity"
+ type: enumeration/ACTIVITY
returns:
- type: enumeration/ACTIVITY
description: "The translated activity."
diff --git a/docs/classes/Player/TurnFlashlightOff.md b/docs/classes/Player/TurnFlashlightOff.md
index c95bee87a8..e4c5ca6472 100644
--- a/docs/classes/Player/TurnFlashlightOff.md
+++ b/docs/classes/Player/TurnFlashlightOff.md
@@ -13,7 +13,10 @@ lua:
realm: server
description: "Turn the flashlight off for the player."
-
+ arguments:
+ - position: 1
+ name: "player"
+ type: Player
returns:
---
diff --git a/docs/classes/Player/TurnFlashlightOn.md b/docs/classes/Player/TurnFlashlightOn.md
index 6855a400ba..76d4de1307 100644
--- a/docs/classes/Player/TurnFlashlightOn.md
+++ b/docs/classes/Player/TurnFlashlightOn.md
@@ -13,7 +13,10 @@ lua:
realm: server
description: "Turn the flashlight on for the player."
-
+ arguments:
+ - position: 1
+ name: "player"
+ type: Player
returns:
---
diff --git a/docs/classes/Player/UnlockPlayer.md b/docs/classes/Player/Unlock.md
similarity index 51%
rename from docs/classes/Player/UnlockPlayer.md
rename to docs/classes/Player/Unlock.md
index 514b8084f9..8fc0fc93dc 100644
--- a/docs/classes/Player/UnlockPlayer.md
+++ b/docs/classes/Player/Unlock.md
@@ -1,6 +1,6 @@
---
template: lua-class-function.html
-title: UnlockPlayer
+title: Unlock
icon: lua-server
tags:
- lua
@@ -9,15 +9,18 @@ tags:
- needs-example
lua:
library: Player
- function: UnlockPlayer
+ function: Unlock
realm: server
- description: "Unlock the player."
-
+ description: "Unlock the player from their place."
+ arguments:
+ - position: 1
+ name: "player"
+ type: Player
returns:
---
-Player:UnlockPlayer – Unlock the player.
+Player:Unlock – Unlock the player from their place.
diff --git a/docs/classes/Player/UpdateClientData.md b/docs/classes/Player/UpdateClientData.md
index 326203f0f0..2c10f3d470 100644
--- a/docs/classes/Player/UpdateClientData.md
+++ b/docs/classes/Player/UpdateClientData.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Update the player's client data."
-
+ arguments:
+ - position: 1
+ name: "player"
+ type: Player
returns:
---
diff --git a/docs/classes/Player/UpdatePlayerSound.md b/docs/classes/Player/UpdatePlayerSound.md
index c13a8dfe9c..fabe2424e9 100644
--- a/docs/classes/Player/UpdatePlayerSound.md
+++ b/docs/classes/Player/UpdatePlayerSound.md
@@ -13,7 +13,10 @@ lua:
realm: server
description: "Update the player sound."
-
+ arguments:
+ - position: 1
+ name: "player"
+ type: Player
returns:
---
diff --git a/docs/classes/Player/UpdateUnderwaterState.md b/docs/classes/Player/UpdateUnderwaterState.md
index efd6faf27d..d05777acb5 100644
--- a/docs/classes/Player/UpdateUnderwaterState.md
+++ b/docs/classes/Player/UpdateUnderwaterState.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Update the player's underwater state."
-
+ arguments:
+ - position: 1
+ name: "player"
+ type: Player
returns:
---
diff --git a/docs/classes/Player/UsingStandardWeaponsInVehicle.md b/docs/classes/Player/UsingStandardWeaponsInVehicle.md
index f197f79620..8a47a213c7 100644
--- a/docs/classes/Player/UsingStandardWeaponsInVehicle.md
+++ b/docs/classes/Player/UsingStandardWeaponsInVehicle.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Check if the player is using standard weapons in a vehicle."
-
+ arguments:
+ - position: 1
+ name: "player"
+ type: Player
returns:
---
diff --git a/docs/classes/Player/ValidateCurrentObserverTarget.md b/docs/classes/Player/ValidateCurrentObserverTarget.md
index 99319a7d8d..8fc7212932 100644
--- a/docs/classes/Player/ValidateCurrentObserverTarget.md
+++ b/docs/classes/Player/ValidateCurrentObserverTarget.md
@@ -13,7 +13,10 @@ lua:
realm: server
description: "Validate the current observer target for the player."
-
+ arguments:
+ - position: 1
+ name: "player"
+ type: Player
returns:
---
diff --git a/docs/classes/Player/ViewPunch.md b/docs/classes/Player/ViewPunch.md
index 1c6fa28e64..2947037b1a 100644
--- a/docs/classes/Player/ViewPunch.md
+++ b/docs/classes/Player/ViewPunch.md
@@ -14,8 +14,12 @@ lua:
description: "View punch."
arguments:
- - name: "angle"
- type: Angle
+ - position: 1
+ name: "player"
+ type: Player
+ - position: 2
+ name: "angle"
+ type: Angle
returns:
---
diff --git a/docs/classes/Player/ViewPunchReset.md b/docs/classes/Player/ViewPunchReset.md
index d6f70ef206..fc811db059 100644
--- a/docs/classes/Player/ViewPunchReset.md
+++ b/docs/classes/Player/ViewPunchReset.md
@@ -14,9 +14,13 @@ lua:
description: "View punch reset."
arguments:
- - name: "time"
- type: number
- default: "0"
+ - position: 1
+ name: "player"
+ type: Player
+ - position: 2
+ name: "time"
+ type: number
+ default: "0"
returns:
---
diff --git a/docs/classes/Player/WasKeyDown.md b/docs/classes/Player/WasKeyDown.md
index 7c9822dc78..251715c220 100644
--- a/docs/classes/Player/WasKeyDown.md
+++ b/docs/classes/Player/WasKeyDown.md
@@ -14,8 +14,12 @@ lua:
description: "Get if the specified key was down one tick before the current."
arguments:
- - name: "keys"
- type: number
+ - position: 1
+ name: "player"
+ type: Player
+ - position: 2
+ name: "keys"
+ type: number
returns:
- type: boolean
description: "Whether the key was down."
diff --git a/docs/classes/Player/WasKeyPressed.md b/docs/classes/Player/WasKeyPressed.md
index 1095e0115d..4f14ade4eb 100644
--- a/docs/classes/Player/WasKeyPressed.md
+++ b/docs/classes/Player/WasKeyPressed.md
@@ -14,8 +14,12 @@ lua:
description: "Check if a key was pressed."
arguments:
- - name: "keys"
- type: number
+ - position: 1
+ name: "player"
+ type: Player
+ - position: 2
+ name: "keys"
+ type: number
returns:
- type: boolean
description: "Whether the key was pressed."
diff --git a/docs/classes/Player/WasKeyReleased.md b/docs/classes/Player/WasKeyReleased.md
index 92603c9920..afb318c0fb 100644
--- a/docs/classes/Player/WasKeyReleased.md
+++ b/docs/classes/Player/WasKeyReleased.md
@@ -14,8 +14,12 @@ lua:
description: "Check if a key was released."
arguments:
- - name: "keys"
- type: number
+ - position: 1
+ name: "player"
+ type: Player
+ - position: 2
+ name: "keys"
+ type: number
returns:
- type: boolean
description: "Whether the key was released."
diff --git a/docs/classes/Player/WeaponCount.md b/docs/classes/Player/WeaponCount.md
index 5761031547..9441d8704d 100644
--- a/docs/classes/Player/WeaponCount.md
+++ b/docs/classes/Player/WeaponCount.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Get the player's weapon count."
-
+ arguments:
+ - position: 1
+ name: "player"
+ type: Player
returns:
- type: integer
description: "The player's weapon count."
diff --git a/docs/classes/Player/__eq.md b/docs/classes/Player/__eq.md
deleted file mode 100644
index 7b12693830..0000000000
--- a/docs/classes/Player/__eq.md
+++ /dev/null
@@ -1,24 +0,0 @@
----
-template: lua-class-function.html
-title: __eq
-icon: lua-shared
-tags:
- - lua
- - shared
- - needs-verification
- - needs-example
-lua:
- library: Player
- function: __eq
- realm: shared
- description: "Check if two players are equal."
-
-
- returns:
- - type: boolean
- description: "Whether the players are equal."
----
-
-
-Player:__eq – Check if two players are equal.
-
diff --git a/docs/classes/Player/__tostring.md b/docs/classes/Player/__tostring.md
deleted file mode 100644
index 83c06f4050..0000000000
--- a/docs/classes/Player/__tostring.md
+++ /dev/null
@@ -1,24 +0,0 @@
----
-template: lua-class-function.html
-title: __tostring
-icon: lua-shared
-tags:
- - lua
- - shared
- - needs-verification
- - needs-example
-lua:
- library: Player
- function: __tostring
- realm: shared
- description: "Get the string representation of a player."
-
-
- returns:
- - type: string
- description: "The string representation of the player."
----
-
-
-Player:__tostring – Get the string representation of a player.
-
diff --git a/docs/classes/ProjectedTexture/GetAngles.md b/docs/classes/ProjectedTexture/GetAngles.md
index cd9f40f104..9278cf6ae5 100644
--- a/docs/classes/ProjectedTexture/GetAngles.md
+++ b/docs/classes/ProjectedTexture/GetAngles.md
@@ -13,7 +13,10 @@ lua:
realm: client
description: "Get the angle of the projected texture."
-
+ arguments:
+ - position: 1
+ name: "projectedTexture"
+ type: ProjectedTexture
returns:
- type: Angle
description: "The angle of the projected texture."
diff --git a/docs/classes/ProjectedTexture/GetBrightness.md b/docs/classes/ProjectedTexture/GetBrightness.md
index b5f546b9e5..e6b23269a6 100644
--- a/docs/classes/ProjectedTexture/GetBrightness.md
+++ b/docs/classes/ProjectedTexture/GetBrightness.md
@@ -13,7 +13,10 @@ lua:
realm: client
description: "Get the brightness of the projected texture."
-
+ arguments:
+ - position: 1
+ name: "projectedTexture"
+ type: ProjectedTexture
returns:
- type: number
description: "The brightness of the projected texture."
diff --git a/docs/classes/ProjectedTexture/GetColor.md b/docs/classes/ProjectedTexture/GetColor.md
index 2dd5bc36b2..eb2be4b174 100644
--- a/docs/classes/ProjectedTexture/GetColor.md
+++ b/docs/classes/ProjectedTexture/GetColor.md
@@ -13,7 +13,10 @@ lua:
realm: client
description: "Get the color of the projected texture."
-
+ arguments:
+ - position: 1
+ name: "projectedTexture"
+ type: ProjectedTexture
returns:
- type: Color
description: "The color of the projected texture."
diff --git a/docs/classes/ProjectedTexture/GetConstantAttenuation.md b/docs/classes/ProjectedTexture/GetConstantAttenuation.md
index 552c2bda39..03ef428c48 100644
--- a/docs/classes/ProjectedTexture/GetConstantAttenuation.md
+++ b/docs/classes/ProjectedTexture/GetConstantAttenuation.md
@@ -13,7 +13,10 @@ lua:
realm: client
description: "Get the constant attenuation of the projected texture."
-
+ arguments:
+ - position: 1
+ name: "projectedTexture"
+ type: ProjectedTexture
returns:
- type: number
description: "The constant attenuation of the projected texture."
diff --git a/docs/classes/ProjectedTexture/GetEnableShadows.md b/docs/classes/ProjectedTexture/GetEnableShadows.md
index 028b5fd6d8..17bb494e46 100644
--- a/docs/classes/ProjectedTexture/GetEnableShadows.md
+++ b/docs/classes/ProjectedTexture/GetEnableShadows.md
@@ -13,7 +13,10 @@ lua:
realm: client
description: "Get whether shadows are enabled for this projected texture."
-
+ arguments:
+ - position: 1
+ name: "projectedTexture"
+ type: ProjectedTexture
returns:
- type: boolean
description: "Whether shadows are enabled for this projected texture."
diff --git a/docs/classes/ProjectedTexture/GetFarZ.md b/docs/classes/ProjectedTexture/GetFarZ.md
index c25a4fb346..61f99c5d48 100644
--- a/docs/classes/ProjectedTexture/GetFarZ.md
+++ b/docs/classes/ProjectedTexture/GetFarZ.md
@@ -13,7 +13,10 @@ lua:
realm: client
description: "Get the projection distance of the projected texture."
-
+ arguments:
+ - position: 1
+ name: "projectedTexture"
+ type: ProjectedTexture
returns:
- type: number
description: "The projection distance of the projected texture."
diff --git a/docs/classes/ProjectedTexture/GetHorizontalFov.md b/docs/classes/ProjectedTexture/GetHorizontalFov.md
index 9ae28521c2..ffb17fafc1 100644
--- a/docs/classes/ProjectedTexture/GetHorizontalFov.md
+++ b/docs/classes/ProjectedTexture/GetHorizontalFov.md
@@ -13,7 +13,10 @@ lua:
realm: client
description: "Get the horizontal FOV of the projected texture."
-
+ arguments:
+ - position: 1
+ name: "projectedTexture"
+ type: ProjectedTexture
returns:
- type: number
description: "The horizontal FOV of the projected texture."
diff --git a/docs/classes/ProjectedTexture/GetLightWorld.md b/docs/classes/ProjectedTexture/GetLightWorld.md
index 1b20681778..3fcd1e161d 100644
--- a/docs/classes/ProjectedTexture/GetLightWorld.md
+++ b/docs/classes/ProjectedTexture/GetLightWorld.md
@@ -13,7 +13,10 @@ lua:
realm: client
description: "Get whenever or not the Texture should light up world geometry."
-
+ arguments:
+ - position: 1
+ name: "projectedTexture"
+ type: ProjectedTexture
returns:
- type: boolean
description: "Whether the texture should light up world geometry."
diff --git a/docs/classes/ProjectedTexture/GetLinearAttenuation.md b/docs/classes/ProjectedTexture/GetLinearAttenuation.md
index 465790d680..324ecec326 100644
--- a/docs/classes/ProjectedTexture/GetLinearAttenuation.md
+++ b/docs/classes/ProjectedTexture/GetLinearAttenuation.md
@@ -13,7 +13,10 @@ lua:
realm: client
description: "Get the linear attenuation of the projected texture."
-
+ arguments:
+ - position: 1
+ name: "projectedTexture"
+ type: ProjectedTexture
returns:
- type: number
description: "The linear attenuation of the projected texture."
diff --git a/docs/classes/ProjectedTexture/GetNearZ.md b/docs/classes/ProjectedTexture/GetNearZ.md
index 48599ead97..465ba80be6 100644
--- a/docs/classes/ProjectedTexture/GetNearZ.md
+++ b/docs/classes/ProjectedTexture/GetNearZ.md
@@ -13,7 +13,10 @@ lua:
realm: client
description: "Get the NearZ value of the projected texture."
-
+ arguments:
+ - position: 1
+ name: "projectedTexture"
+ type: ProjectedTexture
returns:
- type: number
description: "The NearZ value of the projected texture."
diff --git a/docs/classes/ProjectedTexture/GetOrthographic.md b/docs/classes/ProjectedTexture/GetOrthographic.md
index eb1032adcb..ca215aacfc 100644
--- a/docs/classes/ProjectedTexture/GetOrthographic.md
+++ b/docs/classes/ProjectedTexture/GetOrthographic.md
@@ -13,7 +13,10 @@ lua:
realm: client
description: "Returns the current orthographic settings of the Projected Texture."
-
+ arguments:
+ - position: 1
+ name: "projectedTexture"
+ type: ProjectedTexture
returns:
- type: boolean
description: "Whether the projected texture is orthographic."
diff --git a/docs/classes/ProjectedTexture/GetPosition.md b/docs/classes/ProjectedTexture/GetPosition.md
index bdb44a4462..ae4f848637 100644
--- a/docs/classes/ProjectedTexture/GetPosition.md
+++ b/docs/classes/ProjectedTexture/GetPosition.md
@@ -13,7 +13,10 @@ lua:
realm: client
description: "Get the position of the projected texture."
-
+ arguments:
+ - position: 1
+ name: "projectedTexture"
+ type: ProjectedTexture
returns:
- type: Vector
description: "The position of the projected texture."
diff --git a/docs/classes/ProjectedTexture/GetQuadraticAttenuation.md b/docs/classes/ProjectedTexture/GetQuadraticAttenuation.md
index 03b6cf0b00..942a564965 100644
--- a/docs/classes/ProjectedTexture/GetQuadraticAttenuation.md
+++ b/docs/classes/ProjectedTexture/GetQuadraticAttenuation.md
@@ -13,7 +13,10 @@ lua:
realm: client
description: "Get the quadratic attenuation of the projected texture."
-
+ arguments:
+ - position: 1
+ name: "projectedTexture"
+ type: ProjectedTexture
returns:
- type: number
description: "The quadratic attenuation of the projected texture."
diff --git a/docs/classes/ProjectedTexture/GetScissorRectangle.md b/docs/classes/ProjectedTexture/GetScissorRectangle.md
index 3638da82b7..3f52be578b 100644
--- a/docs/classes/ProjectedTexture/GetScissorRectangle.md
+++ b/docs/classes/ProjectedTexture/GetScissorRectangle.md
@@ -13,7 +13,10 @@ lua:
realm: client
description: "Get the scissor settings of the projected texture."
-
+ arguments:
+ - position: 1
+ name: "projectedTexture"
+ type: ProjectedTexture
returns:
- type: boolean
description: "Whether the projected texture is cut off."
diff --git a/docs/classes/ProjectedTexture/GetShadowDepthBias.md b/docs/classes/ProjectedTexture/GetShadowDepthBias.md
index 00ca60e456..558174ee4a 100644
--- a/docs/classes/ProjectedTexture/GetShadowDepthBias.md
+++ b/docs/classes/ProjectedTexture/GetShadowDepthBias.md
@@ -13,7 +13,10 @@ lua:
realm: client
description: "Get the shadow depth bias of the projected texture."
-
+ arguments:
+ - position: 1
+ name: "projectedTexture"
+ type: ProjectedTexture
returns:
- type: number
description: "The shadow depth bias of the projected texture."
diff --git a/docs/classes/ProjectedTexture/GetShadowFilter.md b/docs/classes/ProjectedTexture/GetShadowFilter.md
index 3c61e4532c..4398f0f8c5 100644
--- a/docs/classes/ProjectedTexture/GetShadowFilter.md
+++ b/docs/classes/ProjectedTexture/GetShadowFilter.md
@@ -13,7 +13,10 @@ lua:
realm: client
description: "Get the shadow filter size of the projected texture."
-
+ arguments:
+ - position: 1
+ name: "projectedTexture"
+ type: ProjectedTexture
returns:
- type: number
description: "The shadow filter size of the projected texture."
diff --git a/docs/classes/ProjectedTexture/GetShadowSlopeScaleDepthBias.md b/docs/classes/ProjectedTexture/GetShadowSlopeScaleDepthBias.md
index 84def712c3..671cc54ada 100644
--- a/docs/classes/ProjectedTexture/GetShadowSlopeScaleDepthBias.md
+++ b/docs/classes/ProjectedTexture/GetShadowSlopeScaleDepthBias.md
@@ -13,7 +13,10 @@ lua:
realm: client
description: "Get the shadow depth slope scale bias of the projected texture."
-
+ arguments:
+ - position: 1
+ name: "projectedTexture"
+ type: ProjectedTexture
returns:
- type: number
description: "The shadow depth slope scale bias of the projected texture."
diff --git a/docs/classes/ProjectedTexture/GetTargetEntity.md b/docs/classes/ProjectedTexture/GetTargetEntity.md
index 4d6091b065..bf5b6f59f9 100644
--- a/docs/classes/ProjectedTexture/GetTargetEntity.md
+++ b/docs/classes/ProjectedTexture/GetTargetEntity.md
@@ -13,7 +13,10 @@ lua:
realm: client
description: "Get the target entity of this projected texture."
-
+ arguments:
+ - position: 1
+ name: "projectedTexture"
+ type: ProjectedTexture
returns:
- type: Entity
description: "The target entity of this projected texture."
diff --git a/docs/classes/ProjectedTexture/GetTexture.md b/docs/classes/ProjectedTexture/GetTexture.md
index 5b6936fec6..2796ce63d1 100644
--- a/docs/classes/ProjectedTexture/GetTexture.md
+++ b/docs/classes/ProjectedTexture/GetTexture.md
@@ -13,7 +13,10 @@ lua:
realm: client
description: "Get the texture of the projected texture."
-
+ arguments:
+ - position: 1
+ name: "projectedTexture"
+ type: ProjectedTexture
returns:
- type: ITexture
description: "The texture of the projected texture."
diff --git a/docs/classes/ProjectedTexture/GetTextureFrame.md b/docs/classes/ProjectedTexture/GetTextureFrame.md
index 9ff66f4c3a..3f47556e30 100644
--- a/docs/classes/ProjectedTexture/GetTextureFrame.md
+++ b/docs/classes/ProjectedTexture/GetTextureFrame.md
@@ -13,7 +13,10 @@ lua:
realm: client
description: "Get the texture frame of the projected texture."
-
+ arguments:
+ - position: 1
+ name: "projectedTexture"
+ type: ProjectedTexture
returns:
- type: number
description: "The texture frame of the projected texture."
diff --git a/docs/classes/ProjectedTexture/GetVerticalFov.md b/docs/classes/ProjectedTexture/GetVerticalFov.md
index 49e4bf36ab..2575ca272e 100644
--- a/docs/classes/ProjectedTexture/GetVerticalFov.md
+++ b/docs/classes/ProjectedTexture/GetVerticalFov.md
@@ -13,7 +13,10 @@ lua:
realm: client
description: "Get the vertical FOV of the projected texture."
-
+ arguments:
+ - position: 1
+ name: "projectedTexture"
+ type: ProjectedTexture
returns:
- type: number
description: "The vertical FOV of the projected texture."
diff --git a/docs/classes/ProjectedTexture/IsValid.md b/docs/classes/ProjectedTexture/IsValid.md
index 93ad6aa0e3..e69fe8941c 100644
--- a/docs/classes/ProjectedTexture/IsValid.md
+++ b/docs/classes/ProjectedTexture/IsValid.md
@@ -13,7 +13,10 @@ lua:
realm: client
description: "Check if the projected texture is valid."
-
+ arguments:
+ - position: 1
+ name: "projectedTexture"
+ type: ProjectedTexture
returns:
- type: boolean
description: "Whether the projected texture is valid."
diff --git a/docs/classes/ProjectedTexture/Remove.md b/docs/classes/ProjectedTexture/Remove.md
index 0a8a52f65b..61ee04d4a7 100644
--- a/docs/classes/ProjectedTexture/Remove.md
+++ b/docs/classes/ProjectedTexture/Remove.md
@@ -13,7 +13,10 @@ lua:
realm: client
description: "Removes the projected texture."
-
+ arguments:
+ - position: 1
+ name: "projectedTexture"
+ type: ProjectedTexture
returns:
---
diff --git a/docs/classes/ProjectedTexture/SetAngles.md b/docs/classes/ProjectedTexture/SetAngles.md
index d64513c627..507882576e 100644
--- a/docs/classes/ProjectedTexture/SetAngles.md
+++ b/docs/classes/ProjectedTexture/SetAngles.md
@@ -14,8 +14,12 @@ lua:
description: "Set the angles (direction) of the projected texture."
arguments:
- - name: "angle"
- type: Angle
+ - position: 1
+ name: "projectedTexture"
+ type: ProjectedTexture
+ - position: 2
+ name: "angle"
+ type: Angle
returns:
---
diff --git a/docs/classes/ProjectedTexture/SetBrightness.md b/docs/classes/ProjectedTexture/SetBrightness.md
index 41ab1a3c17..5317b6a5da 100644
--- a/docs/classes/ProjectedTexture/SetBrightness.md
+++ b/docs/classes/ProjectedTexture/SetBrightness.md
@@ -14,8 +14,12 @@ lua:
description: "Set the brightness of the projected texture."
arguments:
- - name: "brightness"
- type: number
+ - position: 1
+ name: "projectedTexture"
+ type: ProjectedTexture
+ - position: 2
+ name: "brightness"
+ type: number
returns:
---
diff --git a/docs/classes/ProjectedTexture/SetColor.md b/docs/classes/ProjectedTexture/SetColor.md
index 3bb29e91bc..4bd2162ab0 100644
--- a/docs/classes/ProjectedTexture/SetColor.md
+++ b/docs/classes/ProjectedTexture/SetColor.md
@@ -14,8 +14,12 @@ lua:
description: "Set the color of the projected texture."
arguments:
- - name: "color"
- type: Color
+ - position: 1
+ name: "projectedTexture"
+ type: ProjectedTexture
+ - position: 2
+ name: "color"
+ type: Color
returns:
---
diff --git a/docs/classes/ProjectedTexture/SetConstantAttenuation.md b/docs/classes/ProjectedTexture/SetConstantAttenuation.md
index 15afc03234..80dd704b43 100644
--- a/docs/classes/ProjectedTexture/SetConstantAttenuation.md
+++ b/docs/classes/ProjectedTexture/SetConstantAttenuation.md
@@ -14,8 +14,12 @@ lua:
description: "Set the constant attenuation of the projected texture."
arguments:
- - name: "constAtten"
- type: number
+ - position: 1
+ name: "projectedTexture"
+ type: ProjectedTexture
+ - position: 2
+ name: "constAtten"
+ type: number
returns:
---
diff --git a/docs/classes/ProjectedTexture/SetEnableShadows.md b/docs/classes/ProjectedTexture/SetEnableShadows.md
index abfca11b75..bc07a847e5 100644
--- a/docs/classes/ProjectedTexture/SetEnableShadows.md
+++ b/docs/classes/ProjectedTexture/SetEnableShadows.md
@@ -14,8 +14,12 @@ lua:
description: "Enable or disable shadows cast from the projected texture."
arguments:
- - name: "newState"
- type: boolean
+ - position: 1
+ name: "projectedTexture"
+ type: ProjectedTexture
+ - position: 2
+ name: "newState"
+ type: boolean
returns:
---
diff --git a/docs/classes/ProjectedTexture/SetFarZ.md b/docs/classes/ProjectedTexture/SetFarZ.md
index bf971baad4..0f38925d6a 100644
--- a/docs/classes/ProjectedTexture/SetFarZ.md
+++ b/docs/classes/ProjectedTexture/SetFarZ.md
@@ -14,8 +14,12 @@ lua:
description: "Set the distance at which the projected texture ends."
arguments:
- - name: "farZ"
- type: number
+ - position: 1
+ name: "projectedTexture"
+ type: ProjectedTexture
+ - position: 2
+ name: "farZ"
+ type: number
returns:
---
diff --git a/docs/classes/ProjectedTexture/SetFov.md b/docs/classes/ProjectedTexture/SetFov.md
index 64ba7b36f1..5d33a8cf76 100644
--- a/docs/classes/ProjectedTexture/SetFov.md
+++ b/docs/classes/ProjectedTexture/SetFov.md
@@ -14,8 +14,12 @@ lua:
description: "Set the angle of projection."
arguments:
- - name: "fov"
- type: number
+ - position: 1
+ name: "projectedTexture"
+ type: ProjectedTexture
+ - position: 2
+ name: "fov"
+ type: number
returns:
---
diff --git a/docs/classes/ProjectedTexture/SetHorizontalFov.md b/docs/classes/ProjectedTexture/SetHorizontalFov.md
index a5bd659f86..544dcb5482 100644
--- a/docs/classes/ProjectedTexture/SetHorizontalFov.md
+++ b/docs/classes/ProjectedTexture/SetHorizontalFov.md
@@ -14,8 +14,12 @@ lua:
description: "Set the horizontal angle of projection without affecting the vertical angle."
arguments:
- - name: "horizontalFov"
- type: number
+ - position: 1
+ name: "projectedTexture"
+ type: ProjectedTexture
+ - position: 2
+ name: "horizontalFov"
+ type: number
returns:
---
diff --git a/docs/classes/ProjectedTexture/SetLightWorld.md b/docs/classes/ProjectedTexture/SetLightWorld.md
index 4c232c9a29..9d63c0e8c0 100644
--- a/docs/classes/ProjectedTexture/SetLightWorld.md
+++ b/docs/classes/ProjectedTexture/SetLightWorld.md
@@ -14,8 +14,12 @@ lua:
description: "Set whenever or not the Texture should light up world geometry."
arguments:
- - name: "lightWorld"
- type: boolean
+ - position: 1
+ name: "projectedTexture"
+ type: ProjectedTexture
+ - position: 2
+ name: "lightWorld"
+ type: boolean
returns:
---
diff --git a/docs/classes/ProjectedTexture/SetLinearAttenuation.md b/docs/classes/ProjectedTexture/SetLinearAttenuation.md
index e4611f1223..75102c5ff2 100644
--- a/docs/classes/ProjectedTexture/SetLinearAttenuation.md
+++ b/docs/classes/ProjectedTexture/SetLinearAttenuation.md
@@ -14,8 +14,12 @@ lua:
description: "Set the linear attenuation of the projected texture."
arguments:
- - name: "linearAtten"
- type: number
+ - position: 1
+ name: "projectedTexture"
+ type: ProjectedTexture
+ - position: 2
+ name: "linearAtten"
+ type: number
returns:
---
diff --git a/docs/classes/ProjectedTexture/SetNearZ.md b/docs/classes/ProjectedTexture/SetNearZ.md
index a9234914f9..f9676f7037 100644
--- a/docs/classes/ProjectedTexture/SetNearZ.md
+++ b/docs/classes/ProjectedTexture/SetNearZ.md
@@ -14,8 +14,12 @@ lua:
description: "Set the distance at which the projected texture begins its projection."
arguments:
- - name: "nearZ"
- type: number
+ - position: 1
+ name: "projectedTexture"
+ type: ProjectedTexture
+ - position: 2
+ name: "nearZ"
+ type: number
returns:
---
diff --git a/docs/classes/ProjectedTexture/SetOrthographic.md b/docs/classes/ProjectedTexture/SetOrthographic.md
index 22858300ae..827ec97e84 100644
--- a/docs/classes/ProjectedTexture/SetOrthographic.md
+++ b/docs/classes/ProjectedTexture/SetOrthographic.md
@@ -14,16 +14,24 @@ lua:
description: "Changes the current projected texture between orthographic and perspective projection."
arguments:
- - name: "orthographic"
- type: boolean
- - name: "left"
- type: number
- - name: "top"
- type: number
- - name: "right"
- type: number
- - name: "bottom"
- type: number
+ - position: 1
+ name: "projectedTexture"
+ type: ProjectedTexture
+ - position: 2
+ name: "orthographic"
+ type: boolean
+ - position: 3
+ name: "left"
+ type: number
+ - position: 4
+ name: "top"
+ type: number
+ - position: 5
+ name: "right"
+ type: number
+ - position: 6
+ name: "bottom"
+ type: number
returns:
---
diff --git a/docs/classes/ProjectedTexture/SetPosition.md b/docs/classes/ProjectedTexture/SetPosition.md
index 6679901c5b..8ccdb07ec2 100644
--- a/docs/classes/ProjectedTexture/SetPosition.md
+++ b/docs/classes/ProjectedTexture/SetPosition.md
@@ -14,8 +14,12 @@ lua:
description: "Move the Projected Texture to the specified position."
arguments:
- - name: "position"
- type: Vector
+ - position: 1
+ name: "projectedTexture"
+ type: ProjectedTexture
+ - position: 2
+ name: "position"
+ type: Vector
returns:
---
diff --git a/docs/classes/ProjectedTexture/SetQuadraticAttenuation.md b/docs/classes/ProjectedTexture/SetQuadraticAttenuation.md
index 429fa5ab83..28615d9f4c 100644
--- a/docs/classes/ProjectedTexture/SetQuadraticAttenuation.md
+++ b/docs/classes/ProjectedTexture/SetQuadraticAttenuation.md
@@ -14,8 +14,12 @@ lua:
description: "Set the quadratic attenuation of the projected texture."
arguments:
- - name: "quadAtten"
- type: number
+ - position: 1
+ name: "projectedTexture"
+ type: ProjectedTexture
+ - position: 2
+ name: "quadAtten"
+ type: number
returns:
---
diff --git a/docs/classes/ProjectedTexture/SetScissorRectangle.md b/docs/classes/ProjectedTexture/SetScissorRectangle.md
index 3c6ef7ed37..8eb34dd0a6 100644
--- a/docs/classes/ProjectedTexture/SetScissorRectangle.md
+++ b/docs/classes/ProjectedTexture/SetScissorRectangle.md
@@ -14,16 +14,24 @@ lua:
description: "Set the scissor settings of the projected texture."
arguments:
- - name: "scissor"
- type: boolean
- - name: "left"
- type: integer
- - name: "top"
- type: integer
- - name: "right"
- type: integer
- - name: "bottom"
- type: integer
+ - position: 1
+ name: "projectedTexture"
+ type: ProjectedTexture
+ - position: 2
+ name: "scissor"
+ type: boolean
+ - position: 3
+ name: "left"
+ type: integer
+ - position: 4
+ name: "top"
+ type: integer
+ - position: 5
+ name: "right"
+ type: integer
+ - position: 6
+ name: "bottom"
+ type: integer
returns:
---
diff --git a/docs/classes/ProjectedTexture/SetShadowDepthBias.md b/docs/classes/ProjectedTexture/SetShadowDepthBias.md
index c785259ac7..29d6c57ead 100644
--- a/docs/classes/ProjectedTexture/SetShadowDepthBias.md
+++ b/docs/classes/ProjectedTexture/SetShadowDepthBias.md
@@ -14,8 +14,12 @@ lua:
description: "Set the shadow depth bias of the projected texture."
arguments:
- - name: "bias"
- type: number
+ - position: 1
+ name: "projectedTexture"
+ type: ProjectedTexture
+ - position: 2
+ name: "bias"
+ type: number
returns:
---
diff --git a/docs/classes/ProjectedTexture/SetShadowFilter.md b/docs/classes/ProjectedTexture/SetShadowFilter.md
index e9c85f2267..f5f56c702b 100644
--- a/docs/classes/ProjectedTexture/SetShadowFilter.md
+++ b/docs/classes/ProjectedTexture/SetShadowFilter.md
@@ -14,8 +14,12 @@ lua:
description: "Set the shadow filter size of the projected texture."
arguments:
- - name: "filter"
- type: number
+ - position: 1
+ name: "projectedTexture"
+ type: ProjectedTexture
+ - position: 2
+ name: "filter"
+ type: number
returns:
---
diff --git a/docs/classes/ProjectedTexture/SetShadowSlopeScaleDepthBias.md b/docs/classes/ProjectedTexture/SetShadowSlopeScaleDepthBias.md
index 28a67ce883..8a7086d94f 100644
--- a/docs/classes/ProjectedTexture/SetShadowSlopeScaleDepthBias.md
+++ b/docs/classes/ProjectedTexture/SetShadowSlopeScaleDepthBias.md
@@ -14,8 +14,12 @@ lua:
description: "Set the shadow depth slope scale bias of the projected texture."
arguments:
- - name: "bias"
- type: number
+ - position: 1
+ name: "projectedTexture"
+ type: ProjectedTexture
+ - position: 2
+ name: "bias"
+ type: number
returns:
---
diff --git a/docs/classes/ProjectedTexture/SetTargetEntity.md b/docs/classes/ProjectedTexture/SetTargetEntity.md
index e2224db72c..6d0ad8f096 100644
--- a/docs/classes/ProjectedTexture/SetTargetEntity.md
+++ b/docs/classes/ProjectedTexture/SetTargetEntity.md
@@ -14,8 +14,12 @@ lua:
description: "Set the target entity for this projected texture."
arguments:
- - name: "entity"
- type: Entity
+ - position: 1
+ name: "projectedTexture"
+ type: ProjectedTexture
+ - position: 2
+ name: "entity"
+ type: Entity
returns:
---
diff --git a/docs/classes/ProjectedTexture/SetTexture.md b/docs/classes/ProjectedTexture/SetTexture.md
index 4167c533d0..dd240b6952 100644
--- a/docs/classes/ProjectedTexture/SetTexture.md
+++ b/docs/classes/ProjectedTexture/SetTexture.md
@@ -14,8 +14,12 @@ lua:
description: "Set the texture to be projected."
arguments:
- - name: "texture"
- type: string
+ - position: 1
+ name: "projectedTexture"
+ type: ProjectedTexture
+ - position: 2
+ name: "texture"
+ type: string
returns:
---
diff --git a/docs/classes/ProjectedTexture/SetTextureFrame.md b/docs/classes/ProjectedTexture/SetTextureFrame.md
index dbf4da8bb8..3367b58b1f 100644
--- a/docs/classes/ProjectedTexture/SetTextureFrame.md
+++ b/docs/classes/ProjectedTexture/SetTextureFrame.md
@@ -14,8 +14,12 @@ lua:
description: "For animated textures, this will choose which frame in the animation will be projected."
arguments:
- - name: "frame"
- type: integer
+ - position: 1
+ name: "projectedTexture"
+ type: ProjectedTexture
+ - position: 2
+ name: "frame"
+ type: integer
returns:
---
diff --git a/docs/classes/ProjectedTexture/SetVerticalFov.md b/docs/classes/ProjectedTexture/SetVerticalFov.md
index c72d0ab2ab..20b93dfc39 100644
--- a/docs/classes/ProjectedTexture/SetVerticalFov.md
+++ b/docs/classes/ProjectedTexture/SetVerticalFov.md
@@ -14,8 +14,12 @@ lua:
description: "Set the vertical angle of projection without affecting the horizontal angle."
arguments:
- - name: "verticalFov"
- type: number
+ - position: 1
+ name: "projectedTexture"
+ type: ProjectedTexture
+ - position: 2
+ name: "verticalFov"
+ type: number
returns:
---
diff --git a/docs/classes/ProjectedTexture/Update.md b/docs/classes/ProjectedTexture/Update.md
index 9ebf33f704..db721228a1 100644
--- a/docs/classes/ProjectedTexture/Update.md
+++ b/docs/classes/ProjectedTexture/Update.md
@@ -13,7 +13,10 @@ lua:
realm: client
description: "Updates the projected light and applies all previously set parameters."
-
+ arguments:
+ - position: 1
+ name: "projectedTexture"
+ type: ProjectedTexture
returns:
---
diff --git a/docs/classes/ProjectedTexture/__eq.md b/docs/classes/ProjectedTexture/__eq.md
index 904c2863e4..9f3a7d393d 100644
--- a/docs/classes/ProjectedTexture/__eq.md
+++ b/docs/classes/ProjectedTexture/__eq.md
@@ -14,8 +14,12 @@ lua:
description: "Metamethod that is called when comparing two entities"
arguments:
- - name: "otherProjectedTexture"
- type: ProjectedTexture
+ - position: 1
+ name: "projectedTexture"
+ type: ProjectedTexture
+ - position: 2
+ name: "other"
+ type: ProjectedTexture
returns:
- type: boolean
description: "True if entities are equal."
diff --git a/docs/classes/ProjectedTexture/__index.md b/docs/classes/ProjectedTexture/__index.md
index a02f767363..0ddf841149 100644
--- a/docs/classes/ProjectedTexture/__index.md
+++ b/docs/classes/ProjectedTexture/__index.md
@@ -14,8 +14,12 @@ lua:
description: "Metamethod that is called when a non existing field is indexed"
arguments:
- - name: "field"
- type: string
+ - position: 1
+ name: "projectedTexture"
+ type: ProjectedTexture
+ - position: 2
+ name: "field"
+ type: string
returns:
- type: any
description: "The value of the field"
diff --git a/docs/classes/ProjectedTexture/__newindex.md b/docs/classes/ProjectedTexture/__newindex.md
index a32acad2fc..2f70b197b0 100644
--- a/docs/classes/ProjectedTexture/__newindex.md
+++ b/docs/classes/ProjectedTexture/__newindex.md
@@ -14,8 +14,12 @@ lua:
description: "Metamethod that is called a new field is added"
arguments:
- - name: "field"
- type: string
+ - position: 1
+ name: "projectedTexture"
+ type: ProjectedTexture
+ - position: 2
+ name: "field"
+ type: string
returns:
---
diff --git a/docs/classes/ProjectedTexture/__tostring.md b/docs/classes/ProjectedTexture/__tostring.md
index be40fc38fe..95f7e31d88 100644
--- a/docs/classes/ProjectedTexture/__tostring.md
+++ b/docs/classes/ProjectedTexture/__tostring.md
@@ -13,7 +13,10 @@ lua:
realm: client
description: "Converts the projected texture to a string."
-
+ arguments:
+ - position: 1
+ name: "projectedTexture"
+ type: ProjectedTexture
returns:
- type: string
description: "The string representation of the projected texture."
diff --git a/docs/classes/RecipientFilter/AddAllPlayers.md b/docs/classes/RecipientFilter/AddAllPlayers.md
index 456af98476..823619266d 100644
--- a/docs/classes/RecipientFilter/AddAllPlayers.md
+++ b/docs/classes/RecipientFilter/AddAllPlayers.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Adds all players to the filter"
-
+ arguments:
+ - position: 1
+ name: "filter"
+ type: RecipientFilter
returns:
---
diff --git a/docs/classes/RecipientFilter/AddRecipient.md b/docs/classes/RecipientFilter/AddRecipient.md
index 868d8f71c3..33853fc271 100644
--- a/docs/classes/RecipientFilter/AddRecipient.md
+++ b/docs/classes/RecipientFilter/AddRecipient.md
@@ -13,7 +13,13 @@ lua:
realm: shared
description: "Adds a single recipient"
-
+ arguments:
+ - position: 1
+ name: "filter"
+ type: RecipientFilter
+ - position: 2
+ name: "player"
+ type: Player
returns:
---
diff --git a/docs/classes/RecipientFilter/AddRecipientsByPAS.md b/docs/classes/RecipientFilter/AddRecipientsByPAS.md
index 8836230b34..5ebd9f05d3 100644
--- a/docs/classes/RecipientFilter/AddRecipientsByPAS.md
+++ b/docs/classes/RecipientFilter/AddRecipientsByPAS.md
@@ -13,7 +13,13 @@ lua:
realm: shared
description: "Adds recipients by potentially audible set"
-
+ arguments:
+ - position: 1
+ name: "filter"
+ type: RecipientFilter
+ - position: 2
+ name: "position"
+ type: Vector
returns:
---
diff --git a/docs/classes/RecipientFilter/AddRecipientsByPVS.md b/docs/classes/RecipientFilter/AddRecipientsByPVS.md
index db1a2044c1..4eaf180335 100644
--- a/docs/classes/RecipientFilter/AddRecipientsByPVS.md
+++ b/docs/classes/RecipientFilter/AddRecipientsByPVS.md
@@ -13,7 +13,13 @@ lua:
realm: shared
description: "Adds recipients by potentially visible set"
-
+ arguments:
+ - position: 1
+ name: "filter"
+ type: RecipientFilter
+ - position: 2
+ name: "position"
+ type: Vector
returns:
---
diff --git a/docs/classes/RecipientFilter/CopyFrom.md b/docs/classes/RecipientFilter/CopyFrom.md
index fa8b541809..8e4a101412 100644
--- a/docs/classes/RecipientFilter/CopyFrom.md
+++ b/docs/classes/RecipientFilter/CopyFrom.md
@@ -13,7 +13,13 @@ lua:
realm: shared
description: "Copies from another filter"
-
+ arguments:
+ - position: 1
+ name: "destFilter"
+ type: RecipientFilter
+ - position: 2
+ name: "srcFilter"
+ type: RecipientFilter
returns:
---
diff --git a/docs/classes/RecipientFilter/GetRecipientCount.md b/docs/classes/RecipientFilter/GetRecipientCount.md
index ae1d77c81a..276525b33b 100644
--- a/docs/classes/RecipientFilter/GetRecipientCount.md
+++ b/docs/classes/RecipientFilter/GetRecipientCount.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Gets the count of recipients"
-
+ arguments:
+ - position: 1
+ name: "filter"
+ type: RecipientFilter
returns:
---
diff --git a/docs/classes/RecipientFilter/GetRecipientIndex.md b/docs/classes/RecipientFilter/GetRecipientIndex.md
index 805b7d2edc..6de12aa7e6 100644
--- a/docs/classes/RecipientFilter/GetRecipientIndex.md
+++ b/docs/classes/RecipientFilter/GetRecipientIndex.md
@@ -13,7 +13,13 @@ lua:
realm: shared
description: "Gets recipient index"
-
+ arguments:
+ - position: 1
+ name: "filter"
+ type: RecipientFilter
+ - position: 2
+ name: "index"
+ type: number
returns:
---
diff --git a/docs/classes/RecipientFilter/IgnorePredictionCull.md b/docs/classes/RecipientFilter/IgnorePredictionCull.md
index b55aa8fb1d..62af5e57aa 100644
--- a/docs/classes/RecipientFilter/IgnorePredictionCull.md
+++ b/docs/classes/RecipientFilter/IgnorePredictionCull.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Checks if prediction culling is ignored"
-
+ arguments:
+ - position: 1
+ name: "filter"
+ type: RecipientFilter
returns:
---
diff --git a/docs/classes/RecipientFilter/IsInitMessage.md b/docs/classes/RecipientFilter/IsInitMessage.md
index 2440a9594c..9edf329686 100644
--- a/docs/classes/RecipientFilter/IsInitMessage.md
+++ b/docs/classes/RecipientFilter/IsInitMessage.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Checks if it is an init message"
-
+ arguments:
+ - position: 1
+ name: "filter"
+ type: RecipientFilter
returns:
---
diff --git a/docs/classes/RecipientFilter/IsReliable.md b/docs/classes/RecipientFilter/IsReliable.md
index 9866156e27..506a7c4ff3 100644
--- a/docs/classes/RecipientFilter/IsReliable.md
+++ b/docs/classes/RecipientFilter/IsReliable.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Checks if the filter is reliable"
-
+ arguments:
+ - position: 1
+ name: "filter"
+ type: RecipientFilter
returns:
---
diff --git a/docs/classes/RecipientFilter/IsUsingPredictionRules.md b/docs/classes/RecipientFilter/IsUsingPredictionRules.md
index 2f8ff79e08..85c3b5ad5c 100644
--- a/docs/classes/RecipientFilter/IsUsingPredictionRules.md
+++ b/docs/classes/RecipientFilter/IsUsingPredictionRules.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Checks if using prediction rules"
-
+ arguments:
+ - position: 1
+ name: "filter"
+ type: RecipientFilter
returns:
---
diff --git a/docs/classes/RecipientFilter/MakeInitMessage.md b/docs/classes/RecipientFilter/MakeInitMessage.md
index 034173b193..8647d21ae0 100644
--- a/docs/classes/RecipientFilter/MakeInitMessage.md
+++ b/docs/classes/RecipientFilter/MakeInitMessage.md
@@ -13,7 +13,10 @@ lua:
realm: client
description: "Makes the filter an init message"
-
+ arguments:
+ - position: 1
+ name: "filter"
+ type: RecipientFilter
returns:
---
diff --git a/docs/classes/RecipientFilter/MakeReliable.md b/docs/classes/RecipientFilter/MakeReliable.md
index 9953e884fa..eb0ffe1001 100644
--- a/docs/classes/RecipientFilter/MakeReliable.md
+++ b/docs/classes/RecipientFilter/MakeReliable.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Makes the filter reliable"
-
+ arguments:
+ - position: 1
+ name: "filter"
+ type: RecipientFilter
returns:
---
diff --git a/docs/classes/RecipientFilter/RemoveAllRecipients.md b/docs/classes/RecipientFilter/RemoveAllRecipients.md
index 5e03831566..e0a8510ff9 100644
--- a/docs/classes/RecipientFilter/RemoveAllRecipients.md
+++ b/docs/classes/RecipientFilter/RemoveAllRecipients.md
@@ -13,7 +13,10 @@ lua:
realm: client
description: "Removes all recipients"
-
+ arguments:
+ - position: 1
+ name: "filter"
+ type: RecipientFilter
returns:
---
diff --git a/docs/classes/RecipientFilter/RemoveRecipient.md b/docs/classes/RecipientFilter/RemoveRecipient.md
index 7e013671dc..da28d57835 100644
--- a/docs/classes/RecipientFilter/RemoveRecipient.md
+++ b/docs/classes/RecipientFilter/RemoveRecipient.md
@@ -13,7 +13,13 @@ lua:
realm: shared
description: "Removes a recipient"
-
+ arguments:
+ - position: 1
+ name: "filter"
+ type: RecipientFilter
+ - position: 2
+ name: "player"
+ type: Player
returns:
---
diff --git a/docs/classes/RecipientFilter/RemoveRecipientByPlayerIndex.md b/docs/classes/RecipientFilter/RemoveRecipientByPlayerIndex.md
index 80831b2b5f..3e6f0a0a89 100644
--- a/docs/classes/RecipientFilter/RemoveRecipientByPlayerIndex.md
+++ b/docs/classes/RecipientFilter/RemoveRecipientByPlayerIndex.md
@@ -13,7 +13,13 @@ lua:
realm: client
description: "Removes a recipient by player index"
-
+ arguments:
+ - position: 1
+ name: "filter"
+ type: RecipientFilter
+ - position: 2
+ name: "index"
+ type: number
returns:
---
diff --git a/docs/classes/RecipientFilter/RemoveRecipientsByPvs.md b/docs/classes/RecipientFilter/RemoveRecipientsByPvs.md
index 1a08af0e63..6975c43ee2 100644
--- a/docs/classes/RecipientFilter/RemoveRecipientsByPvs.md
+++ b/docs/classes/RecipientFilter/RemoveRecipientsByPvs.md
@@ -13,7 +13,13 @@ lua:
realm: client
description: "Removes recipients by potentially visible set"
-
+ arguments:
+ - position: 1
+ name: "filter"
+ type: RecipientFilter
+ - position: 2
+ name: "position"
+ type: Vector
returns:
---
diff --git a/docs/classes/RecipientFilter/Reset.md b/docs/classes/RecipientFilter/Reset.md
index dc2912b7e5..1a38e4e127 100644
--- a/docs/classes/RecipientFilter/Reset.md
+++ b/docs/classes/RecipientFilter/Reset.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Resets the filter"
-
+ arguments:
+ - position: 1
+ name: "filter"
+ type: RecipientFilter
returns:
---
diff --git a/docs/classes/RecipientFilter/SetIgnorePredictionCull.md b/docs/classes/RecipientFilter/SetIgnorePredictionCull.md
index 60c3ac5e9c..20907e133b 100644
--- a/docs/classes/RecipientFilter/SetIgnorePredictionCull.md
+++ b/docs/classes/RecipientFilter/SetIgnorePredictionCull.md
@@ -13,7 +13,13 @@ lua:
realm: shared
description: "Sets whether to ignore prediction cull"
-
+ arguments:
+ - position: 1
+ name: "filter"
+ type: RecipientFilter
+ - position: 2
+ name: "ignoreCull"
+ type: boolean
returns:
---
diff --git a/docs/classes/RecipientFilter/UsePredictionRules.md b/docs/classes/RecipientFilter/UsePredictionRules.md
index 93c7c168a4..2a46bf6a9d 100644
--- a/docs/classes/RecipientFilter/UsePredictionRules.md
+++ b/docs/classes/RecipientFilter/UsePredictionRules.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Applies prediction rules"
-
+ arguments:
+ - position: 1
+ name: "filter"
+ type: RecipientFilter
returns:
---
diff --git a/docs/classes/RecipientFilter/__tostring.md b/docs/classes/RecipientFilter/__tostring.md
index 71d4a4cd32..a61c5bfe97 100644
--- a/docs/classes/RecipientFilter/__tostring.md
+++ b/docs/classes/RecipientFilter/__tostring.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Returns a string representation of the filter"
-
+ arguments:
+ - position: 1
+ name: "filter"
+ type: RecipientFilter
returns:
---
diff --git a/docs/classes/Scheme/GetColor.md b/docs/classes/Scheme/GetColor.md
index cd664eb699..38c876a87c 100644
--- a/docs/classes/Scheme/GetColor.md
+++ b/docs/classes/Scheme/GetColor.md
@@ -14,10 +14,15 @@ lua:
description: "Returns the color for the specified color name."
arguments:
- - name: "colorName"
- type: string
- - name: "defaultColor"
- type: Color
+ - position: 1
+ name: "scheme"
+ type: Scheme
+ - position: 2
+ name: "colorName"
+ type: string
+ - position: 3
+ name: "defaultColor"
+ type: Color
returns:
- type: color
description: "The color for the specified color name."
diff --git a/docs/classes/Scheme/GetFont.md b/docs/classes/Scheme/GetFont.md
index f19e587276..772659982d 100644
--- a/docs/classes/Scheme/GetFont.md
+++ b/docs/classes/Scheme/GetFont.md
@@ -14,11 +14,16 @@ lua:
description: "Returns the font for the specified font name."
arguments:
- - name: "fontName"
- type: string
- - name: "proportional"
- type: boolean
- default: "false"
+ - position: 1
+ name: "scheme"
+ type: Scheme
+ - position: 2
+ name: "fontName"
+ type: string
+ - position: 3
+ name: "proportional"
+ type: boolean
+ default: "false"
returns:
- type: font
description: "The font for the specified font name."
diff --git a/docs/classes/Scheme/GetFontName.md b/docs/classes/Scheme/GetFontName.md
index 76d0311469..c58b43e949 100644
--- a/docs/classes/Scheme/GetFontName.md
+++ b/docs/classes/Scheme/GetFontName.md
@@ -14,8 +14,12 @@ lua:
description: "Returns the font name for the specified font handle."
arguments:
- - name: "font"
- type: FontHandle
+ - position: 1
+ name: "scheme"
+ type: Scheme
+ - position: 2
+ name: "font"
+ type: FontHandle
returns:
- type: string
description: "The font name for the specified font handle."
diff --git a/docs/classes/Scheme/GetResourceString.md b/docs/classes/Scheme/GetResourceString.md
index ff4c2b76de..5b90e09530 100644
--- a/docs/classes/Scheme/GetResourceString.md
+++ b/docs/classes/Scheme/GetResourceString.md
@@ -14,8 +14,12 @@ lua:
description: "Returns the resource string for the specified resource name."
arguments:
- - name: "resourceName"
- type: string
+ - position: 1
+ name: "scheme"
+ type: Scheme
+ - position: 2
+ name: "resourceName"
+ type: string
returns:
- type: string
description: "The resource string for the specified resource name."
diff --git a/docs/classes/Scheme/__tostring.md b/docs/classes/Scheme/__tostring.md
index 8441fae94e..7c86b507cf 100644
--- a/docs/classes/Scheme/__tostring.md
+++ b/docs/classes/Scheme/__tostring.md
@@ -13,7 +13,10 @@ lua:
realm: client
description: "Metamethod to get the string representation of the IScheme object."
-
+ arguments:
+ - position: 1
+ name: "scheme"
+ type: Scheme
returns:
- type: string
description: "The string representation of the IScheme object."
diff --git a/docs/classes/SteamFriendsHandle/ActivateGameOverlay.md b/docs/classes/SteamFriendsHandle/ActivateGameOverlay.md
index f10bff3e19..da51c1f02e 100644
--- a/docs/classes/SteamFriendsHandle/ActivateGameOverlay.md
+++ b/docs/classes/SteamFriendsHandle/ActivateGameOverlay.md
@@ -14,8 +14,12 @@ lua:
description: "Activate the Steam overlay to a specific place. Valid dialog options include: 'Friends', 'Community', 'Players', 'Settings', 'OfficialGameGroup', 'Stats', 'Achievements', 'chatroomgroup/nnnn'."
arguments:
- - name: "dialogOption"
- type: string
+ - position: 1
+ name: "steamFriends"
+ type: SteamFriendsHandle
+ - position: 2
+ name: "dialogOption"
+ type: string
returns:
---
diff --git a/docs/classes/SteamFriendsHandle/GetClanCount.md b/docs/classes/SteamFriendsHandle/GetClanCount.md
index 01d23a3577..b6259e944a 100644
--- a/docs/classes/SteamFriendsHandle/GetClanCount.md
+++ b/docs/classes/SteamFriendsHandle/GetClanCount.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Get the number of clans the current user is a member of."
-
+ arguments:
+ - position: 1
+ name: "steamFriends"
+ type: SteamFriendsHandle
returns:
- type: integer
description: "The number of clans the current user is a member of."
diff --git a/docs/classes/SteamFriendsHandle/GetFriendCount.md b/docs/classes/SteamFriendsHandle/GetFriendCount.md
index d9daf20429..4c5950b36f 100644
--- a/docs/classes/SteamFriendsHandle/GetFriendCount.md
+++ b/docs/classes/SteamFriendsHandle/GetFriendCount.md
@@ -14,8 +14,12 @@ lua:
description: "Get the number of friends the current user has of the specified flag types."
arguments:
- - name: "flag"
- type: number
+ - position: 1
+ name: "steamFriends"
+ type: SteamFriendsHandle
+ - position: 2
+ name: "flag"
+ type: number
returns:
- type: integer
description: "The number of friends the current user has."
diff --git a/docs/classes/SteamFriendsHandle/GetPersonaName.md b/docs/classes/SteamFriendsHandle/GetPersonaName.md
index edbe1caa62..83bbcec650 100644
--- a/docs/classes/SteamFriendsHandle/GetPersonaName.md
+++ b/docs/classes/SteamFriendsHandle/GetPersonaName.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Get the persona name of the current user."
-
+ arguments:
+ - position: 1
+ name: "steamFriends"
+ type: SteamFriendsHandle
returns:
- type: string
description: "The persona name of the current user."
diff --git a/docs/classes/SteamFriendsHandle/GetPersonaState.md b/docs/classes/SteamFriendsHandle/GetPersonaState.md
index 928e9e567d..f65a9c4f24 100644
--- a/docs/classes/SteamFriendsHandle/GetPersonaState.md
+++ b/docs/classes/SteamFriendsHandle/GetPersonaState.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Get the persona state of the current user."
-
+ arguments:
+ - position: 1
+ name: "steamFriends"
+ type: SteamFriendsHandle
returns:
- type: integer
description: "The persona state of the current user."
diff --git a/docs/classes/SteamFriendsHandle/SetPersonaName.md b/docs/classes/SteamFriendsHandle/SetPersonaName.md
index fa285be75f..ce0fe30661 100644
--- a/docs/classes/SteamFriendsHandle/SetPersonaName.md
+++ b/docs/classes/SteamFriendsHandle/SetPersonaName.md
@@ -14,8 +14,12 @@ lua:
description: "Set the persona name of the current user."
arguments:
- - name: "name"
- type: string
+ - position: 1
+ name: "steamFriends"
+ type: SteamFriendsHandle
+ - position: 2
+ name: "name"
+ type: string
returns:
---
diff --git a/docs/classes/SteamFriendsHandle/__tostring.md b/docs/classes/SteamFriendsHandle/__tostring.md
index 8f1028abc2..eea400ec97 100644
--- a/docs/classes/SteamFriendsHandle/__tostring.md
+++ b/docs/classes/SteamFriendsHandle/__tostring.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Get the persona name of the current user."
-
+ arguments:
+ - position: 1
+ name: "steamFriends"
+ type: SteamFriendsHandle
returns:
- type: string
description: "The persona name of the current user."
diff --git a/docs/classes/TakeDamageInfo/AddDamage.md b/docs/classes/TakeDamageInfo/AddDamage.md
index f7489b259c..98eb43aeab 100644
--- a/docs/classes/TakeDamageInfo/AddDamage.md
+++ b/docs/classes/TakeDamageInfo/AddDamage.md
@@ -13,7 +13,13 @@ lua:
realm: shared
description: "Adds damage to the damage info"
-
+ arguments:
+ - position: 1
+ name: "damageInfo"
+ type: DamageInfo
+ - position: 2
+ name: "damage"
+ type: number
returns:
---
diff --git a/docs/classes/TakeDamageInfo/AddDamageType.md b/docs/classes/TakeDamageInfo/AddDamageType.md
index d01c64f9c6..4038eb2878 100644
--- a/docs/classes/TakeDamageInfo/AddDamageType.md
+++ b/docs/classes/TakeDamageInfo/AddDamageType.md
@@ -13,7 +13,13 @@ lua:
realm: shared
description: "Adds a damage type"
-
+ arguments:
+ - position: 1
+ name: "damageInfo"
+ type: DamageInfo
+ - position: 2
+ name: "damageType"
+ type: number
returns:
---
diff --git a/docs/classes/TakeDamageInfo/AdjustPlayerDamageInflictedForSkillLevel.md b/docs/classes/TakeDamageInfo/AdjustPlayerDamageInflictedForSkillLevel.md
index 059c9b0de5..b5d9b39de6 100644
--- a/docs/classes/TakeDamageInfo/AdjustPlayerDamageInflictedForSkillLevel.md
+++ b/docs/classes/TakeDamageInfo/AdjustPlayerDamageInflictedForSkillLevel.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Adjusts player-inflicted damage based on skill level"
-
+ arguments:
+ - position: 1
+ name: "damageInfo"
+ type: DamageInfo
returns:
---
diff --git a/docs/classes/TakeDamageInfo/AdjustPlayerDamageTakenForSkillLevel.md b/docs/classes/TakeDamageInfo/AdjustPlayerDamageTakenForSkillLevel.md
index 5d15a3972a..c013b216c6 100644
--- a/docs/classes/TakeDamageInfo/AdjustPlayerDamageTakenForSkillLevel.md
+++ b/docs/classes/TakeDamageInfo/AdjustPlayerDamageTakenForSkillLevel.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Adjusts player-taken damage based on skill level"
-
+ arguments:
+ - position: 1
+ name: "damageInfo"
+ type: DamageInfo
returns:
---
diff --git a/docs/classes/TakeDamageInfo/BaseDamageIsValid.md b/docs/classes/TakeDamageInfo/BaseDamageIsValid.md
index 81b6fb6196..5879ead7b9 100644
--- a/docs/classes/TakeDamageInfo/BaseDamageIsValid.md
+++ b/docs/classes/TakeDamageInfo/BaseDamageIsValid.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Checks if base damage is valid"
-
+ arguments:
+ - position: 1
+ name: "damageInfo"
+ type: DamageInfo
returns:
- type: boolean
description: "True if base damage is valid, false otherwise."
diff --git a/docs/classes/TakeDamageInfo/CopyDamageToBaseDamage.md b/docs/classes/TakeDamageInfo/CopyDamageToBaseDamage.md
index e07f08e439..8b6f0eebc5 100644
--- a/docs/classes/TakeDamageInfo/CopyDamageToBaseDamage.md
+++ b/docs/classes/TakeDamageInfo/CopyDamageToBaseDamage.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Copies damage to base damage"
-
+ arguments:
+ - position: 1
+ name: "damageInfo"
+ type: DamageInfo
returns:
---
diff --git a/docs/classes/TakeDamageInfo/DebugGetDamageTypeString.md b/docs/classes/TakeDamageInfo/DebugGetDamageTypeString.md
index de8709839d..db5fbd5662 100644
--- a/docs/classes/TakeDamageInfo/DebugGetDamageTypeString.md
+++ b/docs/classes/TakeDamageInfo/DebugGetDamageTypeString.md
@@ -13,7 +13,13 @@ lua:
realm: shared
description: "Gets a string describing the damage type"
-
+ arguments:
+ - position: 1
+ name: "damageInfo"
+ type: DamageInfo
+ - position: 2
+ name: "bufferSize"
+ type: number
returns:
- type: string
description: "The string describing the damage type."
diff --git a/docs/classes/TakeDamageInfo/GetAmmoName.md b/docs/classes/TakeDamageInfo/GetAmmoName.md
index 491f388873..d7aa9c018e 100644
--- a/docs/classes/TakeDamageInfo/GetAmmoName.md
+++ b/docs/classes/TakeDamageInfo/GetAmmoName.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Gets the name of the ammo"
-
+ arguments:
+ - position: 1
+ name: "damageInfo"
+ type: DamageInfo
returns:
- type: string
description: "The name of the ammo."
diff --git a/docs/classes/TakeDamageInfo/GetAmmoType.md b/docs/classes/TakeDamageInfo/GetAmmoType.md
index 3988afbe37..845cabbb73 100644
--- a/docs/classes/TakeDamageInfo/GetAmmoType.md
+++ b/docs/classes/TakeDamageInfo/GetAmmoType.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Gets the ammo type"
-
+ arguments:
+ - position: 1
+ name: "damageInfo"
+ type: DamageInfo
returns:
- type: integer
description: "The ammo type."
diff --git a/docs/classes/TakeDamageInfo/GetAttacker.md b/docs/classes/TakeDamageInfo/GetAttacker.md
index 64a5380684..eb7375b6bf 100644
--- a/docs/classes/TakeDamageInfo/GetAttacker.md
+++ b/docs/classes/TakeDamageInfo/GetAttacker.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Gets the attacker entity"
-
+ arguments:
+ - position: 1
+ name: "damageInfo"
+ type: DamageInfo
returns:
- type: Entity
description: "The attacker entity."
diff --git a/docs/classes/TakeDamageInfo/GetBaseDamage.md b/docs/classes/TakeDamageInfo/GetBaseDamage.md
index d752945205..bc0dea7e6d 100644
--- a/docs/classes/TakeDamageInfo/GetBaseDamage.md
+++ b/docs/classes/TakeDamageInfo/GetBaseDamage.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Gets the base damage"
-
+ arguments:
+ - position: 1
+ name: "damageInfo"
+ type: DamageInfo
returns:
- type: number
description: "The base damage."
diff --git a/docs/classes/TakeDamageInfo/GetDamage.md b/docs/classes/TakeDamageInfo/GetDamage.md
index 16325a7dbb..7e1bd733a2 100644
--- a/docs/classes/TakeDamageInfo/GetDamage.md
+++ b/docs/classes/TakeDamageInfo/GetDamage.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Gets the damage"
-
+ arguments:
+ - position: 1
+ name: "damageInfo"
+ type: DamageInfo
returns:
- type: number
description: "The damage."
diff --git a/docs/classes/TakeDamageInfo/GetDamageCustom.md b/docs/classes/TakeDamageInfo/GetDamageCustom.md
index 1163994341..b64ea3f14e 100644
--- a/docs/classes/TakeDamageInfo/GetDamageCustom.md
+++ b/docs/classes/TakeDamageInfo/GetDamageCustom.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Gets custom damage"
-
+ arguments:
+ - position: 1
+ name: "damageInfo"
+ type: DamageInfo
returns:
- type: integer
description: "The custom damage."
diff --git a/docs/classes/TakeDamageInfo/GetDamageForce.md b/docs/classes/TakeDamageInfo/GetDamageForce.md
index c3d150de88..fd485dee82 100644
--- a/docs/classes/TakeDamageInfo/GetDamageForce.md
+++ b/docs/classes/TakeDamageInfo/GetDamageForce.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Gets the force of the damage"
-
+ arguments:
+ - position: 1
+ name: "damageInfo"
+ type: DamageInfo
returns:
- type: Vector
description: "The force of the damage."
diff --git a/docs/classes/TakeDamageInfo/GetDamagePosition.md b/docs/classes/TakeDamageInfo/GetDamagePosition.md
index e3a6a05224..8457150ef5 100644
--- a/docs/classes/TakeDamageInfo/GetDamagePosition.md
+++ b/docs/classes/TakeDamageInfo/GetDamagePosition.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Gets the position of the damage"
-
+ arguments:
+ - position: 1
+ name: "damageInfo"
+ type: DamageInfo
returns:
- type: Vector
description: "The position of the damage."
diff --git a/docs/classes/TakeDamageInfo/GetDamageStats.md b/docs/classes/TakeDamageInfo/GetDamageStats.md
index a5cb7fe4ee..723689fa5a 100644
--- a/docs/classes/TakeDamageInfo/GetDamageStats.md
+++ b/docs/classes/TakeDamageInfo/GetDamageStats.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Gets damage stats"
-
+ arguments:
+ - position: 1
+ name: "damageInfo"
+ type: DamageInfo
returns:
- type: integer
description: "The damage stats."
diff --git a/docs/classes/TakeDamageInfo/GetDamageType.md b/docs/classes/TakeDamageInfo/GetDamageType.md
index 055519b520..e1a4904265 100644
--- a/docs/classes/TakeDamageInfo/GetDamageType.md
+++ b/docs/classes/TakeDamageInfo/GetDamageType.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Gets the type of damage"
-
+ arguments:
+ - position: 1
+ name: "damageInfo"
+ type: DamageInfo
returns:
- type: integer
description: "The type of damage."
diff --git a/docs/classes/TakeDamageInfo/GetInflictor.md b/docs/classes/TakeDamageInfo/GetInflictor.md
index d9fefbd6f1..d46711ed41 100644
--- a/docs/classes/TakeDamageInfo/GetInflictor.md
+++ b/docs/classes/TakeDamageInfo/GetInflictor.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Gets the inflictor entity"
-
+ arguments:
+ - position: 1
+ name: "damageInfo"
+ type: DamageInfo
returns:
- type: Entity
description: "The inflictor entity."
diff --git a/docs/classes/TakeDamageInfo/GetMaxDamage.md b/docs/classes/TakeDamageInfo/GetMaxDamage.md
index 39db76b905..3ca0cac07e 100644
--- a/docs/classes/TakeDamageInfo/GetMaxDamage.md
+++ b/docs/classes/TakeDamageInfo/GetMaxDamage.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Gets the maximum damage"
-
+ arguments:
+ - position: 1
+ name: "damageInfo"
+ type: DamageInfo
returns:
- type: number
description: "The maximum damage."
diff --git a/docs/classes/TakeDamageInfo/GetReportedPosition.md b/docs/classes/TakeDamageInfo/GetReportedPosition.md
index eab3983b07..ee81ef6d34 100644
--- a/docs/classes/TakeDamageInfo/GetReportedPosition.md
+++ b/docs/classes/TakeDamageInfo/GetReportedPosition.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Gets the reported position of the damage"
-
+ arguments:
+ - position: 1
+ name: "damageInfo"
+ type: DamageInfo
returns:
- type: Vector
description: "The reported position of the damage."
diff --git a/docs/classes/TakeDamageInfo/GetWeapon.md b/docs/classes/TakeDamageInfo/GetWeapon.md
index ef83dd7937..9b51454d87 100644
--- a/docs/classes/TakeDamageInfo/GetWeapon.md
+++ b/docs/classes/TakeDamageInfo/GetWeapon.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Gets the weapon entity"
-
+ arguments:
+ - position: 1
+ name: "damageInfo"
+ type: DamageInfo
returns:
- type: Entity
description: "The weapon entity."
diff --git a/docs/classes/TakeDamageInfo/ScaleDamage.md b/docs/classes/TakeDamageInfo/ScaleDamage.md
index 867630e8da..174a7fd2e1 100644
--- a/docs/classes/TakeDamageInfo/ScaleDamage.md
+++ b/docs/classes/TakeDamageInfo/ScaleDamage.md
@@ -13,7 +13,13 @@ lua:
realm: shared
description: "Scales the damage"
-
+ arguments:
+ - position: 1
+ name: "damageInfo"
+ type: DamageInfo
+ - position: 2
+ name: "scale"
+ type: number
returns:
---
diff --git a/docs/classes/TakeDamageInfo/ScaleDamageForce.md b/docs/classes/TakeDamageInfo/ScaleDamageForce.md
index 86f0f26cc5..ff25713b43 100644
--- a/docs/classes/TakeDamageInfo/ScaleDamageForce.md
+++ b/docs/classes/TakeDamageInfo/ScaleDamageForce.md
@@ -13,7 +13,13 @@ lua:
realm: shared
description: "Scales the damage force"
-
+ arguments:
+ - position: 1
+ name: "damageInfo"
+ type: DamageInfo
+ - position: 2
+ name: "scale"
+ type: number
returns:
---
diff --git a/docs/classes/TakeDamageInfo/SetAmmoType.md b/docs/classes/TakeDamageInfo/SetAmmoType.md
index 72a83719b5..0b6d7b571c 100644
--- a/docs/classes/TakeDamageInfo/SetAmmoType.md
+++ b/docs/classes/TakeDamageInfo/SetAmmoType.md
@@ -13,7 +13,13 @@ lua:
realm: shared
description: "Sets the ammo type"
-
+ arguments:
+ - position: 1
+ name: "damageInfo"
+ type: DamageInfo
+ - position: 2
+ name: "ammoType"
+ type: number
returns:
---
diff --git a/docs/classes/TakeDamageInfo/SetAttacker.md b/docs/classes/TakeDamageInfo/SetAttacker.md
index 7f8f3b524d..29542794df 100644
--- a/docs/classes/TakeDamageInfo/SetAttacker.md
+++ b/docs/classes/TakeDamageInfo/SetAttacker.md
@@ -13,7 +13,13 @@ lua:
realm: shared
description: "Sets the attacker entity"
-
+ arguments:
+ - position: 1
+ name: "damageInfo"
+ type: DamageInfo
+ - position: 2
+ name: "attacker"
+ type: Entity
returns:
---
diff --git a/docs/classes/TakeDamageInfo/SetDamage.md b/docs/classes/TakeDamageInfo/SetDamage.md
index 8beda64cae..c1ade6d1fd 100644
--- a/docs/classes/TakeDamageInfo/SetDamage.md
+++ b/docs/classes/TakeDamageInfo/SetDamage.md
@@ -13,7 +13,13 @@ lua:
realm: shared
description: "Sets the damage"
-
+ arguments:
+ - position: 1
+ name: "damageInfo"
+ type: DamageInfo
+ - position: 2
+ name: "damage"
+ type: number
returns:
---
diff --git a/docs/classes/TakeDamageInfo/SetDamageCustom.md b/docs/classes/TakeDamageInfo/SetDamageCustom.md
index 442978a79e..d2967b34c5 100644
--- a/docs/classes/TakeDamageInfo/SetDamageCustom.md
+++ b/docs/classes/TakeDamageInfo/SetDamageCustom.md
@@ -13,7 +13,13 @@ lua:
realm: shared
description: "Sets custom damage"
-
+ arguments:
+ - position: 1
+ name: "damageInfo"
+ type: DamageInfo
+ - position: 2
+ name: "customDamage"
+ type: number
returns:
---
diff --git a/docs/classes/TakeDamageInfo/SetDamageForce.md b/docs/classes/TakeDamageInfo/SetDamageForce.md
index 61cb797fb5..dc7c48fed2 100644
--- a/docs/classes/TakeDamageInfo/SetDamageForce.md
+++ b/docs/classes/TakeDamageInfo/SetDamageForce.md
@@ -13,7 +13,13 @@ lua:
realm: shared
description: "Sets the force of the damage"
-
+ arguments:
+ - position: 1
+ name: "damageInfo"
+ type: DamageInfo
+ - position: 2
+ name: "force"
+ type: Vector
returns:
---
diff --git a/docs/classes/TakeDamageInfo/SetDamagePosition.md b/docs/classes/TakeDamageInfo/SetDamagePosition.md
index bc1d47f046..c73ea6c185 100644
--- a/docs/classes/TakeDamageInfo/SetDamagePosition.md
+++ b/docs/classes/TakeDamageInfo/SetDamagePosition.md
@@ -13,7 +13,13 @@ lua:
realm: shared
description: "Sets the position of the damage"
-
+ arguments:
+ - position: 1
+ name: "damageInfo"
+ type: DamageInfo
+ - position: 2
+ name: "position"
+ type: Vector
returns:
---
diff --git a/docs/classes/TakeDamageInfo/SetDamageStats.md b/docs/classes/TakeDamageInfo/SetDamageStats.md
index 61da8e331c..b8dabdbc28 100644
--- a/docs/classes/TakeDamageInfo/SetDamageStats.md
+++ b/docs/classes/TakeDamageInfo/SetDamageStats.md
@@ -13,7 +13,13 @@ lua:
realm: shared
description: "Sets damage stats"
-
+ arguments:
+ - position: 1
+ name: "damageInfo"
+ type: DamageInfo
+ - position: 2
+ name: "stats"
+ type: number
returns:
---
diff --git a/docs/classes/TakeDamageInfo/SetDamageType.md b/docs/classes/TakeDamageInfo/SetDamageType.md
index c5de8fe88f..a7cc63eea5 100644
--- a/docs/classes/TakeDamageInfo/SetDamageType.md
+++ b/docs/classes/TakeDamageInfo/SetDamageType.md
@@ -13,7 +13,13 @@ lua:
realm: shared
description: "Sets the type of damage"
-
+ arguments:
+ - position: 1
+ name: "damageInfo"
+ type: DamageInfo
+ - position: 2
+ name: "damageType"
+ type: number
returns:
---
diff --git a/docs/classes/TakeDamageInfo/SetInflictor.md b/docs/classes/TakeDamageInfo/SetInflictor.md
index 4bb04e8b0d..9f41e6aa71 100644
--- a/docs/classes/TakeDamageInfo/SetInflictor.md
+++ b/docs/classes/TakeDamageInfo/SetInflictor.md
@@ -13,7 +13,13 @@ lua:
realm: shared
description: "Sets the inflictor entity"
-
+ arguments:
+ - position: 1
+ name: "damageInfo"
+ type: DamageInfo
+ - position: 2
+ name: "inflictor"
+ type: Entity
returns:
---
diff --git a/docs/classes/TakeDamageInfo/SetMaxDamage.md b/docs/classes/TakeDamageInfo/SetMaxDamage.md
index 0296c864c6..6c774f20d6 100644
--- a/docs/classes/TakeDamageInfo/SetMaxDamage.md
+++ b/docs/classes/TakeDamageInfo/SetMaxDamage.md
@@ -13,7 +13,13 @@ lua:
realm: shared
description: "Sets the maximum damage"
-
+ arguments:
+ - position: 1
+ name: "damageInfo"
+ type: DamageInfo
+ - position: 2
+ name: "maxDamage"
+ type: number
returns:
---
diff --git a/docs/classes/TakeDamageInfo/SetReportedPosition.md b/docs/classes/TakeDamageInfo/SetReportedPosition.md
index f251ba370e..c7ec32a08e 100644
--- a/docs/classes/TakeDamageInfo/SetReportedPosition.md
+++ b/docs/classes/TakeDamageInfo/SetReportedPosition.md
@@ -13,7 +13,13 @@ lua:
realm: shared
description: "Sets the reported position of the damage"
-
+ arguments:
+ - position: 1
+ name: "damageInfo"
+ type: DamageInfo
+ - position: 2
+ name: "position"
+ type: Vector
returns:
---
diff --git a/docs/classes/TakeDamageInfo/SetWeapon.md b/docs/classes/TakeDamageInfo/SetWeapon.md
index 8ddb26b96a..f6655c593d 100644
--- a/docs/classes/TakeDamageInfo/SetWeapon.md
+++ b/docs/classes/TakeDamageInfo/SetWeapon.md
@@ -13,7 +13,13 @@ lua:
realm: shared
description: "Sets the weapon entity"
-
+ arguments:
+ - position: 1
+ name: "damageInfo"
+ type: DamageInfo
+ - position: 2
+ name: "weapon"
+ type: Entity
returns:
---
diff --git a/docs/classes/TakeDamageInfo/SubtractDamage.md b/docs/classes/TakeDamageInfo/SubtractDamage.md
index 371a681cec..c95b901574 100644
--- a/docs/classes/TakeDamageInfo/SubtractDamage.md
+++ b/docs/classes/TakeDamageInfo/SubtractDamage.md
@@ -13,7 +13,13 @@ lua:
realm: shared
description: "Subtracts damage"
-
+ arguments:
+ - position: 1
+ name: "damageInfo"
+ type: DamageInfo
+ - position: 2
+ name: "damage"
+ type: number
returns:
---
diff --git a/docs/classes/TakeDamageInfo/__tostring.md b/docs/classes/TakeDamageInfo/__tostring.md
index 5313715be8..9d19510a93 100644
--- a/docs/classes/TakeDamageInfo/__tostring.md
+++ b/docs/classes/TakeDamageInfo/__tostring.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Returns a string representation of the TakeDamageInfo instance"
-
+ arguments:
+ - position: 1
+ name: "damageInfo"
+ type: DamageInfo
returns:
- type: string
description: "The string representation of the TakeDamageInfo instance."
diff --git a/docs/classes/TextEntry/Backspace.md b/docs/classes/TextEntry/Backspace.md
index c9456245cd..6a902f8899 100644
--- a/docs/classes/TextEntry/Backspace.md
+++ b/docs/classes/TextEntry/Backspace.md
@@ -13,7 +13,10 @@ lua:
realm: client
description: "Deletes the character before the cursor"
-
+ arguments:
+ - position: 1
+ name: "textEntry"
+ type: TextEntry
returns:
---
diff --git a/docs/classes/TextEntry/Delete.md b/docs/classes/TextEntry/Delete.md
index 706bfdb676..31a0257bdf 100644
--- a/docs/classes/TextEntry/Delete.md
+++ b/docs/classes/TextEntry/Delete.md
@@ -13,7 +13,10 @@ lua:
realm: client
description: "Deletes the character after the cursor"
-
+ arguments:
+ - position: 1
+ name: "textEntry"
+ type: TextEntry
returns:
---
diff --git a/docs/classes/TextEntry/DeleteSelected.md b/docs/classes/TextEntry/DeleteSelected.md
index f9e4c51c79..384250ba5a 100644
--- a/docs/classes/TextEntry/DeleteSelected.md
+++ b/docs/classes/TextEntry/DeleteSelected.md
@@ -13,7 +13,10 @@ lua:
realm: client
description: "Deletes the selected text"
-
+ arguments:
+ - position: 1
+ name: "textEntry"
+ type: TextEntry
returns:
---
diff --git a/docs/classes/TextEntry/GetCursorPosition.md b/docs/classes/TextEntry/GetCursorPosition.md
index da8a25e4a2..8ffcc941fd 100644
--- a/docs/classes/TextEntry/GetCursorPosition.md
+++ b/docs/classes/TextEntry/GetCursorPosition.md
@@ -13,7 +13,10 @@ lua:
realm: client
description: "Gets the cursor position in the text entry"
-
+ arguments:
+ - position: 1
+ name: "textEntry"
+ type: TextEntry
returns:
- type: integer
description: "The cursor position"
diff --git a/docs/classes/TextEntry/GetDragPanel.md b/docs/classes/TextEntry/GetDragPanel.md
deleted file mode 100644
index a784a7aa57..0000000000
--- a/docs/classes/TextEntry/GetDragPanel.md
+++ /dev/null
@@ -1,24 +0,0 @@
----
-template: lua-class-function.html
-title: GetDragPanel
-icon: lua-client
-tags:
- - lua
- - client
- - needs-verification
- - needs-example
-lua:
- library: TextEntry
- function: GetDragPanel
- realm: client
- description: "Gets the drag panel"
-
-
- returns:
- - type: DragPanel
- description: "The drag panel instance"
----
-
-
-TextEntry:GetDragPanel – Gets the drag panel
-
diff --git a/docs/classes/TextEntry/GetDrawWidth.md b/docs/classes/TextEntry/GetDrawWidth.md
index d462a5ec16..1f47389b2b 100644
--- a/docs/classes/TextEntry/GetDrawWidth.md
+++ b/docs/classes/TextEntry/GetDrawWidth.md
@@ -13,7 +13,10 @@ lua:
realm: client
description: "Gets the draw width of the text entry"
-
+ arguments:
+ - position: 1
+ name: "textEntry"
+ type: TextEntry
returns:
- type: integer
description: "The draw width of the text entry"
diff --git a/docs/classes/TextEntry/GetMaximumCharacterCount.md b/docs/classes/TextEntry/GetMaximumCharacterCount.md
index 79b53f6060..7e87c84bd1 100644
--- a/docs/classes/TextEntry/GetMaximumCharacterCount.md
+++ b/docs/classes/TextEntry/GetMaximumCharacterCount.md
@@ -13,7 +13,10 @@ lua:
realm: client
description: "Gets the maximum character count"
-
+ arguments:
+ - position: 1
+ name: "textEntry"
+ type: TextEntry
returns:
- type: integer
description: "The maximum character count"
diff --git a/docs/classes/TextEntry/GetNumberOfLines.md b/docs/classes/TextEntry/GetNumberOfLines.md
index 1da45a724f..7360dbcf03 100644
--- a/docs/classes/TextEntry/GetNumberOfLines.md
+++ b/docs/classes/TextEntry/GetNumberOfLines.md
@@ -13,7 +13,10 @@ lua:
realm: client
description: "Gets the number of lines in the text entry"
-
+ arguments:
+ - position: 1
+ name: "textEntry"
+ type: TextEntry
returns:
- type: integer
description: "The number of lines in the text entry"
diff --git a/docs/classes/TextEntry/GetPanelBaseClassName.md b/docs/classes/TextEntry/GetPanelBaseClassName.md
deleted file mode 100644
index 02ac8b1023..0000000000
--- a/docs/classes/TextEntry/GetPanelBaseClassName.md
+++ /dev/null
@@ -1,25 +0,0 @@
----
-template: lua-class-function.html
-title: GetPanelBaseClassName
-icon: lua-client
-tags:
- - lua
- - client
- - needs-verification
- - needs-example
-lua:
- library: TextEntry
- function: GetPanelBaseClassName
- realm: client
- description: "Gets the base class name of the panel"
-
- static: true
-
- returns:
- - type: string
- description: "The base class name of the panel"
----
-
-
-_R.TextEntry.GetPanelBaseClassName – Gets the base class name of the panel
-
diff --git a/docs/classes/TextEntry/GetPanelClassName.md b/docs/classes/TextEntry/GetPanelClassName.md
deleted file mode 100644
index 1be35f80c6..0000000000
--- a/docs/classes/TextEntry/GetPanelClassName.md
+++ /dev/null
@@ -1,25 +0,0 @@
----
-template: lua-class-function.html
-title: GetPanelClassName
-icon: lua-client
-tags:
- - lua
- - client
- - needs-verification
- - needs-example
-lua:
- library: TextEntry
- function: GetPanelClassName
- realm: client
- description: "Gets the class name of the panel"
-
- static: true
-
- returns:
- - type: string
- description: "The class name of the panel"
----
-
-
-_R.TextEntry.GetPanelClassName – Gets the class name of the panel
-
diff --git a/docs/classes/TextEntry/GetText.md b/docs/classes/TextEntry/GetText.md
index 6178316c88..33b13cf790 100644
--- a/docs/classes/TextEntry/GetText.md
+++ b/docs/classes/TextEntry/GetText.md
@@ -13,7 +13,10 @@ lua:
realm: client
description: "Gets the text from the text entry"
-
+ arguments:
+ - position: 1
+ name: "textEntry"
+ type: TextEntry
returns:
- type: string
description: "The text from the text entry"
diff --git a/docs/classes/TextEntry/GetTextLength.md b/docs/classes/TextEntry/GetTextLength.md
index a4436dd667..c7478d40c7 100644
--- a/docs/classes/TextEntry/GetTextLength.md
+++ b/docs/classes/TextEntry/GetTextLength.md
@@ -13,7 +13,10 @@ lua:
realm: client
description: "Gets the length of the text in the text entry"
-
+ arguments:
+ - position: 1
+ name: "textEntry"
+ type: TextEntry
returns:
- type: integer
description: "The length of the text"
diff --git a/docs/classes/TextEntry/GetValue.md b/docs/classes/TextEntry/GetValue.md
index 5476725e9b..9949b01c3e 100644
--- a/docs/classes/TextEntry/GetValue.md
+++ b/docs/classes/TextEntry/GetValue.md
@@ -13,7 +13,10 @@ lua:
realm: client
description: "Gets the value from the text entry"
-
+ arguments:
+ - position: 1
+ name: "textEntry"
+ type: TextEntry
returns:
- type: string
description: "The value from the text entry"
diff --git a/docs/classes/TextEntry/GetValueAsFloat.md b/docs/classes/TextEntry/GetValueAsFloat.md
index d206bb91ab..699e41ce24 100644
--- a/docs/classes/TextEntry/GetValueAsFloat.md
+++ b/docs/classes/TextEntry/GetValueAsFloat.md
@@ -13,7 +13,10 @@ lua:
realm: client
description: "Gets the value from the text entry as a float"
-
+ arguments:
+ - position: 1
+ name: "textEntry"
+ type: TextEntry
returns:
- type: number
description: "The value as a float"
diff --git a/docs/classes/TextEntry/GetValueAsInteger.md b/docs/classes/TextEntry/GetValueAsInteger.md
index f9f7922cd8..3a0e6e19ee 100644
--- a/docs/classes/TextEntry/GetValueAsInteger.md
+++ b/docs/classes/TextEntry/GetValueAsInteger.md
@@ -13,7 +13,10 @@ lua:
realm: client
description: "Gets the value from the text entry as an integer"
-
+ arguments:
+ - position: 1
+ name: "textEntry"
+ type: TextEntry
returns:
- type: integer
description: "The value as an integer"
diff --git a/docs/classes/TextEntry/GotoDown.md b/docs/classes/TextEntry/GotoDown.md
index 5a41fee588..73ffe25c71 100644
--- a/docs/classes/TextEntry/GotoDown.md
+++ b/docs/classes/TextEntry/GotoDown.md
@@ -13,7 +13,10 @@ lua:
realm: client
description: "Moves the cursor down"
-
+ arguments:
+ - position: 1
+ name: "textEntry"
+ type: TextEntry
returns:
---
diff --git a/docs/classes/TextEntry/GotoEndOfLine.md b/docs/classes/TextEntry/GotoEndOfLine.md
index 32ad847f34..0ea9b89867 100644
--- a/docs/classes/TextEntry/GotoEndOfLine.md
+++ b/docs/classes/TextEntry/GotoEndOfLine.md
@@ -13,7 +13,10 @@ lua:
realm: client
description: "Moves the cursor to the end of the line"
-
+ arguments:
+ - position: 1
+ name: "textEntry"
+ type: TextEntry
returns:
---
diff --git a/docs/classes/TextEntry/GotoFirstOfLine.md b/docs/classes/TextEntry/GotoFirstOfLine.md
index 08792c749a..891e4099b8 100644
--- a/docs/classes/TextEntry/GotoFirstOfLine.md
+++ b/docs/classes/TextEntry/GotoFirstOfLine.md
@@ -13,7 +13,10 @@ lua:
realm: client
description: "Moves the cursor to the beginning of the line"
-
+ arguments:
+ - position: 1
+ name: "textEntry"
+ type: TextEntry
returns:
---
diff --git a/docs/classes/TextEntry/GotoLeft.md b/docs/classes/TextEntry/GotoLeft.md
index a7a2bae1bd..23e53447eb 100644
--- a/docs/classes/TextEntry/GotoLeft.md
+++ b/docs/classes/TextEntry/GotoLeft.md
@@ -13,7 +13,10 @@ lua:
realm: client
description: "Moves the cursor left"
-
+ arguments:
+ - position: 1
+ name: "textEntry"
+ type: TextEntry
returns:
---
diff --git a/docs/classes/TextEntry/GotoRight.md b/docs/classes/TextEntry/GotoRight.md
index 2623dbcacd..15b6ac980d 100644
--- a/docs/classes/TextEntry/GotoRight.md
+++ b/docs/classes/TextEntry/GotoRight.md
@@ -13,7 +13,10 @@ lua:
realm: client
description: "Moves the cursor right"
-
+ arguments:
+ - position: 1
+ name: "textEntry"
+ type: TextEntry
returns:
---
diff --git a/docs/classes/TextEntry/GotoTextEnd.md b/docs/classes/TextEntry/GotoTextEnd.md
index 213ce5613f..14d5695fa3 100644
--- a/docs/classes/TextEntry/GotoTextEnd.md
+++ b/docs/classes/TextEntry/GotoTextEnd.md
@@ -13,7 +13,10 @@ lua:
realm: client
description: "Moves the cursor to the end of the text"
-
+ arguments:
+ - position: 1
+ name: "textEntry"
+ type: TextEntry
returns:
---
diff --git a/docs/classes/TextEntry/GotoTextStart.md b/docs/classes/TextEntry/GotoTextStart.md
index 63a595a2d4..a2987a36ea 100644
--- a/docs/classes/TextEntry/GotoTextStart.md
+++ b/docs/classes/TextEntry/GotoTextStart.md
@@ -13,7 +13,10 @@ lua:
realm: client
description: "Moves the cursor to the start of the text"
-
+ arguments:
+ - position: 1
+ name: "textEntry"
+ type: TextEntry
returns:
---
diff --git a/docs/classes/TextEntry/GotoUp.md b/docs/classes/TextEntry/GotoUp.md
index d9ccde8d40..5e709f3ac4 100644
--- a/docs/classes/TextEntry/GotoUp.md
+++ b/docs/classes/TextEntry/GotoUp.md
@@ -13,7 +13,10 @@ lua:
realm: client
description: "Moves the cursor up"
-
+ arguments:
+ - position: 1
+ name: "textEntry"
+ type: TextEntry
returns:
---
diff --git a/docs/classes/TextEntry/GotoWordLeft.md b/docs/classes/TextEntry/GotoWordLeft.md
index d2de6b7d0b..45d7e85556 100644
--- a/docs/classes/TextEntry/GotoWordLeft.md
+++ b/docs/classes/TextEntry/GotoWordLeft.md
@@ -13,7 +13,10 @@ lua:
realm: client
description: "Moves the cursor to the previous word on the left"
-
+ arguments:
+ - position: 1
+ name: "textEntry"
+ type: TextEntry
returns:
---
diff --git a/docs/classes/TextEntry/GotoWordRight.md b/docs/classes/TextEntry/GotoWordRight.md
index 66b3c75602..8d392c1198 100644
--- a/docs/classes/TextEntry/GotoWordRight.md
+++ b/docs/classes/TextEntry/GotoWordRight.md
@@ -13,7 +13,10 @@ lua:
realm: client
description: "Moves the cursor to the next word on the right"
-
+ arguments:
+ - position: 1
+ name: "textEntry"
+ type: TextEntry
returns:
---
diff --git a/docs/classes/TextEntry/InsertString.md b/docs/classes/TextEntry/InsertString.md
index 24a166d88c..335c936ae2 100644
--- a/docs/classes/TextEntry/InsertString.md
+++ b/docs/classes/TextEntry/InsertString.md
@@ -14,8 +14,12 @@ lua:
description: "Inserts a string at the cursor position"
arguments:
- - name: "str"
- type: string
+ - position: 1
+ name: "textEntry"
+ type: TextEntry
+ - position: 2
+ name: "str"
+ type: string
returns:
---
diff --git a/docs/classes/TextEntry/IsDroppable.md b/docs/classes/TextEntry/IsDroppable.md
index 5a30c2e929..ba6d63166b 100644
--- a/docs/classes/TextEntry/IsDroppable.md
+++ b/docs/classes/TextEntry/IsDroppable.md
@@ -13,7 +13,10 @@ lua:
realm: client
description: "Checks if the text entry is droppable"
-
+ arguments:
+ - position: 1
+ name: "textEntry"
+ type: TextEntry
returns:
- type: boolean
description: "Whether the text entry is droppable"
diff --git a/docs/classes/TextEntry/IsEditable.md b/docs/classes/TextEntry/IsEditable.md
index 713a48c633..4a859887f0 100644
--- a/docs/classes/TextEntry/IsEditable.md
+++ b/docs/classes/TextEntry/IsEditable.md
@@ -13,7 +13,10 @@ lua:
realm: client
description: "Checks if the text entry is editable"
-
+ arguments:
+ - position: 1
+ name: "textEntry"
+ type: TextEntry
returns:
- type: boolean
description: "Whether the text entry is editable"
diff --git a/docs/classes/TextEntry/IsMultiline.md b/docs/classes/TextEntry/IsMultiline.md
index eddbd1fcf2..31fc3ef976 100644
--- a/docs/classes/TextEntry/IsMultiline.md
+++ b/docs/classes/TextEntry/IsMultiline.md
@@ -13,7 +13,10 @@ lua:
realm: client
description: "Checks if the text entry is multiline"
-
+ arguments:
+ - position: 1
+ name: "textEntry"
+ type: TextEntry
returns:
- type: boolean
description: "Whether the text entry is multiline"
diff --git a/docs/classes/TextEntry/IsTextFullySelected.md b/docs/classes/TextEntry/IsTextFullySelected.md
index 091c7200a5..4d92793443 100644
--- a/docs/classes/TextEntry/IsTextFullySelected.md
+++ b/docs/classes/TextEntry/IsTextFullySelected.md
@@ -13,7 +13,10 @@ lua:
realm: client
description: "Checks if the text is fully selected"
-
+ arguments:
+ - position: 1
+ name: "textEntry"
+ type: TextEntry
returns:
- type: boolean
description: "Whether the text is fully selected"
diff --git a/docs/classes/TextEntry/LayoutVerticalScrollBarSlider.md b/docs/classes/TextEntry/LayoutVerticalScrollBarSlider.md
index a9d923840f..24e28ce821 100644
--- a/docs/classes/TextEntry/LayoutVerticalScrollBarSlider.md
+++ b/docs/classes/TextEntry/LayoutVerticalScrollBarSlider.md
@@ -13,7 +13,10 @@ lua:
realm: client
description: "Layouts the vertical scrollbar slider"
-
+ arguments:
+ - position: 1
+ name: "textEntry"
+ type: TextEntry
returns:
---
diff --git a/docs/classes/TextEntry/MoveCursor.md b/docs/classes/TextEntry/MoveCursor.md
index 4cff89b88b..f66e6dbbe9 100644
--- a/docs/classes/TextEntry/MoveCursor.md
+++ b/docs/classes/TextEntry/MoveCursor.md
@@ -14,10 +14,15 @@ lua:
description: "Moves the cursor by a given offset"
arguments:
- - name: "offsetX"
- type: number
- - name: "offsetY"
- type: number
+ - position: 1
+ name: "textEntry"
+ type: TextEntry
+ - position: 2
+ name: "offsetX"
+ type: number
+ - position: 3
+ name: "offsetY"
+ type: number
returns:
---
diff --git a/docs/classes/TextEntry/OnCreateDragData.md b/docs/classes/TextEntry/OnCreateDragData.md
index b335d3fc8e..ea2fef95b6 100644
--- a/docs/classes/TextEntry/OnCreateDragData.md
+++ b/docs/classes/TextEntry/OnCreateDragData.md
@@ -14,8 +14,12 @@ lua:
description: "Creates drag data for the text entry"
arguments:
- - name: "dragData"
- type: KeyValuesHandle
+ - position: 1
+ name: "textEntry"
+ type: TextEntry
+ - position: 2
+ name: "dragData"
+ type: KeyValuesHandle
returns:
---
diff --git a/docs/classes/TextEntry/OnPanelDropped.md b/docs/classes/TextEntry/OnPanelDropped.md
index f519853081..f2ed2ebceb 100644
--- a/docs/classes/TextEntry/OnPanelDropped.md
+++ b/docs/classes/TextEntry/OnPanelDropped.md
@@ -13,7 +13,10 @@ lua:
realm: client
description: "Handles the event when a panel is dropped"
-
+ arguments:
+ - position: 1
+ name: "textEntry"
+ type: TextEntry
returns:
---
diff --git a/docs/classes/TextEntry/OpenEditMenu.md b/docs/classes/TextEntry/OpenEditMenu.md
index 67719e31cb..52c52c43ca 100644
--- a/docs/classes/TextEntry/OpenEditMenu.md
+++ b/docs/classes/TextEntry/OpenEditMenu.md
@@ -13,7 +13,10 @@ lua:
realm: client
description: "Opens the edit menu for the text entry"
-
+ arguments:
+ - position: 1
+ name: "textEntry"
+ type: TextEntry
returns:
---
diff --git a/docs/classes/TextEntry/PaintText.md b/docs/classes/TextEntry/PaintText.md
index 6dcae31fea..6e6c717741 100644
--- a/docs/classes/TextEntry/PaintText.md
+++ b/docs/classes/TextEntry/PaintText.md
@@ -14,12 +14,18 @@ lua:
description: "Paints the text with specified colors"
arguments:
- - name: "color1"
- type: Color
- - name: "color2"
- type: Color
- - name: "color3"
- type: Color
+ - position: 1
+ name: "textEntry"
+ type: TextEntry
+ - position: 2
+ name: "color1"
+ type: Color
+ - position: 3
+ name: "color2"
+ type: Color
+ - position: 4
+ name: "color3"
+ type: Color
returns:
---
diff --git a/docs/classes/TextEntry/RecalculateLineBreaks.md b/docs/classes/TextEntry/RecalculateLineBreaks.md
index c6b2568ed2..9968ffe647 100644
--- a/docs/classes/TextEntry/RecalculateLineBreaks.md
+++ b/docs/classes/TextEntry/RecalculateLineBreaks.md
@@ -13,7 +13,10 @@ lua:
realm: client
description: "Recalculates the line breaks in the text entry"
-
+ arguments:
+ - position: 1
+ name: "textEntry"
+ type: TextEntry
returns:
---
diff --git a/docs/classes/TextEntry/RequestInfo.md b/docs/classes/TextEntry/RequestInfo.md
deleted file mode 100644
index 820583ffb4..0000000000
--- a/docs/classes/TextEntry/RequestInfo.md
+++ /dev/null
@@ -1,26 +0,0 @@
----
-template: lua-class-function.html
-title: RequestInfo
-icon: lua-client
-tags:
- - lua
- - client
- - needs-verification
- - needs-example
-lua:
- library: TextEntry
- function: RequestInfo
- realm: client
- description: "Requests info from the text entry"
-
- arguments:
- - name: "outputData"
- type: KeyValuesHandle
- returns:
- - type: boolean
- description: "Whether info was successfully requested"
----
-
-
-TextEntry:RequestInfo – Requests info from the text entry
-
diff --git a/docs/classes/TextEntry/SaveUndoState.md b/docs/classes/TextEntry/SaveUndoState.md
index dc23d63cc5..028ee72db1 100644
--- a/docs/classes/TextEntry/SaveUndoState.md
+++ b/docs/classes/TextEntry/SaveUndoState.md
@@ -13,7 +13,10 @@ lua:
realm: client
description: "Saves the current state for undo"
-
+ arguments:
+ - position: 1
+ name: "textEntry"
+ type: TextEntry
returns:
---
diff --git a/docs/classes/TextEntry/SelectAllOnFocusAlways.md b/docs/classes/TextEntry/SelectAllOnFocusAlways.md
index 8281dc9d83..e3efe9f85c 100644
--- a/docs/classes/TextEntry/SelectAllOnFocusAlways.md
+++ b/docs/classes/TextEntry/SelectAllOnFocusAlways.md
@@ -14,8 +14,12 @@ lua:
description: "Sets whether to always select all text on focus"
arguments:
- - name: "selectAll"
- type: boolean
+ - position: 1
+ name: "textEntry"
+ type: TextEntry
+ - position: 2
+ name: "selectAll"
+ type: boolean
returns:
---
diff --git a/docs/classes/TextEntry/SelectAllText.md b/docs/classes/TextEntry/SelectAllText.md
index 337638d5fd..a858b2d99b 100644
--- a/docs/classes/TextEntry/SelectAllText.md
+++ b/docs/classes/TextEntry/SelectAllText.md
@@ -14,8 +14,12 @@ lua:
description: "Selects all text in the text entry"
arguments:
- - name: "selectAll"
- type: boolean
+ - position: 1
+ name: "textEntry"
+ type: TextEntry
+ - position: 2
+ name: "selectAll"
+ type: boolean
returns:
---
diff --git a/docs/classes/TextEntry/SelectNone.md b/docs/classes/TextEntry/SelectNone.md
index 711ed51e08..a34e3c6573 100644
--- a/docs/classes/TextEntry/SelectNone.md
+++ b/docs/classes/TextEntry/SelectNone.md
@@ -13,7 +13,10 @@ lua:
realm: client
description: "Deselects any selected text"
-
+ arguments:
+ - position: 1
+ name: "textEntry"
+ type: TextEntry
returns:
---
diff --git a/docs/classes/TextEntry/SendNewLine.md b/docs/classes/TextEntry/SendNewLine.md
index 14795206ef..d6e6e48c1e 100644
--- a/docs/classes/TextEntry/SendNewLine.md
+++ b/docs/classes/TextEntry/SendNewLine.md
@@ -14,8 +14,12 @@ lua:
description: "Sets whether a new line is sent when enter is pressed"
arguments:
- - name: "sendNewLine"
- type: boolean
+ - position: 1
+ name: "textEntry"
+ type: TextEntry
+ - position: 2
+ name: "sendNewLine"
+ type: boolean
returns:
---
diff --git a/docs/classes/TextEntry/SetAllowNonAsciiCharacters.md b/docs/classes/TextEntry/SetAllowNonAsciiCharacters.md
index 425db977e5..bf9c243375 100644
--- a/docs/classes/TextEntry/SetAllowNonAsciiCharacters.md
+++ b/docs/classes/TextEntry/SetAllowNonAsciiCharacters.md
@@ -14,8 +14,12 @@ lua:
description: "Sets whether non-ASCII characters are allowed"
arguments:
- - name: "allow"
- type: boolean
+ - position: 1
+ name: "textEntry"
+ type: TextEntry
+ - position: 2
+ name: "allow"
+ type: boolean
returns:
---
diff --git a/docs/classes/TextEntry/SetAllowNumericInputOnly.md b/docs/classes/TextEntry/SetAllowNumericInputOnly.md
index fed5a71ecf..89a3c92f85 100644
--- a/docs/classes/TextEntry/SetAllowNumericInputOnly.md
+++ b/docs/classes/TextEntry/SetAllowNumericInputOnly.md
@@ -14,8 +14,12 @@ lua:
description: "Sets whether only numeric input is allowed"
arguments:
- - name: "allow"
- type: boolean
+ - position: 1
+ name: "textEntry"
+ type: TextEntry
+ - position: 2
+ name: "allow"
+ type: boolean
returns:
---
diff --git a/docs/classes/TextEntry/SetAutoProgressOnHittingCharLimit.md b/docs/classes/TextEntry/SetAutoProgressOnHittingCharLimit.md
index e04c32c8ac..4bab20d56a 100644
--- a/docs/classes/TextEntry/SetAutoProgressOnHittingCharLimit.md
+++ b/docs/classes/TextEntry/SetAutoProgressOnHittingCharLimit.md
@@ -14,8 +14,12 @@ lua:
description: "Sets auto-progress on hitting character limit"
arguments:
- - name: "autoProgress"
- type: boolean
+ - position: 1
+ name: "textEntry"
+ type: TextEntry
+ - position: 2
+ name: "autoProgress"
+ type: boolean
returns:
---
diff --git a/docs/classes/TextEntry/SetCatchEnterKey.md b/docs/classes/TextEntry/SetCatchEnterKey.md
index 040586548f..6feb131391 100644
--- a/docs/classes/TextEntry/SetCatchEnterKey.md
+++ b/docs/classes/TextEntry/SetCatchEnterKey.md
@@ -14,8 +14,12 @@ lua:
description: "Sets whether the enter key is caught by the text entry"
arguments:
- - name: "catchEnter"
- type: boolean
+ - position: 1
+ name: "textEntry"
+ type: TextEntry
+ - position: 2
+ name: "catchEnter"
+ type: boolean
returns:
---
diff --git a/docs/classes/TextEntry/SetCursorPosition.md b/docs/classes/TextEntry/SetCursorPosition.md
index 969246bd83..b5c3499f6d 100644
--- a/docs/classes/TextEntry/SetCursorPosition.md
+++ b/docs/classes/TextEntry/SetCursorPosition.md
@@ -14,8 +14,12 @@ lua:
description: "Sets the cursor position in the text entry"
arguments:
- - name: "position"
- type: number
+ - position: 1
+ name: "textEntry"
+ type: TextEntry
+ - position: 2
+ name: "position"
+ type: number
returns:
---
diff --git a/docs/classes/TextEntry/SetDisabledBgColor.md b/docs/classes/TextEntry/SetDisabledBgColor.md
index d6372fe466..656cd824af 100644
--- a/docs/classes/TextEntry/SetDisabledBgColor.md
+++ b/docs/classes/TextEntry/SetDisabledBgColor.md
@@ -14,8 +14,12 @@ lua:
description: "Sets the background color when disabled"
arguments:
- - name: "color"
- type: Color
+ - position: 1
+ name: "textEntry"
+ type: TextEntry
+ - position: 2
+ name: "color"
+ type: Color
returns:
---
diff --git a/docs/classes/TextEntry/SetDrawLanguageIdAtLeft.md b/docs/classes/TextEntry/SetDrawLanguageIdAtLeft.md
index 27afaf73d5..e591e1e94a 100644
--- a/docs/classes/TextEntry/SetDrawLanguageIdAtLeft.md
+++ b/docs/classes/TextEntry/SetDrawLanguageIdAtLeft.md
@@ -14,8 +14,12 @@ lua:
description: "Sets whether the language ID is drawn on the left"
arguments:
- - name: "draw"
- type: boolean
+ - position: 1
+ name: "textEntry"
+ type: TextEntry
+ - position: 2
+ name: "draw"
+ type: boolean
returns:
---
diff --git a/docs/classes/TextEntry/SetDrawWidth.md b/docs/classes/TextEntry/SetDrawWidth.md
index 2cc3b55143..56cfb7e8e0 100644
--- a/docs/classes/TextEntry/SetDrawWidth.md
+++ b/docs/classes/TextEntry/SetDrawWidth.md
@@ -14,8 +14,12 @@ lua:
description: "Sets the draw width of the text entry"
arguments:
- - name: "width"
- type: number
+ - position: 1
+ name: "textEntry"
+ type: TextEntry
+ - position: 2
+ name: "width"
+ type: number
returns:
---
diff --git a/docs/classes/TextEntry/SetEditable.md b/docs/classes/TextEntry/SetEditable.md
index 05090da260..41e9ddcb56 100644
--- a/docs/classes/TextEntry/SetEditable.md
+++ b/docs/classes/TextEntry/SetEditable.md
@@ -14,8 +14,12 @@ lua:
description: "Sets whether the text entry is editable"
arguments:
- - name: "editable"
- type: boolean
+ - position: 1
+ name: "textEntry"
+ type: TextEntry
+ - position: 2
+ name: "editable"
+ type: boolean
returns:
---
diff --git a/docs/classes/TextEntry/SetEnabled.md b/docs/classes/TextEntry/SetEnabled.md
deleted file mode 100644
index cc85e34df5..0000000000
--- a/docs/classes/TextEntry/SetEnabled.md
+++ /dev/null
@@ -1,25 +0,0 @@
----
-template: lua-class-function.html
-title: SetEnabled
-icon: lua-client
-tags:
- - lua
- - client
- - needs-verification
- - needs-example
-lua:
- library: TextEntry
- function: SetEnabled
- realm: client
- description: "Sets whether the text entry is enabled"
-
- arguments:
- - name: "enabled"
- type: boolean
- returns:
-
----
-
-
-TextEntry:SetEnabled – Sets whether the text entry is enabled
-
diff --git a/docs/classes/TextEntry/SetFont.md b/docs/classes/TextEntry/SetFont.md
index 064c735089..6dcbed82f8 100644
--- a/docs/classes/TextEntry/SetFont.md
+++ b/docs/classes/TextEntry/SetFont.md
@@ -14,8 +14,12 @@ lua:
description: "Sets the font for the text entry"
arguments:
- - name: "font"
- type: FontHandle
+ - position: 1
+ name: "textEntry"
+ type: TextEntry
+ - position: 2
+ name: "font"
+ type: FontHandle
returns:
---
diff --git a/docs/classes/TextEntry/SetHorizontalScrolling.md b/docs/classes/TextEntry/SetHorizontalScrolling.md
index 7a2983219a..92e940fa71 100644
--- a/docs/classes/TextEntry/SetHorizontalScrolling.md
+++ b/docs/classes/TextEntry/SetHorizontalScrolling.md
@@ -14,8 +14,12 @@ lua:
description: "Sets whether horizontal scrolling is enabled"
arguments:
- - name: "enable"
- type: boolean
+ - position: 1
+ name: "textEntry"
+ type: TextEntry
+ - position: 2
+ name: "enable"
+ type: boolean
returns:
---
diff --git a/docs/classes/TextEntry/SetMaximumCharacterCount.md b/docs/classes/TextEntry/SetMaximumCharacterCount.md
index 3ee3d74012..407bbeff1d 100644
--- a/docs/classes/TextEntry/SetMaximumCharacterCount.md
+++ b/docs/classes/TextEntry/SetMaximumCharacterCount.md
@@ -14,8 +14,12 @@ lua:
description: "Sets the maximum character count"
arguments:
- - name: "maxCount"
- type: number
+ - position: 1
+ name: "textEntry"
+ type: TextEntry
+ - position: 2
+ name: "maxCount"
+ type: number
returns:
---
diff --git a/docs/classes/TextEntry/SetMultiline.md b/docs/classes/TextEntry/SetMultiline.md
index b7214f019f..e549183a47 100644
--- a/docs/classes/TextEntry/SetMultiline.md
+++ b/docs/classes/TextEntry/SetMultiline.md
@@ -14,8 +14,12 @@ lua:
description: "Sets whether the text entry is multiline"
arguments:
- - name: "multiline"
- type: boolean
+ - position: 1
+ name: "textEntry"
+ type: TextEntry
+ - position: 2
+ name: "multiline"
+ type: boolean
returns:
---
diff --git a/docs/classes/TextEntry/SetSelectionBackgroundColor.md b/docs/classes/TextEntry/SetSelectionBackgroundColor.md
index 62092c416a..86b6cde942 100644
--- a/docs/classes/TextEntry/SetSelectionBackgroundColor.md
+++ b/docs/classes/TextEntry/SetSelectionBackgroundColor.md
@@ -14,8 +14,12 @@ lua:
description: "Sets the background color for selected text"
arguments:
- - name: "color"
- type: Color
+ - position: 1
+ name: "textEntry"
+ type: TextEntry
+ - position: 2
+ name: "color"
+ type: Color
returns:
---
diff --git a/docs/classes/TextEntry/SetSelectionTextColor.md b/docs/classes/TextEntry/SetSelectionTextColor.md
index d769c2801d..ca3d5b5be6 100644
--- a/docs/classes/TextEntry/SetSelectionTextColor.md
+++ b/docs/classes/TextEntry/SetSelectionTextColor.md
@@ -14,8 +14,12 @@ lua:
description: "Sets the text color for selected text"
arguments:
- - name: "color"
- type: Color
+ - position: 1
+ name: "textEntry"
+ type: TextEntry
+ - position: 2
+ name: "color"
+ type: Color
returns:
---
diff --git a/docs/classes/TextEntry/SetSelectionUnfocusedBackgroundColor.md b/docs/classes/TextEntry/SetSelectionUnfocusedBackgroundColor.md
index ef1dd9aec8..1251c51a37 100644
--- a/docs/classes/TextEntry/SetSelectionUnfocusedBackgroundColor.md
+++ b/docs/classes/TextEntry/SetSelectionUnfocusedBackgroundColor.md
@@ -14,8 +14,12 @@ lua:
description: "Sets the background color for unfocused selected text"
arguments:
- - name: "color"
- type: Color
+ - position: 1
+ name: "textEntry"
+ type: TextEntry
+ - position: 2
+ name: "color"
+ type: Color
returns:
---
diff --git a/docs/classes/TextEntry/SetText.md b/docs/classes/TextEntry/SetText.md
index 661bc4fcfd..d7edfa93ff 100644
--- a/docs/classes/TextEntry/SetText.md
+++ b/docs/classes/TextEntry/SetText.md
@@ -14,8 +14,12 @@ lua:
description: "Sets the text of the text entry"
arguments:
- - name: "text"
- type: string
+ - position: 1
+ name: "textEntry"
+ type: TextEntry
+ - position: 2
+ name: "text"
+ type: string
returns:
---
diff --git a/docs/classes/TextEntry/SetTextHidden.md b/docs/classes/TextEntry/SetTextHidden.md
index 30ddaeccc0..3b061382aa 100644
--- a/docs/classes/TextEntry/SetTextHidden.md
+++ b/docs/classes/TextEntry/SetTextHidden.md
@@ -14,8 +14,12 @@ lua:
description: "Sets whether the text is hidden"
arguments:
- - name: "hidden"
- type: boolean
+ - position: 1
+ name: "textEntry"
+ type: TextEntry
+ - position: 2
+ name: "hidden"
+ type: boolean
returns:
---
diff --git a/docs/classes/TextEntry/SetToFullHeight.md b/docs/classes/TextEntry/SetToFullHeight.md
index 860822bf35..68828e5e3d 100644
--- a/docs/classes/TextEntry/SetToFullHeight.md
+++ b/docs/classes/TextEntry/SetToFullHeight.md
@@ -13,7 +13,10 @@ lua:
realm: client
description: "Sets the text entry to full height"
-
+ arguments:
+ - position: 1
+ name: "textEntry"
+ type: TextEntry
returns:
---
diff --git a/docs/classes/TextEntry/SetToFullWidth.md b/docs/classes/TextEntry/SetToFullWidth.md
index 7b33829c10..1812529840 100644
--- a/docs/classes/TextEntry/SetToFullWidth.md
+++ b/docs/classes/TextEntry/SetToFullWidth.md
@@ -13,7 +13,10 @@ lua:
realm: client
description: "Sets the text entry to full width"
-
+ arguments:
+ - position: 1
+ name: "textEntry"
+ type: TextEntry
returns:
---
diff --git a/docs/classes/TextEntry/SetUseFallbackFont.md b/docs/classes/TextEntry/SetUseFallbackFont.md
index 2ee753824a..6093b4fd32 100644
--- a/docs/classes/TextEntry/SetUseFallbackFont.md
+++ b/docs/classes/TextEntry/SetUseFallbackFont.md
@@ -14,10 +14,15 @@ lua:
description: "Sets the fallback font for the text entry"
arguments:
- - name: "useFallback"
- type: boolean
- - name: "fallbackFont"
- type: FontHandle
+ - position: 1
+ name: "textEntry"
+ type: TextEntry
+ - position: 2
+ name: "useFallback"
+ type: boolean
+ - position: 3
+ name: "fallbackFont"
+ type: FontHandle
returns:
---
diff --git a/docs/classes/TextEntry/SetVerticalScrollbar.md b/docs/classes/TextEntry/SetVerticalScrollbar.md
index 9d64df0efa..f5a560735a 100644
--- a/docs/classes/TextEntry/SetVerticalScrollbar.md
+++ b/docs/classes/TextEntry/SetVerticalScrollbar.md
@@ -14,8 +14,12 @@ lua:
description: "Sets whether the vertical scrollbar is enabled"
arguments:
- - name: "enable"
- type: boolean
+ - position: 1
+ name: "textEntry"
+ type: TextEntry
+ - position: 2
+ name: "enable"
+ type: boolean
returns:
---
diff --git a/docs/classes/TextEntry/SetWrap.md b/docs/classes/TextEntry/SetWrap.md
index fb206a2c9e..5e031b84a5 100644
--- a/docs/classes/TextEntry/SetWrap.md
+++ b/docs/classes/TextEntry/SetWrap.md
@@ -14,8 +14,12 @@ lua:
description: "Sets whether text wrapping is enabled"
arguments:
- - name: "wrap"
- type: boolean
+ - position: 1
+ name: "textEntry"
+ type: TextEntry
+ - position: 2
+ name: "wrap"
+ type: boolean
returns:
---
diff --git a/docs/classes/TextEntry/Undo.md b/docs/classes/TextEntry/Undo.md
index f06cd9243b..0ad241867f 100644
--- a/docs/classes/TextEntry/Undo.md
+++ b/docs/classes/TextEntry/Undo.md
@@ -13,7 +13,10 @@ lua:
realm: client
description: "Undoes the last action"
-
+ arguments:
+ - position: 1
+ name: "textEntry"
+ type: TextEntry
returns:
---
diff --git a/docs/classes/TextEntry/__eq.md b/docs/classes/TextEntry/__eq.md
index 0c3826c26d..7155f96c41 100644
--- a/docs/classes/TextEntry/__eq.md
+++ b/docs/classes/TextEntry/__eq.md
@@ -13,7 +13,13 @@ lua:
realm: client
description: "Metamethod called when two TextEntry objects are compared"
-
+ arguments:
+ - position: 1
+ name: "textEntry"
+ type: TextEntry
+ - position: 2
+ name: "other"
+ type: TextEntry
returns:
- type: boolean
description: "Whether the TextEntry objects are equal"
diff --git a/docs/classes/TextEntry/__index.md b/docs/classes/TextEntry/__index.md
index c1536b65d1..b2e7229ada 100644
--- a/docs/classes/TextEntry/__index.md
+++ b/docs/classes/TextEntry/__index.md
@@ -14,8 +14,12 @@ lua:
description: "Metamethod called when a non-existent field is indexed"
arguments:
- - name: "field"
- type: string
+ - position: 1
+ name: "textEntry"
+ type: TextEntry
+ - position: 2
+ name: "field"
+ type: string
returns:
- type: any
description: "The value of the field"
diff --git a/docs/classes/TextEntry/__newindex.md b/docs/classes/TextEntry/__newindex.md
index 84338a16db..59820ebdf9 100644
--- a/docs/classes/TextEntry/__newindex.md
+++ b/docs/classes/TextEntry/__newindex.md
@@ -14,8 +14,12 @@ lua:
description: "Metamethod called when a new field is added"
arguments:
- - name: "field"
- type: string
+ - position: 1
+ name: "textEntry"
+ type: TextEntry
+ - position: 2
+ name: "field"
+ type: string
returns:
---
diff --git a/docs/classes/TextEntry/__tostring.md b/docs/classes/TextEntry/__tostring.md
index 4fa7ac5728..666db43747 100644
--- a/docs/classes/TextEntry/__tostring.md
+++ b/docs/classes/TextEntry/__tostring.md
@@ -13,7 +13,10 @@ lua:
realm: client
description: "Metamethod called when the TextEntry object is converted to a string"
-
+ arguments:
+ - position: 1
+ name: "textEntry"
+ type: TextEntry
returns:
- type: string
description: "The string representation of the TextEntry object"
diff --git a/docs/classes/Texture/Download.md b/docs/classes/Texture/Download.md
index dab49137bc..f07e46b18a 100644
--- a/docs/classes/Texture/Download.md
+++ b/docs/classes/Texture/Download.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Downloads the texture into the material system."
-
+ arguments:
+ - position: 1
+ name: "texture"
+ type: Texture
returns:
---
diff --git a/docs/classes/Texture/GetActualHeight.md b/docs/classes/Texture/GetActualHeight.md
index 1b2a197901..2fec7dcbea 100644
--- a/docs/classes/Texture/GetActualHeight.md
+++ b/docs/classes/Texture/GetActualHeight.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Gets the actual height of the texture."
-
+ arguments:
+ - position: 1
+ name: "texture"
+ type: Texture
returns:
- type: integer
description: "The actual height of the texture."
diff --git a/docs/classes/Texture/GetActualWidth.md b/docs/classes/Texture/GetActualWidth.md
index 381a20932d..714b734d74 100644
--- a/docs/classes/Texture/GetActualWidth.md
+++ b/docs/classes/Texture/GetActualWidth.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Gets the actual width of the texture."
-
+ arguments:
+ - position: 1
+ name: "texture"
+ type: Texture
returns:
- type: integer
description: "The actual width of the texture."
diff --git a/docs/classes/Texture/GetMappingHeight.md b/docs/classes/Texture/GetMappingHeight.md
index 32d07a1945..2043273ed1 100644
--- a/docs/classes/Texture/GetMappingHeight.md
+++ b/docs/classes/Texture/GetMappingHeight.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Gets the mapping height of the texture."
-
+ arguments:
+ - position: 1
+ name: "texture"
+ type: Texture
returns:
- type: integer
description: "The mapping height of the texture."
diff --git a/docs/classes/Texture/GetMappingWidth.md b/docs/classes/Texture/GetMappingWidth.md
index f8b0cf3bdb..6a200e199e 100644
--- a/docs/classes/Texture/GetMappingWidth.md
+++ b/docs/classes/Texture/GetMappingWidth.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Gets the mapping width of the texture."
-
+ arguments:
+ - position: 1
+ name: "texture"
+ type: Texture
returns:
- type: integer
description: "The mapping width of the texture."
diff --git a/docs/classes/Texture/GetName.md b/docs/classes/Texture/GetName.md
index 96ee9113a5..2b2f28b888 100644
--- a/docs/classes/Texture/GetName.md
+++ b/docs/classes/Texture/GetName.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Gets the name of the texture."
-
+ arguments:
+ - position: 1
+ name: "texture"
+ type: Texture
returns:
- type: string
description: "The name of the texture."
diff --git a/docs/classes/Texture/GetNumAnimationFrames.md b/docs/classes/Texture/GetNumAnimationFrames.md
index 8fa4a50d07..350c4f0e45 100644
--- a/docs/classes/Texture/GetNumAnimationFrames.md
+++ b/docs/classes/Texture/GetNumAnimationFrames.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Gets the number of animation frames of the texture."
-
+ arguments:
+ - position: 1
+ name: "texture"
+ type: Texture
returns:
- type: integer
description: "The number of animation frames of the texture."
diff --git a/docs/classes/Texture/IsError.md b/docs/classes/Texture/IsError.md
index e67fc2762f..703d9de53e 100644
--- a/docs/classes/Texture/IsError.md
+++ b/docs/classes/Texture/IsError.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Checks if the texture is in an error state."
-
+ arguments:
+ - position: 1
+ name: "texture"
+ type: Texture
returns:
- type: boolean
description: "true if the texture is in an error state, false otherwise."
diff --git a/docs/classes/Texture/IsErrorTexture.md b/docs/classes/Texture/IsErrorTexture.md
index 8d9a73be9a..c0bce06378 100644
--- a/docs/classes/Texture/IsErrorTexture.md
+++ b/docs/classes/Texture/IsErrorTexture.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Checks if the texture is an error texture."
-
+ arguments:
+ - position: 1
+ name: "texture"
+ type: Texture
returns:
- type: boolean
description: "true if the texture is an error texture, false otherwise."
diff --git a/docs/classes/Texture/IsMipmapped.md b/docs/classes/Texture/IsMipmapped.md
index e0c3828771..ab72835458 100644
--- a/docs/classes/Texture/IsMipmapped.md
+++ b/docs/classes/Texture/IsMipmapped.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Checks if the texture is mipmapped."
-
+ arguments:
+ - position: 1
+ name: "texture"
+ type: Texture
returns:
- type: boolean
description: "true if the texture is mipmapped, false otherwise."
diff --git a/docs/classes/Texture/IsTranslucent.md b/docs/classes/Texture/IsTranslucent.md
index d0b78e2873..21e829ed13 100644
--- a/docs/classes/Texture/IsTranslucent.md
+++ b/docs/classes/Texture/IsTranslucent.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Checks if the texture is translucent."
-
+ arguments:
+ - position: 1
+ name: "texture"
+ type: Texture
returns:
- type: boolean
description: "true if the texture is translucent, false otherwise."
diff --git a/docs/classes/Texture/Release.md b/docs/classes/Texture/Release.md
index 173e333223..c4b7eb4333 100644
--- a/docs/classes/Texture/Release.md
+++ b/docs/classes/Texture/Release.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Release the texture."
-
+ arguments:
+ - position: 1
+ name: "texture"
+ type: Texture
returns:
---
diff --git a/docs/classes/Texture/__tostring.md b/docs/classes/Texture/__tostring.md
index b6e39bf18e..ed676ff95f 100644
--- a/docs/classes/Texture/__tostring.md
+++ b/docs/classes/Texture/__tostring.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Returns a string representation of the texture."
-
+ arguments:
+ - position: 1
+ name: "texture"
+ type: Texture
returns:
---
diff --git a/docs/classes/Trace/DidHit.md b/docs/classes/Trace/DidHit.md
index f839a5eb58..8708688c98 100644
--- a/docs/classes/Trace/DidHit.md
+++ b/docs/classes/Trace/DidHit.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Check if the trace hit anything."
-
+ arguments:
+ - position: 1
+ name: "trace"
+ type: Trace
returns:
- type: boolean
description: "true if the trace hit something, false otherwise."
diff --git a/docs/classes/Trace/DidHitNonWorldEntity.md b/docs/classes/Trace/DidHitNonWorldEntity.md
index 13d55e43bf..4047ada1f3 100644
--- a/docs/classes/Trace/DidHitNonWorldEntity.md
+++ b/docs/classes/Trace/DidHitNonWorldEntity.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Check if the trace hit a non-world entity."
-
+ arguments:
+ - position: 1
+ name: "trace"
+ type: Trace
returns:
- type: boolean
description: "true if the trace hit a non-world entity, false otherwise."
diff --git a/docs/classes/Trace/DidHitWorld.md b/docs/classes/Trace/DidHitWorld.md
index b735598c85..c822187fad 100644
--- a/docs/classes/Trace/DidHitWorld.md
+++ b/docs/classes/Trace/DidHitWorld.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Check if the trace hit the world."
-
+ arguments:
+ - position: 1
+ name: "trace"
+ type: Trace
returns:
- type: boolean
description: "true if the trace hit the world, false otherwise."
diff --git a/docs/classes/Trace/GetEntityIndex.md b/docs/classes/Trace/GetEntityIndex.md
index dab656cd49..ac739cbe47 100644
--- a/docs/classes/Trace/GetEntityIndex.md
+++ b/docs/classes/Trace/GetEntityIndex.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Get the index of the entity that was hit."
-
+ arguments:
+ - position: 1
+ name: "trace"
+ type: Trace
returns:
- type: integer
description: "The index of the entity that was hit."
diff --git a/docs/classes/Trace/IsDisplacementSurface.md b/docs/classes/Trace/IsDisplacementSurface.md
index 3104fdfb0e..55908e584b 100644
--- a/docs/classes/Trace/IsDisplacementSurface.md
+++ b/docs/classes/Trace/IsDisplacementSurface.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Check if the trace hit a displacement surface."
-
+ arguments:
+ - position: 1
+ name: "trace"
+ type: Trace
returns:
- type: boolean
description: "true if the trace hit a displacement surface, false otherwise."
diff --git a/docs/classes/Trace/IsDisplacementSurfaceBuildable.md b/docs/classes/Trace/IsDisplacementSurfaceBuildable.md
index 33010f0fe5..912705b907 100644
--- a/docs/classes/Trace/IsDisplacementSurfaceBuildable.md
+++ b/docs/classes/Trace/IsDisplacementSurfaceBuildable.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Check if the trace hit a buildable displacement surface."
-
+ arguments:
+ - position: 1
+ name: "trace"
+ type: Trace
returns:
- type: boolean
description: "true if the trace hit a buildable displacement surface, false otherwise."
diff --git a/docs/classes/Trace/IsDisplacementSurfaceProp1.md b/docs/classes/Trace/IsDisplacementSurfaceProp1.md
index 7fbf820607..46058dbee5 100644
--- a/docs/classes/Trace/IsDisplacementSurfaceProp1.md
+++ b/docs/classes/Trace/IsDisplacementSurfaceProp1.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Check if the trace hit a displacement surface with prop1 physics."
-
+ arguments:
+ - position: 1
+ name: "trace"
+ type: Trace
returns:
- type: boolean
description: "true if the trace hit a displacement surface with prop1 physics, false otherwise."
diff --git a/docs/classes/Trace/IsDisplacementSurfaceProp2.md b/docs/classes/Trace/IsDisplacementSurfaceProp2.md
index 13c61398c3..a2fcf299f7 100644
--- a/docs/classes/Trace/IsDisplacementSurfaceProp2.md
+++ b/docs/classes/Trace/IsDisplacementSurfaceProp2.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Check if the trace hit a displacement surface with prop2 physics."
-
+ arguments:
+ - position: 1
+ name: "trace"
+ type: Trace
returns:
- type: boolean
description: "true if the trace hit a displacement surface with prop2 physics, false otherwise."
diff --git a/docs/classes/Trace/IsDisplacementSurfaceWalkable.md b/docs/classes/Trace/IsDisplacementSurfaceWalkable.md
index 66cbd52f68..9127197241 100644
--- a/docs/classes/Trace/IsDisplacementSurfaceWalkable.md
+++ b/docs/classes/Trace/IsDisplacementSurfaceWalkable.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Check if the trace hit a walkable displacement surface."
-
+ arguments:
+ - position: 1
+ name: "trace"
+ type: Trace
returns:
- type: boolean
description: "true if the trace hit a walkable displacement surface, false otherwise."
diff --git a/docs/classes/Trace/__index.md b/docs/classes/Trace/__index.md
index 9e77b35caf..52b8a12d2a 100644
--- a/docs/classes/Trace/__index.md
+++ b/docs/classes/Trace/__index.md
@@ -14,8 +14,12 @@ lua:
description: "Get a field from the trace."
arguments:
- - name: "field"
- type: string
+ - position: 1
+ name: "trace"
+ type: Trace
+ - position: 2
+ name: "field"
+ type: string
returns:
- type: any
description: "The value of the field."
diff --git a/docs/classes/Trace/__newindex.md b/docs/classes/Trace/__newindex.md
index 4988fe579d..dd6f996fd1 100644
--- a/docs/classes/Trace/__newindex.md
+++ b/docs/classes/Trace/__newindex.md
@@ -14,8 +14,12 @@ lua:
description: "Set a field in the trace."
arguments:
- - name: "field"
- type: string
+ - position: 1
+ name: "trace"
+ type: Trace
+ - position: 2
+ name: "field"
+ type: string
returns:
---
diff --git a/docs/classes/Trace/__tostring.md b/docs/classes/Trace/__tostring.md
index 671e848abe..62de09ebb4 100644
--- a/docs/classes/Trace/__tostring.md
+++ b/docs/classes/Trace/__tostring.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Get a string representation of the trace."
-
+ arguments:
+ - position: 1
+ name: "trace"
+ type: Trace
returns:
- type: string
description: "The string representation of the trace."
diff --git a/docs/classes/UserCommand/AddKey.md b/docs/classes/UserCommand/AddKey.md
index cc0a3c43fd..1ad076bac7 100644
--- a/docs/classes/UserCommand/AddKey.md
+++ b/docs/classes/UserCommand/AddKey.md
@@ -14,8 +14,12 @@ lua:
description: "Adds a key to the buttons"
arguments:
- - name: "buttonCode"
- type: number
+ - position: 1
+ name: "userCmd"
+ type: UserCommand
+ - position: 2
+ name: "buttonCode"
+ type: number
returns:
---
diff --git a/docs/classes/UserCommand/ClearButtons.md b/docs/classes/UserCommand/ClearButtons.md
index ba0e5b2dc1..91f7dbbbdf 100644
--- a/docs/classes/UserCommand/ClearButtons.md
+++ b/docs/classes/UserCommand/ClearButtons.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Clears the buttons"
-
+ arguments:
+ - position: 1
+ name: "userCmd"
+ type: UserCommand
returns:
---
diff --git a/docs/classes/UserCommand/ClearMovement.md b/docs/classes/UserCommand/ClearMovement.md
index 4974b39b75..c84bec1255 100644
--- a/docs/classes/UserCommand/ClearMovement.md
+++ b/docs/classes/UserCommand/ClearMovement.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Clears the movement"
-
+ arguments:
+ - position: 1
+ name: "userCmd"
+ type: UserCommand
returns:
---
diff --git a/docs/classes/UserCommand/CommandNumber.md b/docs/classes/UserCommand/CommandNumber.md
index b49a1753e5..5962b9714e 100644
--- a/docs/classes/UserCommand/CommandNumber.md
+++ b/docs/classes/UserCommand/CommandNumber.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Gets the command number"
-
+ arguments:
+ - position: 1
+ name: "userCmd"
+ type: UserCommand
returns:
- type: integer
description: "The command number"
diff --git a/docs/classes/UserCommand/GetButtons.md b/docs/classes/UserCommand/GetButtons.md
index a7beb10c75..b5263348ef 100644
--- a/docs/classes/UserCommand/GetButtons.md
+++ b/docs/classes/UserCommand/GetButtons.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Gets the button states"
-
+ arguments:
+ - position: 1
+ name: "userCmd"
+ type: UserCommand
returns:
- type: integer
description: "The button states"
diff --git a/docs/classes/UserCommand/GetForwardMove.md b/docs/classes/UserCommand/GetForwardMove.md
index e7ce4349d3..d4adffcf61 100644
--- a/docs/classes/UserCommand/GetForwardMove.md
+++ b/docs/classes/UserCommand/GetForwardMove.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Gets forward movement value"
-
+ arguments:
+ - position: 1
+ name: "userCmd"
+ type: UserCommand
returns:
- type: number
description: "The forward movement value"
diff --git a/docs/classes/UserCommand/GetImpulse.md b/docs/classes/UserCommand/GetImpulse.md
index 770442dd15..28978b325f 100644
--- a/docs/classes/UserCommand/GetImpulse.md
+++ b/docs/classes/UserCommand/GetImpulse.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Gets the impulse value"
-
+ arguments:
+ - position: 1
+ name: "userCmd"
+ type: UserCommand
returns:
- type: integer
description: "The impulse value"
diff --git a/docs/classes/UserCommand/GetMouseWheel.md b/docs/classes/UserCommand/GetMouseWheel.md
index eb95427433..bd8c75167f 100644
--- a/docs/classes/UserCommand/GetMouseWheel.md
+++ b/docs/classes/UserCommand/GetMouseWheel.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Gets the mouse wheel delta"
-
+ arguments:
+ - position: 1
+ name: "userCmd"
+ type: UserCommand
returns:
- type: integer
description: "The mouse wheel delta"
diff --git a/docs/classes/UserCommand/GetMouseX.md b/docs/classes/UserCommand/GetMouseX.md
index c5bd1a7452..7f542a7809 100644
--- a/docs/classes/UserCommand/GetMouseX.md
+++ b/docs/classes/UserCommand/GetMouseX.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Gets mouse X movement"
-
+ arguments:
+ - position: 1
+ name: "userCmd"
+ type: UserCommand
returns:
- type: integer
description: "The mouse X movement"
diff --git a/docs/classes/UserCommand/GetMouseY.md b/docs/classes/UserCommand/GetMouseY.md
index cee59d4218..a9485cea3c 100644
--- a/docs/classes/UserCommand/GetMouseY.md
+++ b/docs/classes/UserCommand/GetMouseY.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Gets mouse Y movement"
-
+ arguments:
+ - position: 1
+ name: "userCmd"
+ type: UserCommand
returns:
- type: integer
description: "The mouse Y movement"
diff --git a/docs/classes/UserCommand/GetSideMove.md b/docs/classes/UserCommand/GetSideMove.md
index 43aadc9e90..d782f512d5 100644
--- a/docs/classes/UserCommand/GetSideMove.md
+++ b/docs/classes/UserCommand/GetSideMove.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Gets side movement value"
-
+ arguments:
+ - position: 1
+ name: "userCmd"
+ type: UserCommand
returns:
- type: number
description: "The side movement value"
diff --git a/docs/classes/UserCommand/GetUpMove.md b/docs/classes/UserCommand/GetUpMove.md
index 0398280b4e..463b86a950 100644
--- a/docs/classes/UserCommand/GetUpMove.md
+++ b/docs/classes/UserCommand/GetUpMove.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Gets upward movement value"
-
+ arguments:
+ - position: 1
+ name: "userCmd"
+ type: UserCommand
returns:
- type: number
description: "The upward movement value"
diff --git a/docs/classes/UserCommand/GetViewAngles.md b/docs/classes/UserCommand/GetViewAngles.md
index 029b3d710c..619a4e1ce2 100644
--- a/docs/classes/UserCommand/GetViewAngles.md
+++ b/docs/classes/UserCommand/GetViewAngles.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Gets the view angles"
-
+ arguments:
+ - position: 1
+ name: "userCmd"
+ type: UserCommand
returns:
- type: Angle
description: "The view angles"
diff --git a/docs/classes/UserCommand/IsNew.md b/docs/classes/UserCommand/IsNew.md
new file mode 100644
index 0000000000..d07854abc1
--- /dev/null
+++ b/docs/classes/UserCommand/IsNew.md
@@ -0,0 +1,27 @@
+---
+template: lua-class-function.html
+title: IsNew
+icon: lua-shared
+tags:
+ - lua
+ - shared
+ - needs-verification
+ - needs-example
+lua:
+ library: UserCommand
+ function: IsNew
+ realm: shared
+ description: "Whether this command is repeated (likely due to lag) and it isn't new."
+
+ arguments:
+ - position: 1
+ name: "userCmd"
+ type: UserCommand
+ returns:
+ - type: boolean
+ description: "True if the command is new, false otherwise"
+---
+
+
+UserCommand:IsNew – Whether this command is repeated (likely due to lag) and it isn't new.
+
diff --git a/docs/classes/UserCommand/KeyDown.md b/docs/classes/UserCommand/KeyDown.md
index 3134904eeb..068169c456 100644
--- a/docs/classes/UserCommand/KeyDown.md
+++ b/docs/classes/UserCommand/KeyDown.md
@@ -14,8 +14,12 @@ lua:
description: "Checks if a key is down"
arguments:
- - name: "key"
- type: number
+ - position: 1
+ name: "userCmd"
+ type: UserCommand
+ - position: 2
+ name: "key"
+ type: number
returns:
- type: boolean
description: "True if the key is down, false otherwise"
diff --git a/docs/classes/UserCommand/RemoveKey.md b/docs/classes/UserCommand/RemoveKey.md
index c213596635..3d20df5abe 100644
--- a/docs/classes/UserCommand/RemoveKey.md
+++ b/docs/classes/UserCommand/RemoveKey.md
@@ -14,8 +14,12 @@ lua:
description: "Removes a key from the buttons"
arguments:
- - name: "key"
- type: number
+ - position: 1
+ name: "userCmd"
+ type: UserCommand
+ - position: 2
+ name: "key"
+ type: number
returns:
---
diff --git a/docs/classes/UserCommand/SelectWeapon.md b/docs/classes/UserCommand/SelectWeapon.md
index f59d9a076e..1ebf3faa34 100644
--- a/docs/classes/UserCommand/SelectWeapon.md
+++ b/docs/classes/UserCommand/SelectWeapon.md
@@ -13,7 +13,13 @@ lua:
realm: shared
description: "Selects a weapon"
-
+ arguments:
+ - position: 1
+ name: "userCmd"
+ type: UserCommand
+ - position: 2
+ name: "entity"
+ type: Entity
returns:
---
diff --git a/docs/classes/UserCommand/SetButtons.md b/docs/classes/UserCommand/SetButtons.md
index 19de8f8444..504e5bc921 100644
--- a/docs/classes/UserCommand/SetButtons.md
+++ b/docs/classes/UserCommand/SetButtons.md
@@ -13,7 +13,13 @@ lua:
realm: shared
description: "Sets the button states"
-
+ arguments:
+ - position: 1
+ name: "userCmd"
+ type: UserCommand
+ - position: 2
+ name: "buttons"
+ type: number
returns:
---
diff --git a/docs/classes/UserCommand/SetForwardMove.md b/docs/classes/UserCommand/SetForwardMove.md
index a1fc674832..538324f456 100644
--- a/docs/classes/UserCommand/SetForwardMove.md
+++ b/docs/classes/UserCommand/SetForwardMove.md
@@ -13,7 +13,13 @@ lua:
realm: shared
description: "Sets forward movement"
-
+ arguments:
+ - position: 1
+ name: "userCmd"
+ type: UserCommand
+ - position: 2
+ name: "forwardMove"
+ type: number
returns:
---
diff --git a/docs/classes/UserCommand/SetImpulse.md b/docs/classes/UserCommand/SetImpulse.md
index 55618d8599..7c56854584 100644
--- a/docs/classes/UserCommand/SetImpulse.md
+++ b/docs/classes/UserCommand/SetImpulse.md
@@ -13,7 +13,13 @@ lua:
realm: shared
description: "Sets the impulse value"
-
+ arguments:
+ - position: 1
+ name: "userCmd"
+ type: UserCommand
+ - position: 2
+ name: "impulse"
+ type: number
returns:
---
diff --git a/docs/classes/UserCommand/SetMouseX.md b/docs/classes/UserCommand/SetMouseX.md
index db4d1ec37d..60542833e7 100644
--- a/docs/classes/UserCommand/SetMouseX.md
+++ b/docs/classes/UserCommand/SetMouseX.md
@@ -13,7 +13,13 @@ lua:
realm: shared
description: "Sets mouse X movement"
-
+ arguments:
+ - position: 1
+ name: "userCmd"
+ type: UserCommand
+ - position: 2
+ name: "mouseDx"
+ type: number
returns:
---
diff --git a/docs/classes/UserCommand/SetMouseY.md b/docs/classes/UserCommand/SetMouseY.md
index b46bd38dd1..1c9b67b452 100644
--- a/docs/classes/UserCommand/SetMouseY.md
+++ b/docs/classes/UserCommand/SetMouseY.md
@@ -13,7 +13,13 @@ lua:
realm: shared
description: "Sets mouse Y movement"
-
+ arguments:
+ - position: 1
+ name: "userCmd"
+ type: UserCommand
+ - position: 2
+ name: "mouseDy"
+ type: number
returns:
---
diff --git a/docs/classes/UserCommand/SetSideMove.md b/docs/classes/UserCommand/SetSideMove.md
index c3dc8c88eb..f1082cca97 100644
--- a/docs/classes/UserCommand/SetSideMove.md
+++ b/docs/classes/UserCommand/SetSideMove.md
@@ -13,7 +13,13 @@ lua:
realm: shared
description: "Sets side movement"
-
+ arguments:
+ - position: 1
+ name: "userCmd"
+ type: UserCommand
+ - position: 2
+ name: "sideMove"
+ type: number
returns:
---
diff --git a/docs/classes/UserCommand/SetUpMove.md b/docs/classes/UserCommand/SetUpMove.md
index 956fc84396..6c25edff0a 100644
--- a/docs/classes/UserCommand/SetUpMove.md
+++ b/docs/classes/UserCommand/SetUpMove.md
@@ -13,7 +13,13 @@ lua:
realm: shared
description: "Sets upward movement"
-
+ arguments:
+ - position: 1
+ name: "userCmd"
+ type: UserCommand
+ - position: 2
+ name: "upMove"
+ type: number
returns:
---
diff --git a/docs/classes/UserCommand/SetViewAngles.md b/docs/classes/UserCommand/SetViewAngles.md
index 2c406fa365..66ceab7881 100644
--- a/docs/classes/UserCommand/SetViewAngles.md
+++ b/docs/classes/UserCommand/SetViewAngles.md
@@ -13,7 +13,13 @@ lua:
realm: shared
description: "Sets the view angles"
-
+ arguments:
+ - position: 1
+ name: "userCmd"
+ type: UserCommand
+ - position: 2
+ name: "viewAngles"
+ type: Angle
returns:
---
diff --git a/docs/classes/UserCommand/TickCount.md b/docs/classes/UserCommand/TickCount.md
index 756e02b01d..174e2d7bfb 100644
--- a/docs/classes/UserCommand/TickCount.md
+++ b/docs/classes/UserCommand/TickCount.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Gets the tick count"
-
+ arguments:
+ - position: 1
+ name: "userCmd"
+ type: UserCommand
returns:
- type: integer
description: "The tick count"
diff --git a/docs/classes/UserCommand/__tostring.md b/docs/classes/UserCommand/__tostring.md
index 890e3b3e5b..92e9ab5dc6 100644
--- a/docs/classes/UserCommand/__tostring.md
+++ b/docs/classes/UserCommand/__tostring.md
@@ -13,6 +13,7 @@ lua:
realm: shared
description: "__tostring method for UserCommand"
+ arguments:
returns:
- type: string
diff --git a/docs/classes/Vector/Add.md b/docs/classes/Vector/Add.md
index b765cfa766..6a4044f5a5 100644
--- a/docs/classes/Vector/Add.md
+++ b/docs/classes/Vector/Add.md
@@ -14,8 +14,12 @@ lua:
description: "Modify the existing vector, adding another vector to it."
arguments:
- - name: "vectorToAdd"
- type: Vector
+ - position: 1
+ name: "vector"
+ type: Vector
+ - position: 2
+ name: "vectorToAdd"
+ type: Vector
returns:
---
diff --git a/docs/classes/Vector/Angle.md b/docs/classes/Vector/Angle.md
index fe680db039..05f79b4518 100644
--- a/docs/classes/Vector/Angle.md
+++ b/docs/classes/Vector/Angle.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Converts a vector to an angle."
-
+ arguments:
+ - position: 1
+ name: "vector"
+ type: Vector
returns:
- type: Angle
description: "The converted angle."
diff --git a/docs/classes/Vector/AngleWithUp.md b/docs/classes/Vector/AngleWithUp.md
index 0fef9d244d..ddc2c9df01 100644
--- a/docs/classes/Vector/AngleWithUp.md
+++ b/docs/classes/Vector/AngleWithUp.md
@@ -14,8 +14,12 @@ lua:
description: "Converts a vector to an angle with a specified up vector."
arguments:
- - name: "up"
- type: Vector
+ - position: 1
+ name: "vector"
+ type: Vector
+ - position: 2
+ name: "up"
+ type: Vector
returns:
- type: Angle
description: "The converted angle."
diff --git a/docs/classes/Vector/Cross.md b/docs/classes/Vector/Cross.md
index 4f35249afd..f83de98d49 100644
--- a/docs/classes/Vector/Cross.md
+++ b/docs/classes/Vector/Cross.md
@@ -14,8 +14,12 @@ lua:
description: "Calculates the cross product of two vectors."
arguments:
- - name: "vector2"
- type: Vector
+ - position: 1
+ name: "vector1"
+ type: Vector
+ - position: 2
+ name: "vector2"
+ type: Vector
returns:
- type: Vector
description: "The cross product of the two vectors."
diff --git a/docs/classes/Vector/DistanceTo.md b/docs/classes/Vector/DistanceTo.md
index e024111602..822fc4237a 100644
--- a/docs/classes/Vector/DistanceTo.md
+++ b/docs/classes/Vector/DistanceTo.md
@@ -14,8 +14,12 @@ lua:
description: "Calculates the distance between two vectors."
arguments:
- - name: "vector2"
- type: Vector
+ - position: 1
+ name: "vector1"
+ type: Vector
+ - position: 2
+ name: "vector2"
+ type: Vector
returns:
- type: number
description: "The distance between the two vectors."
diff --git a/docs/classes/Vector/DistanceTo2D.md b/docs/classes/Vector/DistanceTo2D.md
index 5ee99b47e0..3116827fae 100644
--- a/docs/classes/Vector/DistanceTo2D.md
+++ b/docs/classes/Vector/DistanceTo2D.md
@@ -14,8 +14,12 @@ lua:
description: "Calculates the distance between two vectors in 2D space."
arguments:
- - name: "vector2"
- type: Vector
+ - position: 1
+ name: "vector1"
+ type: Vector
+ - position: 2
+ name: "vector2"
+ type: Vector
returns:
- type: number
description: "The distance between the two vectors in 2D space."
diff --git a/docs/classes/Vector/DistanceTo2DSqr.md b/docs/classes/Vector/DistanceTo2DSqr.md
index f7beb5dea0..d0c59b92c7 100644
--- a/docs/classes/Vector/DistanceTo2DSqr.md
+++ b/docs/classes/Vector/DistanceTo2DSqr.md
@@ -14,8 +14,12 @@ lua:
description: "Calculates the squared distance between two vectors in 2D space."
arguments:
- - name: "vector2"
- type: Vector
+ - position: 1
+ name: "vector1"
+ type: Vector
+ - position: 2
+ name: "vector2"
+ type: Vector
returns:
- type: number
description: "The squared distance between the two vectors in 2D space."
diff --git a/docs/classes/Vector/DistanceToAsSqr.md b/docs/classes/Vector/DistanceToAsSqr.md
index c5371f0fe8..50f59e27b1 100644
--- a/docs/classes/Vector/DistanceToAsSqr.md
+++ b/docs/classes/Vector/DistanceToAsSqr.md
@@ -14,8 +14,12 @@ lua:
description: "Calculates the squared distance between two vectors."
arguments:
- - name: "vector2"
- type: Vector
+ - position: 1
+ name: "vector1"
+ type: Vector
+ - position: 2
+ name: "vector2"
+ type: Vector
returns:
- type: number
description: "The squared distance between the two vectors."
diff --git a/docs/classes/Vector/Divide.md b/docs/classes/Vector/Divide.md
index 866ea6ec3f..e506eae9ce 100644
--- a/docs/classes/Vector/Divide.md
+++ b/docs/classes/Vector/Divide.md
@@ -14,8 +14,12 @@ lua:
description: "Modify the existing vector, dividing it by a number."
arguments:
- - name: "divideBy"
- type: number
+ - position: 1
+ name: "vector"
+ type: Vector
+ - position: 2
+ name: "divideBy"
+ type: number
returns:
---
diff --git a/docs/classes/Vector/Dot.md b/docs/classes/Vector/Dot.md
index e6630a219f..cd9fce2d55 100644
--- a/docs/classes/Vector/Dot.md
+++ b/docs/classes/Vector/Dot.md
@@ -14,8 +14,12 @@ lua:
description: "Calculates the dot product of two vectors."
arguments:
- - name: "vector2"
- type: Vector
+ - position: 1
+ name: "vector1"
+ type: Vector
+ - position: 2
+ name: "vector2"
+ type: Vector
returns:
- type: number
description: "The dot product of the two vectors."
diff --git a/docs/classes/Vector/GetGreatest.md b/docs/classes/Vector/GetGreatest.md
index bceb585c52..7cf9713194 100644
--- a/docs/classes/Vector/GetGreatest.md
+++ b/docs/classes/Vector/GetGreatest.md
@@ -14,8 +14,12 @@ lua:
description: "Calculates the maximum values of two vectors."
arguments:
- - name: "vector2"
- type: Vector
+ - position: 1
+ name: "vector1"
+ type: Vector
+ - position: 2
+ name: "vector2"
+ type: Vector
returns:
- type: Vector
description: "The maximum values of the two vectors."
diff --git a/docs/classes/Vector/GetSmallest.md b/docs/classes/Vector/GetSmallest.md
index 8d96347ba2..d8e7e08060 100644
--- a/docs/classes/Vector/GetSmallest.md
+++ b/docs/classes/Vector/GetSmallest.md
@@ -14,8 +14,12 @@ lua:
description: "Calculates the minimum values of two vectors."
arguments:
- - name: "vector2"
- type: Vector
+ - position: 1
+ name: "vector1"
+ type: Vector
+ - position: 2
+ name: "vector2"
+ type: Vector
returns:
- type: Vector
description: "The minimum values of the two vectors."
diff --git a/docs/classes/Vector/Initialize.md b/docs/classes/Vector/Initialize.md
index cedb249850..56afe3ee29 100644
--- a/docs/classes/Vector/Initialize.md
+++ b/docs/classes/Vector/Initialize.md
@@ -14,12 +14,18 @@ lua:
description: "Initializes the vector with the specified values."
arguments:
- - name: "x"
- type: number
- - name: "y"
- type: number
- - name: "z"
- type: number
+ - position: 1
+ name: "vector"
+ type: Vector
+ - position: 2
+ name: "x"
+ type: number
+ - position: 3
+ name: "y"
+ type: number
+ - position: 4
+ name: "z"
+ type: number
returns:
---
diff --git a/docs/classes/Vector/Invalidate.md b/docs/classes/Vector/Invalidate.md
index feee5dd584..37207bc93d 100644
--- a/docs/classes/Vector/Invalidate.md
+++ b/docs/classes/Vector/Invalidate.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Invalidates the vector."
-
+ arguments:
+ - position: 1
+ name: "vector"
+ type: Vector
returns:
---
diff --git a/docs/classes/Vector/IsLengthGreaterThan.md b/docs/classes/Vector/IsLengthGreaterThan.md
index 3f0989f4f7..183dd24a4f 100644
--- a/docs/classes/Vector/IsLengthGreaterThan.md
+++ b/docs/classes/Vector/IsLengthGreaterThan.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Checks if the length of the vector is greater than the specified value."
-
+ arguments:
+ - position: 1
+ name: "vector"
+ type: Vector
returns:
- type: boolean
description: "True if the length of the vector is greater than the specified value, false otherwise."
diff --git a/docs/classes/Vector/IsLengthLessThan.md b/docs/classes/Vector/IsLengthLessThan.md
index e27a9d2c89..36dde47838 100644
--- a/docs/classes/Vector/IsLengthLessThan.md
+++ b/docs/classes/Vector/IsLengthLessThan.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Checks if the length of the vector is less than the specified value."
-
+ arguments:
+ - position: 1
+ name: "vector"
+ type: Vector
returns:
- type: boolean
description: "True if the length of the vector is less than the specified value, false otherwise."
diff --git a/docs/classes/Vector/IsValid.md b/docs/classes/Vector/IsValid.md
index de38e95e9f..4c3a159d66 100644
--- a/docs/classes/Vector/IsValid.md
+++ b/docs/classes/Vector/IsValid.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Checks if the vector is valid."
-
+ arguments:
+ - position: 1
+ name: "vector"
+ type: Vector
returns:
- type: boolean
description: "True if the vector is valid, false otherwise."
diff --git a/docs/classes/Vector/Length.md b/docs/classes/Vector/Length.md
index 5987807671..5ed09290c6 100644
--- a/docs/classes/Vector/Length.md
+++ b/docs/classes/Vector/Length.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Calculates the length of the vector."
-
+ arguments:
+ - position: 1
+ name: "vector"
+ type: Vector
returns:
- type: number
description: "The length of the vector."
diff --git a/docs/classes/Vector/Length2D.md b/docs/classes/Vector/Length2D.md
index 64e0fabd51..3c2e68a59d 100644
--- a/docs/classes/Vector/Length2D.md
+++ b/docs/classes/Vector/Length2D.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Calculates the 2D length of the vector."
-
+ arguments:
+ - position: 1
+ name: "vector"
+ type: Vector
returns:
- type: number
description: "The 2D length of the vector."
diff --git a/docs/classes/Vector/Length2DSqr.md b/docs/classes/Vector/Length2DSqr.md
index 9995d504fa..18ed294a1a 100644
--- a/docs/classes/Vector/Length2DSqr.md
+++ b/docs/classes/Vector/Length2DSqr.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Calculates the squared 2D length of the vector."
-
+ arguments:
+ - position: 1
+ name: "vector"
+ type: Vector
returns:
- type: number
description: "The squared 2D length of the vector."
diff --git a/docs/classes/Vector/LengthSqr.md b/docs/classes/Vector/LengthSqr.md
index ac1027f28c..5421df933f 100644
--- a/docs/classes/Vector/LengthSqr.md
+++ b/docs/classes/Vector/LengthSqr.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Calculates the squared length of the vector."
-
+ arguments:
+ - position: 1
+ name: "vector"
+ type: Vector
returns:
- type: number
description: "The squared length of the vector."
diff --git a/docs/classes/Vector/MultiplyThenAdd.md b/docs/classes/Vector/MultiplyThenAdd.md
index 3d2ace318c..c1b2a5127d 100644
--- a/docs/classes/Vector/MultiplyThenAdd.md
+++ b/docs/classes/Vector/MultiplyThenAdd.md
@@ -14,10 +14,15 @@ lua:
description: "Multiplies the first vector by the second vector and adds the third vector."
arguments:
- - name: "vector2"
- type: Vector
- - name: "vector3"
- type: Vector
+ - position: 1
+ name: "vector1"
+ type: Vector
+ - position: 2
+ name: "vector2"
+ type: Vector
+ - position: 3
+ name: "vector3"
+ type: Vector
returns:
---
diff --git a/docs/classes/Vector/Negate.md b/docs/classes/Vector/Negate.md
index f155f80cf2..fcb4623583 100644
--- a/docs/classes/Vector/Negate.md
+++ b/docs/classes/Vector/Negate.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Negates the vector."
-
+ arguments:
+ - position: 1
+ name: "vector"
+ type: Vector
returns:
---
diff --git a/docs/classes/Vector/NormalizeInPlace.md b/docs/classes/Vector/NormalizeInPlace.md
index 390b8c9e23..3efe73a877 100644
--- a/docs/classes/Vector/NormalizeInPlace.md
+++ b/docs/classes/Vector/NormalizeInPlace.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Normalizes the vector in place."
-
+ arguments:
+ - position: 1
+ name: "vector"
+ type: Vector
returns:
- type: number
description: "The length of the vector before normalization."
diff --git a/docs/classes/Vector/Random.md b/docs/classes/Vector/Random.md
index d070765fca..3d1f08d00c 100644
--- a/docs/classes/Vector/Random.md
+++ b/docs/classes/Vector/Random.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Generates a random vector."
-
+ arguments:
+ - position: 1
+ name: "vector"
+ type: Vector
returns:
---
diff --git a/docs/classes/Vector/Scale.md b/docs/classes/Vector/Scale.md
index 1c3977dd7f..18d4a2e8ac 100644
--- a/docs/classes/Vector/Scale.md
+++ b/docs/classes/Vector/Scale.md
@@ -14,8 +14,12 @@ lua:
description: "Modify the existing vector, scaling it by a number."
arguments:
- - name: "scaleBy"
- type: number
+ - position: 1
+ name: "vector"
+ type: Vector
+ - position: 2
+ name: "scaleBy"
+ type: number
returns:
---
diff --git a/docs/classes/Vector/ToScreen.md b/docs/classes/Vector/ToScreen.md
index 331fb32f56..5183ddb7bd 100644
--- a/docs/classes/Vector/ToScreen.md
+++ b/docs/classes/Vector/ToScreen.md
@@ -13,7 +13,10 @@ lua:
realm: client
description: "Converts the vector to screen coordinates."
-
+ arguments:
+ - position: 1
+ name: "vector"
+ type: Vector
returns:
- type: table
description: "A table containing the screen coordinates and whether it is visible."
diff --git a/docs/classes/Vector/WithinAABox.md b/docs/classes/Vector/WithinAABox.md
index b8236342df..80ae6aab3a 100644
--- a/docs/classes/Vector/WithinAABox.md
+++ b/docs/classes/Vector/WithinAABox.md
@@ -14,10 +14,15 @@ lua:
description: "Checks if the vector is within an axis-aligned box."
arguments:
- - name: "boxMin"
- type: Vector
- - name: "boxMax"
- type: Vector
+ - position: 1
+ name: "vector"
+ type: Vector
+ - position: 2
+ name: "boxMin"
+ type: Vector
+ - position: 3
+ name: "boxMax"
+ type: Vector
returns:
- type: boolean
description: "True if the vector is within the axis-aligned box, false otherwise."
diff --git a/docs/classes/Vector/Zero.md b/docs/classes/Vector/Zero.md
index 7afecc0aa6..5a699c7727 100644
--- a/docs/classes/Vector/Zero.md
+++ b/docs/classes/Vector/Zero.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Zeroes the vector."
-
+ arguments:
+ - position: 1
+ name: "vector"
+ type: Vector
returns:
---
diff --git a/docs/classes/Vector/__add.md b/docs/classes/Vector/__add.md
index 4280a18956..454b187aa8 100644
--- a/docs/classes/Vector/__add.md
+++ b/docs/classes/Vector/__add.md
@@ -14,8 +14,12 @@ lua:
description: "Adds two vectors."
arguments:
- - name: "vectorB"
- type: Vector
+ - position: 1
+ name: "vectorA"
+ type: Vector
+ - position: 2
+ name: "vectorB"
+ type: Vector
returns:
- type: Vector
description: "The sum of the two vectors."
diff --git a/docs/classes/Vector/__div.md b/docs/classes/Vector/__div.md
index b0af8fd95b..86032b2e3a 100644
--- a/docs/classes/Vector/__div.md
+++ b/docs/classes/Vector/__div.md
@@ -14,8 +14,12 @@ lua:
description: "Divides a vector by a number."
arguments:
- - name: "number"
- type: number
+ - position: 1
+ name: "vector"
+ type: Vector
+ - position: 2
+ name: "number"
+ type: number
returns:
- type: Vector
description: "The vector divided by the number."
diff --git a/docs/classes/Vector/__eq.md b/docs/classes/Vector/__eq.md
index adedf099dd..1fd60245ee 100644
--- a/docs/classes/Vector/__eq.md
+++ b/docs/classes/Vector/__eq.md
@@ -14,8 +14,12 @@ lua:
description: "Checks if two vectors are equal."
arguments:
- - name: "vectorB"
- type: Vector
+ - position: 1
+ name: "vector"
+ type: Vector
+ - position: 2
+ name: "other"
+ type: Vector
returns:
- type: boolean
description: "True if the vectors are equal, false otherwise."
diff --git a/docs/classes/Vector/__index.md b/docs/classes/Vector/__index.md
index 0de5cab8c0..65f3c7afbf 100644
--- a/docs/classes/Vector/__index.md
+++ b/docs/classes/Vector/__index.md
@@ -14,8 +14,12 @@ lua:
description: "Gets the value of a vector field."
arguments:
- - name: "field"
- type: string
+ - position: 1
+ name: "vector"
+ type: Vector
+ - position: 2
+ name: "field"
+ type: string
returns:
- type: number
description: "The value of the vector field."
diff --git a/docs/classes/Vector/__mul.md b/docs/classes/Vector/__mul.md
index 1bc2c40e31..7f9a9fe604 100644
--- a/docs/classes/Vector/__mul.md
+++ b/docs/classes/Vector/__mul.md
@@ -13,14 +13,21 @@ lua:
realm: shared
description: "Multiplies two vectors or a vector by a number."
- argumentSets:
- - arguments:
+ arguments:
+ - position: 1
+ types:
+ - name: "number"
+ type: number
+ - name: "vector"
+ type: Vector
+ - name: "vectorA"
+ type: Vector
+ - position: 2
+ types:
- name: "vector"
type: Vector
- - arguments:
- name: "number"
type: number
- - arguments:
- name: "vectorB"
type: Vector
returns:
diff --git a/docs/classes/Vector/__newindex.md b/docs/classes/Vector/__newindex.md
index ceb6366d01..d66b7fb898 100644
--- a/docs/classes/Vector/__newindex.md
+++ b/docs/classes/Vector/__newindex.md
@@ -14,8 +14,12 @@ lua:
description: "Sets the value of a vector field."
arguments:
- - name: "field"
- type: string
+ - position: 1
+ name: "vector"
+ type: Vector
+ - position: 2
+ name: "field"
+ type: string
returns:
---
diff --git a/docs/classes/Vector/__sub.md b/docs/classes/Vector/__sub.md
index 2a6e187a13..453b0eea7e 100644
--- a/docs/classes/Vector/__sub.md
+++ b/docs/classes/Vector/__sub.md
@@ -14,8 +14,12 @@ lua:
description: "Subtracts two vectors."
arguments:
- - name: "vectorB"
- type: Vector
+ - position: 1
+ name: "vectorA"
+ type: Vector
+ - position: 2
+ name: "vectorB"
+ type: Vector
returns:
- type: Vector
description: "The difference of the two vectors."
diff --git a/docs/classes/Vector/__tostring.md b/docs/classes/Vector/__tostring.md
index e2bc563f8b..b404d82ad0 100644
--- a/docs/classes/Vector/__tostring.md
+++ b/docs/classes/Vector/__tostring.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Converts the vector to a string."
-
+ arguments:
+ - position: 1
+ name: "vector"
+ type: Vector
returns:
- type: string
description: "The string representation of the vector."
diff --git a/docs/classes/Vector/__unm.md b/docs/classes/Vector/__unm.md
index e0b994c702..4fdc3f0f89 100644
--- a/docs/classes/Vector/__unm.md
+++ b/docs/classes/Vector/__unm.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Negates the vector."
-
+ arguments:
+ - position: 1
+ name: "vector"
+ type: Vector
returns:
- type: Vector
description: "The negated vector."
diff --git a/docs/classes/Weapon/AbortReload.md b/docs/classes/Weapon/AbortReload.md
index dd620ebcf5..c1240d8cb2 100644
--- a/docs/classes/Weapon/AbortReload.md
+++ b/docs/classes/Weapon/AbortReload.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Abort reload."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Weapon
returns:
---
diff --git a/docs/classes/Weapon/ActivityListCount.md b/docs/classes/Weapon/ActivityListCount.md
index 4188913de1..5d873a3f75 100644
--- a/docs/classes/Weapon/ActivityListCount.md
+++ b/docs/classes/Weapon/ActivityListCount.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Activity list count."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Weapon
returns:
- type: integer
description: "Number of activities in the list."
diff --git a/docs/classes/Weapon/ActivityOverride.md b/docs/classes/Weapon/ActivityOverride.md
index 891f12a8c4..e675849e02 100644
--- a/docs/classes/Weapon/ActivityOverride.md
+++ b/docs/classes/Weapon/ActivityOverride.md
@@ -14,8 +14,12 @@ lua:
description: "Asks which Activity override the weapon wants."
arguments:
- - name: "activity"
- type: number
+ - position: 1
+ name: "entity"
+ type: Weapon
+ - position: 2
+ name: "activity"
+ type: number
returns:
- type: enumeration/ACTIVITY
description: "Override activity ID."
diff --git a/docs/classes/Weapon/AddViewKick.md b/docs/classes/Weapon/AddViewKick.md
index 7e7cedd7a4..e0dae2aff6 100644
--- a/docs/classes/Weapon/AddViewKick.md
+++ b/docs/classes/Weapon/AddViewKick.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Add view kick."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Weapon
returns:
---
diff --git a/docs/classes/Weapon/AllowsAutoSwitchFrom.md b/docs/classes/Weapon/AllowsAutoSwitchFrom.md
index 632958433a..69f50dd712 100644
--- a/docs/classes/Weapon/AllowsAutoSwitchFrom.md
+++ b/docs/classes/Weapon/AllowsAutoSwitchFrom.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Allows auto switch from."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Weapon
returns:
- type: boolean
description: "Whether the weapon allows auto switch from."
diff --git a/docs/classes/Weapon/AllowsAutoSwitchTo.md b/docs/classes/Weapon/AllowsAutoSwitchTo.md
index 783f233cfa..064c8c58fd 100644
--- a/docs/classes/Weapon/AllowsAutoSwitchTo.md
+++ b/docs/classes/Weapon/AllowsAutoSwitchTo.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Allows auto switch to."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Weapon
returns:
- type: boolean
description: "Whether the weapon allows auto switch to."
diff --git a/docs/classes/Weapon/CalcViewmodelBob.md b/docs/classes/Weapon/CalcViewmodelBob.md
index fa02570d3c..0953ad19dc 100644
--- a/docs/classes/Weapon/CalcViewmodelBob.md
+++ b/docs/classes/Weapon/CalcViewmodelBob.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Calculate viewmodel bob."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Weapon
returns:
- type: number
description: "Viewmodel bob."
diff --git a/docs/classes/Weapon/CanBePickedUpByNPCs.md b/docs/classes/Weapon/CanBePickedUpByNPCs.md
index 44d260e2de..dddb6a3b57 100644
--- a/docs/classes/Weapon/CanBePickedUpByNPCs.md
+++ b/docs/classes/Weapon/CanBePickedUpByNPCs.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Can be picked up by NPCs."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Weapon
returns:
- type: boolean
description: "Whether the weapon can be picked up by NPCs."
diff --git a/docs/classes/Weapon/CanBeSelected.md b/docs/classes/Weapon/CanBeSelected.md
index 5c6eba36dd..2e969bc9d3 100644
--- a/docs/classes/Weapon/CanBeSelected.md
+++ b/docs/classes/Weapon/CanBeSelected.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Can be selected."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Weapon
returns:
- type: boolean
description: "Whether the weapon can be selected."
diff --git a/docs/classes/Weapon/CanDeploy.md b/docs/classes/Weapon/CanDeploy.md
index db6a1350c8..f25687b0a9 100644
--- a/docs/classes/Weapon/CanDeploy.md
+++ b/docs/classes/Weapon/CanDeploy.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Can deploy."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Weapon
returns:
- type: boolean
description: "Whether the weapon can deploy."
diff --git a/docs/classes/Weapon/CanHolster.md b/docs/classes/Weapon/CanHolster.md
index 0a2adee240..7a60755769 100644
--- a/docs/classes/Weapon/CanHolster.md
+++ b/docs/classes/Weapon/CanHolster.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Can holster."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Weapon
returns:
- type: boolean
description: "Whether the weapon can holster."
diff --git a/docs/classes/Weapon/CanLower.md b/docs/classes/Weapon/CanLower.md
index 3deb1f320d..13530b828c 100644
--- a/docs/classes/Weapon/CanLower.md
+++ b/docs/classes/Weapon/CanLower.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Can lower."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Weapon
returns:
- type: boolean
description: "Whether the weapon can lower."
diff --git a/docs/classes/Weapon/CheckReload.md b/docs/classes/Weapon/CheckReload.md
index f79861bbfe..4aadae3066 100644
--- a/docs/classes/Weapon/CheckReload.md
+++ b/docs/classes/Weapon/CheckReload.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Check reload."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Weapon
returns:
---
diff --git a/docs/classes/Weapon/Clip1.md b/docs/classes/Weapon/Clip1.md
index 1e47bee86e..7fca4d3464 100644
--- a/docs/classes/Weapon/Clip1.md
+++ b/docs/classes/Weapon/Clip1.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "The amount of ammo in the primary clip."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Weapon
returns:
- type: integer
description: "The amount of ammo in the primary clip."
diff --git a/docs/classes/Weapon/Clip2.md b/docs/classes/Weapon/Clip2.md
index 8d470852f0..52ab51aaa8 100644
--- a/docs/classes/Weapon/Clip2.md
+++ b/docs/classes/Weapon/Clip2.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "The amount of ammo in the secondary clip."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Weapon
returns:
- type: integer
description: "The amount of ammo in the secondary clip."
diff --git a/docs/classes/Weapon/DefaultDeploy.md b/docs/classes/Weapon/DefaultDeploy.md
index 219a1d7e15..951c2ecc4b 100644
--- a/docs/classes/Weapon/DefaultDeploy.md
+++ b/docs/classes/Weapon/DefaultDeploy.md
@@ -14,14 +14,21 @@ lua:
description: "Default deploy."
arguments:
- - name: "viewModel"
- type: string
- - name: "worldModel"
- type: string
- - name: "activity"
- type: number
- - name: "animationExtension"
- type: string
+ - position: 1
+ name: "entity"
+ type: Weapon
+ - position: 2
+ name: "viewModel"
+ type: string
+ - position: 3
+ name: "worldModel"
+ type: string
+ - position: 4
+ name: "activity"
+ type: number
+ - position: 5
+ name: "animationExtension"
+ type: string
returns:
- type: boolean
description: "Whether the weapon was successfully deployed."
diff --git a/docs/classes/Weapon/DefaultReload.md b/docs/classes/Weapon/DefaultReload.md
index 896db8db46..63468e7168 100644
--- a/docs/classes/Weapon/DefaultReload.md
+++ b/docs/classes/Weapon/DefaultReload.md
@@ -14,12 +14,18 @@ lua:
description: "Default reload."
arguments:
- - name: "clipSize1"
- type: number
- - name: "clipSize2"
- type: number
- - name: "activity"
- type: number
+ - position: 1
+ name: "entity"
+ type: Weapon
+ - position: 2
+ name: "clipSize1"
+ type: number
+ - position: 3
+ name: "clipSize2"
+ type: number
+ - position: 4
+ name: "activity"
+ type: number
returns:
- type: boolean
description: "Whether the weapon was successfully reloaded."
diff --git a/docs/classes/Weapon/DefaultTouch.md b/docs/classes/Weapon/DefaultTouch.md
index 33c17dfe96..5de58cdf03 100644
--- a/docs/classes/Weapon/DefaultTouch.md
+++ b/docs/classes/Weapon/DefaultTouch.md
@@ -14,8 +14,12 @@ lua:
description: "Default touch."
arguments:
- - name: "touchingEntity"
- type: Entity
+ - position: 1
+ name: "entity"
+ type: Weapon
+ - position: 2
+ name: "touchingEntity"
+ type: Entity
returns:
---
diff --git a/docs/classes/Weapon/Deploy.md b/docs/classes/Weapon/Deploy.md
index 422ed802e2..5c8e3f35f6 100644
--- a/docs/classes/Weapon/Deploy.md
+++ b/docs/classes/Weapon/Deploy.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Deploy."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Weapon
returns:
- type: boolean
description: "Whether the weapon was successfully deployed."
diff --git a/docs/classes/Weapon/DisplayAltFireHudHint.md b/docs/classes/Weapon/DisplayAltFireHudHint.md
index be39573081..05a9a06cb8 100644
--- a/docs/classes/Weapon/DisplayAltFireHudHint.md
+++ b/docs/classes/Weapon/DisplayAltFireHudHint.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Display alt fire HUD hint."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Weapon
returns:
---
diff --git a/docs/classes/Weapon/DisplayReloadHudHint.md b/docs/classes/Weapon/DisplayReloadHudHint.md
index 56ab0e581a..6fa1fc47ac 100644
--- a/docs/classes/Weapon/DisplayReloadHudHint.md
+++ b/docs/classes/Weapon/DisplayReloadHudHint.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Display reload HUD hint."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Weapon
returns:
---
diff --git a/docs/classes/Weapon/Drop.md b/docs/classes/Weapon/Drop.md
index cfdbdd6967..1ea50328dd 100644
--- a/docs/classes/Weapon/Drop.md
+++ b/docs/classes/Weapon/Drop.md
@@ -14,9 +14,13 @@ lua:
description: "Drop."
arguments:
- - name: "velocity"
- type: Vector
- nillable: true
+ - position: 1
+ name: "entity"
+ type: Weapon
+ - position: 2
+ name: "velocity"
+ type: Vector
+ nillable: true
returns:
---
diff --git a/docs/classes/Weapon/EmitWeaponSound.md b/docs/classes/Weapon/EmitWeaponSound.md
index 8db1062a56..61490e9f6d 100644
--- a/docs/classes/Weapon/EmitWeaponSound.md
+++ b/docs/classes/Weapon/EmitWeaponSound.md
@@ -14,11 +14,16 @@ lua:
description: "Weapon sound."
arguments:
- - name: "soundType"
- type: number
- - name: "soundTime"
- type: number
- default: "0.0f"
+ - position: 1
+ name: "entity"
+ type: Weapon
+ - position: 2
+ name: "soundType"
+ type: number
+ - position: 3
+ name: "soundTime"
+ type: number
+ default: "0.0f"
returns:
---
diff --git a/docs/classes/Weapon/FinishReload.md b/docs/classes/Weapon/FinishReload.md
index e041b9db3c..6005f5a1c5 100644
--- a/docs/classes/Weapon/FinishReload.md
+++ b/docs/classes/Weapon/FinishReload.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Finish reload."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Weapon
returns:
---
diff --git a/docs/classes/Weapon/GetActivity.md b/docs/classes/Weapon/GetActivity.md
index 7454651882..2aec7ffa26 100644
--- a/docs/classes/Weapon/GetActivity.md
+++ b/docs/classes/Weapon/GetActivity.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Get activity."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Weapon
returns:
- type: enumeration/ACTIVITY
description: "Activity ID."
diff --git a/docs/classes/Weapon/GetAnimPrefix.md b/docs/classes/Weapon/GetAnimPrefix.md
index 32f0cc6c1c..30d2b10e17 100644
--- a/docs/classes/Weapon/GetAnimPrefix.md
+++ b/docs/classes/Weapon/GetAnimPrefix.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Get animation prefix."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Weapon
returns:
- type: string
description: "Animation prefix."
diff --git a/docs/classes/Weapon/GetAnimationPrefix.md b/docs/classes/Weapon/GetAnimationPrefix.md
index bcb1cb92c5..5cc640bf0d 100644
--- a/docs/classes/Weapon/GetAnimationPrefix.md
+++ b/docs/classes/Weapon/GetAnimationPrefix.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Get animation prefix."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Weapon
returns:
- type: string
description: "Animation prefix."
diff --git a/docs/classes/Weapon/GetBulletType.md b/docs/classes/Weapon/GetBulletType.md
index 421c72a1a1..346ae9af1b 100644
--- a/docs/classes/Weapon/GetBulletType.md
+++ b/docs/classes/Weapon/GetBulletType.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Get bullet type."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Weapon
returns:
- type: integer
description: "Bullet type."
diff --git a/docs/classes/Weapon/GetClassName.md b/docs/classes/Weapon/GetClassName.md
index 32566e1f91..827410988c 100644
--- a/docs/classes/Weapon/GetClassName.md
+++ b/docs/classes/Weapon/GetClassName.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Get class name."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Weapon
returns:
- type: string
description: "Class name."
diff --git a/docs/classes/Weapon/GetDamageAtLocation.md b/docs/classes/Weapon/GetDamageAtLocation.md
index 2d3fba74ee..828ac1159a 100644
--- a/docs/classes/Weapon/GetDamageAtLocation.md
+++ b/docs/classes/Weapon/GetDamageAtLocation.md
@@ -14,10 +14,15 @@ lua:
description: "Get damage."
arguments:
- - name: "damage"
- type: number
- - name: "location"
- type: number
+ - position: 1
+ name: "entity"
+ type: Weapon
+ - position: 2
+ name: "damage"
+ type: number
+ - position: 3
+ name: "location"
+ type: number
returns:
- type: number
description: "Damage."
diff --git a/docs/classes/Weapon/GetDeathNoticeName.md b/docs/classes/Weapon/GetDeathNoticeName.md
index 3ba8401d85..b07d9b2b86 100644
--- a/docs/classes/Weapon/GetDeathNoticeName.md
+++ b/docs/classes/Weapon/GetDeathNoticeName.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Get death notice name."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Weapon
returns:
- type: string
description: "Death notice name."
diff --git a/docs/classes/Weapon/GetDefaultAnimSpeed.md b/docs/classes/Weapon/GetDefaultAnimSpeed.md
index 95699caf78..149213dce8 100644
--- a/docs/classes/Weapon/GetDefaultAnimSpeed.md
+++ b/docs/classes/Weapon/GetDefaultAnimSpeed.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Get default animation speed."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Weapon
returns:
- type: number
description: "Default animation speed."
diff --git a/docs/classes/Weapon/GetDefaultClip1.md b/docs/classes/Weapon/GetDefaultClip1.md
index f7ef4915b6..de6e525cf6 100644
--- a/docs/classes/Weapon/GetDefaultClip1.md
+++ b/docs/classes/Weapon/GetDefaultClip1.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Get default clip 1."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Weapon
returns:
- type: integer
description: "Default clip 1."
diff --git a/docs/classes/Weapon/GetDefaultClip2.md b/docs/classes/Weapon/GetDefaultClip2.md
index 8a820639aa..0913b5819a 100644
--- a/docs/classes/Weapon/GetDefaultClip2.md
+++ b/docs/classes/Weapon/GetDefaultClip2.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Get default clip 2."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Weapon
returns:
- type: integer
description: "Default clip 2."
diff --git a/docs/classes/Weapon/GetDrawActivity.md b/docs/classes/Weapon/GetDrawActivity.md
index f6861986bc..f41b97278b 100644
--- a/docs/classes/Weapon/GetDrawActivity.md
+++ b/docs/classes/Weapon/GetDrawActivity.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Get draw activity."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Weapon
returns:
- type: enumeration/ACTIVITY
description: "Draw activity ID."
diff --git a/docs/classes/Weapon/GetFireRate.md b/docs/classes/Weapon/GetFireRate.md
index 4a6ff463d9..4419dc9efa 100644
--- a/docs/classes/Weapon/GetFireRate.md
+++ b/docs/classes/Weapon/GetFireRate.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Get fire rate."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Weapon
returns:
- type: number
description: "Fire rate."
diff --git a/docs/classes/Weapon/GetIdealActivity.md b/docs/classes/Weapon/GetIdealActivity.md
index e4e5d1c692..671b6b2876 100644
--- a/docs/classes/Weapon/GetIdealActivity.md
+++ b/docs/classes/Weapon/GetIdealActivity.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Get ideal activity."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Weapon
returns:
- type: enumeration/ACTIVITY
description: "Ideal activity ID."
diff --git a/docs/classes/Weapon/GetIdealSequence.md b/docs/classes/Weapon/GetIdealSequence.md
index 0756ce810c..505337fb05 100644
--- a/docs/classes/Weapon/GetIdealSequence.md
+++ b/docs/classes/Weapon/GetIdealSequence.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Get ideal sequence."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Weapon
returns:
- type: integer
description: "Ideal sequence ID."
diff --git a/docs/classes/Weapon/GetMaxAutoAimDeflection.md b/docs/classes/Weapon/GetMaxAutoAimDeflection.md
index cd6dc4abd1..822f05a1c5 100644
--- a/docs/classes/Weapon/GetMaxAutoAimDeflection.md
+++ b/docs/classes/Weapon/GetMaxAutoAimDeflection.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Get max auto aim deflection."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Weapon
returns:
- type: number
description: "Max auto aim deflection."
diff --git a/docs/classes/Weapon/GetMaxBurst.md b/docs/classes/Weapon/GetMaxBurst.md
index 2b687ae8a1..659888eb63 100644
--- a/docs/classes/Weapon/GetMaxBurst.md
+++ b/docs/classes/Weapon/GetMaxBurst.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Get max burst."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Weapon
returns:
- type: integer
description: "Max burst."
diff --git a/docs/classes/Weapon/GetMaxClip1.md b/docs/classes/Weapon/GetMaxClip1.md
index 03942a74ef..4623480fd2 100644
--- a/docs/classes/Weapon/GetMaxClip1.md
+++ b/docs/classes/Weapon/GetMaxClip1.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Get max clip 1."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Weapon
returns:
- type: integer
description: "Max clip 1."
diff --git a/docs/classes/Weapon/GetMaxClip2.md b/docs/classes/Weapon/GetMaxClip2.md
index c8cc1877a8..42ffa277e8 100644
--- a/docs/classes/Weapon/GetMaxClip2.md
+++ b/docs/classes/Weapon/GetMaxClip2.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Get max clip 2."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Weapon
returns:
- type: integer
description: "Max clip 2."
diff --git a/docs/classes/Weapon/GetMaxRestTime.md b/docs/classes/Weapon/GetMaxRestTime.md
index 9377abd392..51a2c97723 100644
--- a/docs/classes/Weapon/GetMaxRestTime.md
+++ b/docs/classes/Weapon/GetMaxRestTime.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Get max rest time."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Weapon
returns:
- type: number
description: "Max rest time."
diff --git a/docs/classes/Weapon/GetMinBurst.md b/docs/classes/Weapon/GetMinBurst.md
index 231a21366a..5eb75a49f2 100644
--- a/docs/classes/Weapon/GetMinBurst.md
+++ b/docs/classes/Weapon/GetMinBurst.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Get min burst."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Weapon
returns:
- type: integer
description: "Min burst."
diff --git a/docs/classes/Weapon/GetMinRestTime.md b/docs/classes/Weapon/GetMinRestTime.md
index 91fab3b2e3..96e320fc63 100644
--- a/docs/classes/Weapon/GetMinRestTime.md
+++ b/docs/classes/Weapon/GetMinRestTime.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Get min rest time."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Weapon
returns:
- type: number
description: "Min rest time."
diff --git a/docs/classes/Weapon/GetNextPrimaryFire.md b/docs/classes/Weapon/GetNextPrimaryFire.md
index 969fb9566f..948c8c5dea 100644
--- a/docs/classes/Weapon/GetNextPrimaryFire.md
+++ b/docs/classes/Weapon/GetNextPrimaryFire.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Get the time before the player can fire the primary attack."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Weapon
returns:
- type: number
description: "Time before the player can fire the primary attack."
diff --git a/docs/classes/Weapon/GetNextSecondaryFire.md b/docs/classes/Weapon/GetNextSecondaryFire.md
index ba5bd0354a..523b63f2a6 100644
--- a/docs/classes/Weapon/GetNextSecondaryFire.md
+++ b/docs/classes/Weapon/GetNextSecondaryFire.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Get the time before the player can fire the secondary attack."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Weapon
returns:
- type: number
description: "Time before the player can fire the secondary attack."
diff --git a/docs/classes/Weapon/GetOwner.md b/docs/classes/Weapon/GetOwner.md
index d00fdd3a0c..d055c930da 100644
--- a/docs/classes/Weapon/GetOwner.md
+++ b/docs/classes/Weapon/GetOwner.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Get owner."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Weapon
returns:
- type: Entity
description: "Owner entity."
diff --git a/docs/classes/Weapon/GetPrimaryAmmoCount.md b/docs/classes/Weapon/GetPrimaryAmmoCount.md
index c2251e7f32..ae46619488 100644
--- a/docs/classes/Weapon/GetPrimaryAmmoCount.md
+++ b/docs/classes/Weapon/GetPrimaryAmmoCount.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Get the amount of primary ammo."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Weapon
returns:
- type: integer
description: "Amount of primary ammo."
diff --git a/docs/classes/Weapon/GetPrimaryAmmoType.md b/docs/classes/Weapon/GetPrimaryAmmoType.md
index 440268c058..d2d6d333a3 100644
--- a/docs/classes/Weapon/GetPrimaryAmmoType.md
+++ b/docs/classes/Weapon/GetPrimaryAmmoType.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Get the primary ammo type."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Weapon
returns:
- type: integer
description: "Primary ammo type."
diff --git a/docs/classes/Weapon/GetPrimaryAttackActivity.md b/docs/classes/Weapon/GetPrimaryAttackActivity.md
index 99fafe9fc4..169d52deaf 100644
--- a/docs/classes/Weapon/GetPrimaryAttackActivity.md
+++ b/docs/classes/Weapon/GetPrimaryAttackActivity.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Get the primary attack activity."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Weapon
returns:
- type: integer
description: "Primary attack activity ID."
diff --git a/docs/classes/Weapon/GetPrintName.md b/docs/classes/Weapon/GetPrintName.md
index 14855d94cf..5a1cb320ed 100644
--- a/docs/classes/Weapon/GetPrintName.md
+++ b/docs/classes/Weapon/GetPrintName.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Get the print name."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Weapon
returns:
- type: string
description: "Print name."
diff --git a/docs/classes/Weapon/GetRandomBurst.md b/docs/classes/Weapon/GetRandomBurst.md
index b86631d517..8ecf3ee1b0 100644
--- a/docs/classes/Weapon/GetRandomBurst.md
+++ b/docs/classes/Weapon/GetRandomBurst.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Get a random burst."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Weapon
returns:
- type: integer
description: "Random burst."
diff --git a/docs/classes/Weapon/GetRumbleEffect.md b/docs/classes/Weapon/GetRumbleEffect.md
index 586807fcf9..f7cc779724 100644
--- a/docs/classes/Weapon/GetRumbleEffect.md
+++ b/docs/classes/Weapon/GetRumbleEffect.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Get the rumble effect."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Weapon
returns:
- type: integer
description: "Rumble effect."
diff --git a/docs/classes/Weapon/GetSecondaryAmmoCount.md b/docs/classes/Weapon/GetSecondaryAmmoCount.md
index b568ebbfcb..c8865e4267 100644
--- a/docs/classes/Weapon/GetSecondaryAmmoCount.md
+++ b/docs/classes/Weapon/GetSecondaryAmmoCount.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Get the amount of secondary ammo."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Weapon
returns:
- type: integer
description: "Amount of secondary ammo."
diff --git a/docs/classes/Weapon/GetSecondaryAmmoType.md b/docs/classes/Weapon/GetSecondaryAmmoType.md
index bf3be18ced..7b66df8a29 100644
--- a/docs/classes/Weapon/GetSecondaryAmmoType.md
+++ b/docs/classes/Weapon/GetSecondaryAmmoType.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Get the secondary ammo type."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Weapon
returns:
- type: integer
description: "Secondary ammo type."
diff --git a/docs/classes/Weapon/GetSecondaryAttackActivity.md b/docs/classes/Weapon/GetSecondaryAttackActivity.md
index e8fba17f1e..fb6147ba5d 100644
--- a/docs/classes/Weapon/GetSecondaryAttackActivity.md
+++ b/docs/classes/Weapon/GetSecondaryAttackActivity.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Get the secondary attack activity."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Weapon
returns:
- type: integer
description: "Secondary attack activity ID."
diff --git a/docs/classes/Weapon/GetShootSound.md b/docs/classes/Weapon/GetShootSound.md
index 5cfd3f2754..daf4ae7481 100644
--- a/docs/classes/Weapon/GetShootSound.md
+++ b/docs/classes/Weapon/GetShootSound.md
@@ -14,8 +14,12 @@ lua:
description: "Get the shoot sound."
arguments:
- - name: "index"
- type: number
+ - position: 1
+ name: "entity"
+ type: Weapon
+ - position: 2
+ name: "index"
+ type: number
returns:
- type: string
description: "Shoot sound."
diff --git a/docs/classes/Weapon/GetSlot.md b/docs/classes/Weapon/GetSlot.md
index 6a77c2700c..38adcb345a 100644
--- a/docs/classes/Weapon/GetSlot.md
+++ b/docs/classes/Weapon/GetSlot.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Get the slot."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Weapon
returns:
- type: integer
description: "Slot."
diff --git a/docs/classes/Weapon/GetSlotPosition.md b/docs/classes/Weapon/GetSlotPosition.md
index a45daf8b48..c98b5dd611 100644
--- a/docs/classes/Weapon/GetSlotPosition.md
+++ b/docs/classes/Weapon/GetSlotPosition.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Get the weapon slot position in the selection screen."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Weapon
returns:
- type: integer
description: "Position in the selection screen."
diff --git a/docs/classes/Weapon/GetSubType.md b/docs/classes/Weapon/GetSubType.md
index ff93689e73..7087b095c6 100644
--- a/docs/classes/Weapon/GetSubType.md
+++ b/docs/classes/Weapon/GetSubType.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Get the sub type."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Weapon
returns:
- type: integer
description: "Sub type."
diff --git a/docs/classes/Weapon/GetViewModelSequenceDuration.md b/docs/classes/Weapon/GetViewModelSequenceDuration.md
index c50f2adf9a..dfe80d7907 100644
--- a/docs/classes/Weapon/GetViewModelSequenceDuration.md
+++ b/docs/classes/Weapon/GetViewModelSequenceDuration.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Get the view model sequence duration."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Weapon
returns:
- type: number
description: "View model sequence duration."
diff --git a/docs/classes/Weapon/GetWeaponData.md b/docs/classes/Weapon/GetWeaponData.md
index 4cc088f4cf..c111e1441f 100644
--- a/docs/classes/Weapon/GetWeaponData.md
+++ b/docs/classes/Weapon/GetWeaponData.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Get weapon data"
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Weapon
returns:
- type: table
description: "Weapon data."
diff --git a/docs/classes/Weapon/GetWeaponFlags.md b/docs/classes/Weapon/GetWeaponFlags.md
index 6c962e8b6e..5680fc419e 100644
--- a/docs/classes/Weapon/GetWeaponFlags.md
+++ b/docs/classes/Weapon/GetWeaponFlags.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Get the weapon flags."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Weapon
returns:
- type: integer
description: "Weapon flags."
diff --git a/docs/classes/Weapon/GetWeaponIdleTime.md b/docs/classes/Weapon/GetWeaponIdleTime.md
index a5cb4ac215..12be560205 100644
--- a/docs/classes/Weapon/GetWeaponIdleTime.md
+++ b/docs/classes/Weapon/GetWeaponIdleTime.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Get the weapon idle time."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Weapon
returns:
- type: number
description: "Weapon idle time."
diff --git a/docs/classes/Weapon/GetWeaponViewModel.md b/docs/classes/Weapon/GetWeaponViewModel.md
new file mode 100644
index 0000000000..a47147d332
--- /dev/null
+++ b/docs/classes/Weapon/GetWeaponViewModel.md
@@ -0,0 +1,31 @@
+---
+template: lua-class-function.html
+title: GetWeaponViewModel
+icon: lua-shared
+tags:
+ - lua
+ - shared
+ - needs-verification
+ - needs-example
+lua:
+ library: Weapon
+ function: GetWeaponViewModel
+ realm: shared
+ description: "Get the view model."
+
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Weapon
+ - position: 2
+ name: "index"
+ type: number
+ default: "0"
+ returns:
+ - type: string
+ description: "View model."
+---
+
+
+Weapon:GetWeaponViewModel – Get the view model.
+
diff --git a/docs/classes/Weapon/GetWeight.md b/docs/classes/Weapon/GetWeight.md
index 455b733101..56e3fb41b3 100644
--- a/docs/classes/Weapon/GetWeight.md
+++ b/docs/classes/Weapon/GetWeight.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Get the weight."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Weapon
returns:
- type: integer
description: "Weight."
diff --git a/docs/classes/Weapon/GetWorldModel.md b/docs/classes/Weapon/GetWorldModel.md
index 244425a04c..a69f2e4594 100644
--- a/docs/classes/Weapon/GetWorldModel.md
+++ b/docs/classes/Weapon/GetWorldModel.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Get the world model."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Weapon
returns:
- type: string
description: "World model."
diff --git a/docs/classes/Weapon/GiveDefaultAmmo.md b/docs/classes/Weapon/GiveDefaultAmmo.md
index a0ca0b2d4f..fa7b28f1f6 100644
--- a/docs/classes/Weapon/GiveDefaultAmmo.md
+++ b/docs/classes/Weapon/GiveDefaultAmmo.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Give default ammo."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Weapon
returns:
---
diff --git a/docs/classes/Weapon/HandleFireOnEmpty.md b/docs/classes/Weapon/HandleFireOnEmpty.md
index f74024da69..70d60b94ef 100644
--- a/docs/classes/Weapon/HandleFireOnEmpty.md
+++ b/docs/classes/Weapon/HandleFireOnEmpty.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Handle fire on empty."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Weapon
returns:
---
diff --git a/docs/classes/Weapon/HasAmmo.md b/docs/classes/Weapon/HasAmmo.md
index 2d8b48b79a..489851b223 100644
--- a/docs/classes/Weapon/HasAmmo.md
+++ b/docs/classes/Weapon/HasAmmo.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Check if the weapon has ammo."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Weapon
returns:
- type: boolean
description: "Whether the weapon has ammo."
diff --git a/docs/classes/Weapon/HasAnyAmmo.md b/docs/classes/Weapon/HasAnyAmmo.md
index a98338b67f..5258d95450 100644
--- a/docs/classes/Weapon/HasAnyAmmo.md
+++ b/docs/classes/Weapon/HasAnyAmmo.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Check if the weapon has any ammo."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Weapon
returns:
- type: boolean
description: "Whether the weapon has any ammo."
diff --git a/docs/classes/Weapon/HasPrimaryAmmo.md b/docs/classes/Weapon/HasPrimaryAmmo.md
index 7e77586af4..653d97d105 100644
--- a/docs/classes/Weapon/HasPrimaryAmmo.md
+++ b/docs/classes/Weapon/HasPrimaryAmmo.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Check if the weapon has primary ammo."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Weapon
returns:
- type: boolean
description: "Whether the weapon has primary ammo."
diff --git a/docs/classes/Weapon/HasSecondaryAmmo.md b/docs/classes/Weapon/HasSecondaryAmmo.md
index 22e7670366..0463d9f5db 100644
--- a/docs/classes/Weapon/HasSecondaryAmmo.md
+++ b/docs/classes/Weapon/HasSecondaryAmmo.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Check if the weapon has secondary ammo."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Weapon
returns:
- type: boolean
description: "Whether the weapon has secondary ammo."
diff --git a/docs/classes/Weapon/HasWeaponIdleTimeElapsed.md b/docs/classes/Weapon/HasWeaponIdleTimeElapsed.md
index f1fa4e6a11..5f4e51853e 100644
--- a/docs/classes/Weapon/HasWeaponIdleTimeElapsed.md
+++ b/docs/classes/Weapon/HasWeaponIdleTimeElapsed.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Check if the weapon idle time has elapsed."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Weapon
returns:
- type: boolean
description: "Whether the weapon idle time has elapsed."
diff --git a/docs/classes/Weapon/HideThink.md b/docs/classes/Weapon/HideThink.md
index 0d8b241554..fd39e056bf 100644
--- a/docs/classes/Weapon/HideThink.md
+++ b/docs/classes/Weapon/HideThink.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Hide think."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Weapon
returns:
---
diff --git a/docs/classes/Weapon/IsAllowedToSwitch.md b/docs/classes/Weapon/IsAllowedToSwitch.md
index 85119cd1cb..7dbb5cf2a0 100644
--- a/docs/classes/Weapon/IsAllowedToSwitch.md
+++ b/docs/classes/Weapon/IsAllowedToSwitch.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Check if the weapon is allowed to switch."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Weapon
returns:
- type: boolean
description: "Whether the weapon is allowed to switch."
diff --git a/docs/classes/Weapon/IsLocked.md b/docs/classes/Weapon/IsLocked.md
index d6781b6dd6..0298a370b6 100644
--- a/docs/classes/Weapon/IsLocked.md
+++ b/docs/classes/Weapon/IsLocked.md
@@ -14,8 +14,12 @@ lua:
description: "Check if the weapon is locked."
arguments:
- - name: "asker"
- type: Entity
+ - position: 1
+ name: "entity"
+ type: Weapon
+ - position: 2
+ name: "asker"
+ type: Entity
returns:
- type: boolean
description: "Whether the weapon is locked."
diff --git a/docs/classes/Weapon/IsMeleeWeapon.md b/docs/classes/Weapon/IsMeleeWeapon.md
index 7689bea676..f5dd313bb9 100644
--- a/docs/classes/Weapon/IsMeleeWeapon.md
+++ b/docs/classes/Weapon/IsMeleeWeapon.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Check if the weapon is a melee weapon."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Weapon
returns:
- type: boolean
description: "Whether the weapon is a melee weapon."
diff --git a/docs/classes/Weapon/IsPredicted.md b/docs/classes/Weapon/IsPredicted.md
index d32c9ecd1c..691ec948fb 100644
--- a/docs/classes/Weapon/IsPredicted.md
+++ b/docs/classes/Weapon/IsPredicted.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Check if the weapon is predicted."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Weapon
returns:
- type: boolean
description: "Whether the weapon is predicted."
diff --git a/docs/classes/Weapon/IsScripted.md b/docs/classes/Weapon/IsScripted.md
index dabea5a341..cf3bdb254d 100644
--- a/docs/classes/Weapon/IsScripted.md
+++ b/docs/classes/Weapon/IsScripted.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Check if the weapon is scripted."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Weapon
returns:
- type: boolean
description: "Whether the weapon is scripted."
diff --git a/docs/classes/Weapon/IsViewModelSequenceFinished.md b/docs/classes/Weapon/IsViewModelSequenceFinished.md
index 87c7af2c1b..bad46f91dc 100644
--- a/docs/classes/Weapon/IsViewModelSequenceFinished.md
+++ b/docs/classes/Weapon/IsViewModelSequenceFinished.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Check if the view model sequence is finished."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Weapon
returns:
- type: boolean
description: "Whether the view model sequence is finished."
diff --git a/docs/classes/Weapon/IsWeaponVisible.md b/docs/classes/Weapon/IsWeaponVisible.md
index 57ccb0cf99..4c8ca29424 100644
--- a/docs/classes/Weapon/IsWeaponVisible.md
+++ b/docs/classes/Weapon/IsWeaponVisible.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Check if the weapon is visible."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Weapon
returns:
- type: boolean
description: "Whether the weapon is visible."
diff --git a/docs/classes/Weapon/IsWeaponZoomed.md b/docs/classes/Weapon/IsWeaponZoomed.md
index d1e147c780..82dbbbc417 100644
--- a/docs/classes/Weapon/IsWeaponZoomed.md
+++ b/docs/classes/Weapon/IsWeaponZoomed.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Check if the weapon is zoomed."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Weapon
returns:
- type: boolean
description: "Whether the weapon is zoomed."
diff --git a/docs/classes/Weapon/ItemBusyFrame.md b/docs/classes/Weapon/ItemBusyFrame.md
index a9bc0e1335..f871b87b57 100644
--- a/docs/classes/Weapon/ItemBusyFrame.md
+++ b/docs/classes/Weapon/ItemBusyFrame.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Item busy frame."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Weapon
returns:
---
diff --git a/docs/classes/Weapon/ItemHolsterFrame.md b/docs/classes/Weapon/ItemHolsterFrame.md
index a0989332fd..6a2b4121c5 100644
--- a/docs/classes/Weapon/ItemHolsterFrame.md
+++ b/docs/classes/Weapon/ItemHolsterFrame.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Item holster frame."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Weapon
returns:
---
diff --git a/docs/classes/Weapon/Lock.md b/docs/classes/Weapon/Lock.md
index aceb1137bc..55942f51b1 100644
--- a/docs/classes/Weapon/Lock.md
+++ b/docs/classes/Weapon/Lock.md
@@ -14,10 +14,15 @@ lua:
description: "Lock the weapon."
arguments:
- - name: "lockTime"
- type: number
- - name: "locker"
- type: Entity
+ - position: 1
+ name: "entity"
+ type: Weapon
+ - position: 2
+ name: "lockTime"
+ type: number
+ - position: 3
+ name: "locker"
+ type: Entity
returns:
---
diff --git a/docs/classes/Weapon/Lower.md b/docs/classes/Weapon/Lower.md
index 7c421f25e8..6c491b7672 100644
--- a/docs/classes/Weapon/Lower.md
+++ b/docs/classes/Weapon/Lower.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Lower the weapon."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Weapon
returns:
- type: boolean
description: "Whether the weapon was lowered."
diff --git a/docs/classes/Weapon/MaintainIdealActivity.md b/docs/classes/Weapon/MaintainIdealActivity.md
index b1e2cb8406..c8f36c29ac 100644
--- a/docs/classes/Weapon/MaintainIdealActivity.md
+++ b/docs/classes/Weapon/MaintainIdealActivity.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Maintain ideal activity."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Weapon
returns:
---
diff --git a/docs/classes/Weapon/OnActiveStateChanged.md b/docs/classes/Weapon/OnActiveStateChanged.md
index b86084e4ef..e69dd76298 100644
--- a/docs/classes/Weapon/OnActiveStateChanged.md
+++ b/docs/classes/Weapon/OnActiveStateChanged.md
@@ -14,8 +14,12 @@ lua:
description: "On active state changed."
arguments:
- - name: "oldState"
- type: number
+ - position: 1
+ name: "entity"
+ type: Weapon
+ - position: 2
+ name: "oldState"
+ type: number
returns:
---
diff --git a/docs/classes/Weapon/PrimaryAttack.md b/docs/classes/Weapon/PrimaryAttack.md
index a8f9c48bc8..b563c8b1a3 100644
--- a/docs/classes/Weapon/PrimaryAttack.md
+++ b/docs/classes/Weapon/PrimaryAttack.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Primary attack."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Weapon
returns:
---
diff --git a/docs/classes/Weapon/Ready.md b/docs/classes/Weapon/Ready.md
index e1e411e6d0..a50388891b 100644
--- a/docs/classes/Weapon/Ready.md
+++ b/docs/classes/Weapon/Ready.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Ready."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Weapon
returns:
- type: boolean
description: "Whether the weapon is ready."
diff --git a/docs/classes/Weapon/Reload.md b/docs/classes/Weapon/Reload.md
index 587f0bb5fa..f2987cc38e 100644
--- a/docs/classes/Weapon/Reload.md
+++ b/docs/classes/Weapon/Reload.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Reload."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Weapon
returns:
---
diff --git a/docs/classes/Weapon/ReloadOrSwitchWeapons.md b/docs/classes/Weapon/ReloadOrSwitchWeapons.md
index ba35ccbcdc..01856f75d9 100644
--- a/docs/classes/Weapon/ReloadOrSwitchWeapons.md
+++ b/docs/classes/Weapon/ReloadOrSwitchWeapons.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Reload or switch weapons."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Weapon
returns:
---
diff --git a/docs/classes/Weapon/RescindAltFireHudHint.md b/docs/classes/Weapon/RescindAltFireHudHint.md
index b0cf4dde18..e9b3884a12 100644
--- a/docs/classes/Weapon/RescindAltFireHudHint.md
+++ b/docs/classes/Weapon/RescindAltFireHudHint.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Rescind alt fire HUD hint."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Weapon
returns:
---
diff --git a/docs/classes/Weapon/RescindReloadHudHint.md b/docs/classes/Weapon/RescindReloadHudHint.md
index 4fa54187dc..50523b7969 100644
--- a/docs/classes/Weapon/RescindReloadHudHint.md
+++ b/docs/classes/Weapon/RescindReloadHudHint.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Rescind reload HUD hint."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Weapon
returns:
---
diff --git a/docs/classes/Weapon/SecondaryAttack.md b/docs/classes/Weapon/SecondaryAttack.md
index 9fb05eed73..350c8c40b4 100644
--- a/docs/classes/Weapon/SecondaryAttack.md
+++ b/docs/classes/Weapon/SecondaryAttack.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Secondary attack."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Weapon
returns:
---
diff --git a/docs/classes/Weapon/SendViewModelAnimation.md b/docs/classes/Weapon/SendViewModelAnimation.md
index 2b3697099a..d87f5eec9a 100644
--- a/docs/classes/Weapon/SendViewModelAnimation.md
+++ b/docs/classes/Weapon/SendViewModelAnimation.md
@@ -14,8 +14,12 @@ lua:
description: "Send view model animation."
arguments:
- - name: "sequence"
- type: number
+ - position: 1
+ name: "entity"
+ type: Weapon
+ - position: 2
+ name: "sequence"
+ type: number
returns:
---
diff --git a/docs/classes/Weapon/SendWeaponAnimation.md b/docs/classes/Weapon/SendWeaponAnimation.md
index 69f345969a..28f02aaedc 100644
--- a/docs/classes/Weapon/SendWeaponAnimation.md
+++ b/docs/classes/Weapon/SendWeaponAnimation.md
@@ -14,8 +14,12 @@ lua:
description: "Send weapon animation."
arguments:
- - name: "activity"
- type: number
+ - position: 1
+ name: "entity"
+ type: Weapon
+ - position: 2
+ name: "activity"
+ type: number
returns:
---
diff --git a/docs/classes/Weapon/SetActivity.md b/docs/classes/Weapon/SetActivity.md
index fb725706ab..7b288f405b 100644
--- a/docs/classes/Weapon/SetActivity.md
+++ b/docs/classes/Weapon/SetActivity.md
@@ -14,8 +14,12 @@ lua:
description: "Set activity."
arguments:
- - name: "activity"
- type: number
+ - position: 1
+ name: "entity"
+ type: Weapon
+ - position: 2
+ name: "activity"
+ type: number
returns:
---
diff --git a/docs/classes/Weapon/SetAnimationPrefix.md b/docs/classes/Weapon/SetAnimationPrefix.md
index 907582c884..257897329c 100644
--- a/docs/classes/Weapon/SetAnimationPrefix.md
+++ b/docs/classes/Weapon/SetAnimationPrefix.md
@@ -14,8 +14,12 @@ lua:
description: "Set animation prefix."
arguments:
- - name: "prefix"
- type: string
+ - position: 1
+ name: "entity"
+ type: Weapon
+ - position: 2
+ name: "prefix"
+ type: string
returns:
---
diff --git a/docs/classes/Weapon/SetClip1.md b/docs/classes/Weapon/SetClip1.md
index f11e6afe4d..91f4b396af 100644
--- a/docs/classes/Weapon/SetClip1.md
+++ b/docs/classes/Weapon/SetClip1.md
@@ -14,8 +14,12 @@ lua:
description: "Set the amount of ammo in the primary clip."
arguments:
- - name: "clip"
- type: number
+ - position: 1
+ name: "entity"
+ type: Weapon
+ - position: 2
+ name: "clip"
+ type: number
returns:
---
diff --git a/docs/classes/Weapon/SetClip2.md b/docs/classes/Weapon/SetClip2.md
index 7bab7035a2..8926f4d1fc 100644
--- a/docs/classes/Weapon/SetClip2.md
+++ b/docs/classes/Weapon/SetClip2.md
@@ -14,8 +14,12 @@ lua:
description: "Set the amount of ammo in the secondary clip."
arguments:
- - name: "clip"
- type: number
+ - position: 1
+ name: "entity"
+ type: Weapon
+ - position: 2
+ name: "clip"
+ type: number
returns:
---
diff --git a/docs/classes/Weapon/SetIdealActivity.md b/docs/classes/Weapon/SetIdealActivity.md
index 2094e637a9..cd7dae19de 100644
--- a/docs/classes/Weapon/SetIdealActivity.md
+++ b/docs/classes/Weapon/SetIdealActivity.md
@@ -14,8 +14,12 @@ lua:
description: "Set ideal activity."
arguments:
- - name: "activity"
- type: number
+ - position: 1
+ name: "entity"
+ type: Weapon
+ - position: 2
+ name: "activity"
+ type: number
returns:
---
diff --git a/docs/classes/Weapon/SetNextPrimaryFire.md b/docs/classes/Weapon/SetNextPrimaryFire.md
index b2b33e2e84..fb35e43ca2 100644
--- a/docs/classes/Weapon/SetNextPrimaryFire.md
+++ b/docs/classes/Weapon/SetNextPrimaryFire.md
@@ -14,8 +14,12 @@ lua:
description: "Set next time before the player can fire the primary attack. E.g: `Engines.GetCurrentTime() + 2` for two seconds from now."
arguments:
- - name: "absoluteCurTime"
- type: number
+ - position: 1
+ name: "entity"
+ type: Weapon
+ - position: 2
+ name: "absoluteCurTime"
+ type: number
returns:
---
diff --git a/docs/classes/Weapon/SetNextSecondaryFire.md b/docs/classes/Weapon/SetNextSecondaryFire.md
index 9e211d2b44..b973148cac 100644
--- a/docs/classes/Weapon/SetNextSecondaryFire.md
+++ b/docs/classes/Weapon/SetNextSecondaryFire.md
@@ -14,8 +14,12 @@ lua:
description: "Set next time before the player can fire the secondary attack. E.g: `Engines.GetCurrentTime() + 2` for two seconds from now."
arguments:
- - name: "absoluteCurTime"
- type: number
+ - position: 1
+ name: "entity"
+ type: Weapon
+ - position: 2
+ name: "absoluteCurTime"
+ type: number
returns:
---
diff --git a/docs/classes/Weapon/SetPickupTouch.md b/docs/classes/Weapon/SetPickupTouch.md
index aaf932c2a4..844ead60a8 100644
--- a/docs/classes/Weapon/SetPickupTouch.md
+++ b/docs/classes/Weapon/SetPickupTouch.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Set pickup touch."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Weapon
returns:
---
diff --git a/docs/classes/Weapon/SetPrimaryAmmoCount.md b/docs/classes/Weapon/SetPrimaryAmmoCount.md
index ae7cb0cd8a..57b683ef8f 100644
--- a/docs/classes/Weapon/SetPrimaryAmmoCount.md
+++ b/docs/classes/Weapon/SetPrimaryAmmoCount.md
@@ -14,8 +14,12 @@ lua:
description: "Set primary ammo count."
arguments:
- - name: "count"
- type: number
+ - position: 1
+ name: "entity"
+ type: Weapon
+ - position: 2
+ name: "count"
+ type: number
returns:
---
diff --git a/docs/classes/Weapon/SetSecondaryAmmoCount.md b/docs/classes/Weapon/SetSecondaryAmmoCount.md
index e7a5d52340..c3cc14972b 100644
--- a/docs/classes/Weapon/SetSecondaryAmmoCount.md
+++ b/docs/classes/Weapon/SetSecondaryAmmoCount.md
@@ -14,8 +14,12 @@ lua:
description: "Set secondary ammo count."
arguments:
- - name: "count"
- type: number
+ - position: 1
+ name: "entity"
+ type: Weapon
+ - position: 2
+ name: "count"
+ type: number
returns:
---
diff --git a/docs/classes/Weapon/SetSubType.md b/docs/classes/Weapon/SetSubType.md
index d3cfd2c0b7..a3cb593e02 100644
--- a/docs/classes/Weapon/SetSubType.md
+++ b/docs/classes/Weapon/SetSubType.md
@@ -14,8 +14,12 @@ lua:
description: "Set sub type."
arguments:
- - name: "subType"
- type: number
+ - position: 1
+ name: "entity"
+ type: Weapon
+ - position: 2
+ name: "subType"
+ type: number
returns:
---
diff --git a/docs/classes/Weapon/SetViewModel.md b/docs/classes/Weapon/SetViewModel.md
index d77e63d980..aaa4928d16 100644
--- a/docs/classes/Weapon/SetViewModel.md
+++ b/docs/classes/Weapon/SetViewModel.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Set view model."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Weapon
returns:
---
diff --git a/docs/classes/Weapon/SetViewModelIndex.md b/docs/classes/Weapon/SetViewModelIndex.md
index bd9a49690b..d7c839ef19 100644
--- a/docs/classes/Weapon/SetViewModelIndex.md
+++ b/docs/classes/Weapon/SetViewModelIndex.md
@@ -14,8 +14,12 @@ lua:
description: "Set view model index."
arguments:
- - name: "index"
- type: number
+ - position: 1
+ name: "entity"
+ type: Weapon
+ - position: 2
+ name: "index"
+ type: number
returns:
---
diff --git a/docs/classes/Weapon/SetWeaponIdleTime.md b/docs/classes/Weapon/SetWeaponIdleTime.md
index 5ec79fd862..fd67221bde 100644
--- a/docs/classes/Weapon/SetWeaponIdleTime.md
+++ b/docs/classes/Weapon/SetWeaponIdleTime.md
@@ -14,8 +14,12 @@ lua:
description: "Set weapon idle time."
arguments:
- - name: "time"
- type: number
+ - position: 1
+ name: "entity"
+ type: Weapon
+ - position: 2
+ name: "time"
+ type: number
returns:
---
diff --git a/docs/classes/Weapon/SetWeaponVisible.md b/docs/classes/Weapon/SetWeaponVisible.md
index 80bde72c22..093301a69d 100644
--- a/docs/classes/Weapon/SetWeaponVisible.md
+++ b/docs/classes/Weapon/SetWeaponVisible.md
@@ -14,8 +14,12 @@ lua:
description: "Set weapon visible."
arguments:
- - name: "visible"
- type: boolean
+ - position: 1
+ name: "entity"
+ type: Weapon
+ - position: 2
+ name: "visible"
+ type: boolean
returns:
---
diff --git a/docs/classes/Weapon/ShouldDisplayAltFireHUDHint.md b/docs/classes/Weapon/ShouldDisplayAltFireHUDHint.md
index 200f528b7c..3a8a275e6e 100644
--- a/docs/classes/Weapon/ShouldDisplayAltFireHUDHint.md
+++ b/docs/classes/Weapon/ShouldDisplayAltFireHUDHint.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Should display alt fire HUD hint."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Weapon
returns:
- type: boolean
description: "Whether the alt fire HUD hint should be displayed."
diff --git a/docs/classes/Weapon/ShouldDisplayReloadHUDHint.md b/docs/classes/Weapon/ShouldDisplayReloadHUDHint.md
index 26ac08228b..4c2257210e 100644
--- a/docs/classes/Weapon/ShouldDisplayReloadHUDHint.md
+++ b/docs/classes/Weapon/ShouldDisplayReloadHUDHint.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Should display reload HUD hint."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Weapon
returns:
- type: boolean
description: "Whether the reload HUD hint should be displayed."
diff --git a/docs/classes/Weapon/ShouldShowControlPanels.md b/docs/classes/Weapon/ShouldShowControlPanels.md
index a33e4e79f6..db316f62d5 100644
--- a/docs/classes/Weapon/ShouldShowControlPanels.md
+++ b/docs/classes/Weapon/ShouldShowControlPanels.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Should show control panels."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Weapon
returns:
- type: boolean
description: "Whether the control panels should be shown."
diff --git a/docs/classes/Weapon/StartSprinting.md b/docs/classes/Weapon/StartSprinting.md
index 1bad700023..73333e6c8b 100644
--- a/docs/classes/Weapon/StartSprinting.md
+++ b/docs/classes/Weapon/StartSprinting.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Start sprinting."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Weapon
returns:
- type: boolean
description: "Whether sprinting was started."
diff --git a/docs/classes/Weapon/StopSprinting.md b/docs/classes/Weapon/StopSprinting.md
index 1483ccc62c..94812424b9 100644
--- a/docs/classes/Weapon/StopSprinting.md
+++ b/docs/classes/Weapon/StopSprinting.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Stop sprinting."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Weapon
returns:
- type: boolean
description: "Whether sprinting was stopped."
diff --git a/docs/classes/Weapon/StopWeaponSound.md b/docs/classes/Weapon/StopWeaponSound.md
index 3643fc3136..009af593eb 100644
--- a/docs/classes/Weapon/StopWeaponSound.md
+++ b/docs/classes/Weapon/StopWeaponSound.md
@@ -14,8 +14,12 @@ lua:
description: "Stop weapon sound."
arguments:
- - name: "soundType"
- type: number
+ - position: 1
+ name: "entity"
+ type: Weapon
+ - position: 2
+ name: "soundType"
+ type: number
returns:
---
diff --git a/docs/classes/Weapon/UsesClipsForAmmo1.md b/docs/classes/Weapon/UsesClipsForAmmo1.md
index 11ab2b5d20..0f9be76c77 100644
--- a/docs/classes/Weapon/UsesClipsForAmmo1.md
+++ b/docs/classes/Weapon/UsesClipsForAmmo1.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Uses clips for ammo 1."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Weapon
returns:
- type: boolean
description: "Whether clips are used for ammo 1."
diff --git a/docs/classes/Weapon/UsesClipsForAmmo2.md b/docs/classes/Weapon/UsesClipsForAmmo2.md
index 84f72a1a22..dea325f7f2 100644
--- a/docs/classes/Weapon/UsesClipsForAmmo2.md
+++ b/docs/classes/Weapon/UsesClipsForAmmo2.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Uses clips for ammo 2."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Weapon
returns:
- type: boolean
description: "Whether clips are used for ammo 2."
diff --git a/docs/classes/Weapon/UsesPrimaryAmmo.md b/docs/classes/Weapon/UsesPrimaryAmmo.md
index 4ead8fff59..e4c03ce155 100644
--- a/docs/classes/Weapon/UsesPrimaryAmmo.md
+++ b/docs/classes/Weapon/UsesPrimaryAmmo.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Uses primary ammo."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Weapon
returns:
- type: boolean
description: "Whether primary ammo is used."
diff --git a/docs/classes/Weapon/UsesSecondaryAmmo.md b/docs/classes/Weapon/UsesSecondaryAmmo.md
index dc15bc1be1..949f04b3d1 100644
--- a/docs/classes/Weapon/UsesSecondaryAmmo.md
+++ b/docs/classes/Weapon/UsesSecondaryAmmo.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Uses secondary ammo."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Weapon
returns:
- type: boolean
description: "Whether secondary ammo is used."
diff --git a/docs/classes/Weapon/VisibleInWeaponSelection.md b/docs/classes/Weapon/VisibleInWeaponSelection.md
index 1b0aae4373..474a35f3e9 100644
--- a/docs/classes/Weapon/VisibleInWeaponSelection.md
+++ b/docs/classes/Weapon/VisibleInWeaponSelection.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Visible in weapon selection."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Weapon
returns:
- type: boolean
description: "Whether the weapon is visible in weapon selection."
diff --git a/docs/classes/Weapon/WeaponAutoAimScale.md b/docs/classes/Weapon/WeaponAutoAimScale.md
index 7d9f597c7c..e247cf9634 100644
--- a/docs/classes/Weapon/WeaponAutoAimScale.md
+++ b/docs/classes/Weapon/WeaponAutoAimScale.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Weapon auto aim scale."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Weapon
returns:
- type: number
description: "Weapon auto aim scale."
diff --git a/docs/classes/Weapon/WeaponIdle.md b/docs/classes/Weapon/WeaponIdle.md
index d8a04e54ab..91369759c6 100644
--- a/docs/classes/Weapon/WeaponIdle.md
+++ b/docs/classes/Weapon/WeaponIdle.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Weapon idle."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Weapon
returns:
---
diff --git a/docs/classes/Weapon/ItemPostFrame.md b/docs/classes/Weapon/WeaponItemPostFrame.md
similarity index 59%
rename from docs/classes/Weapon/ItemPostFrame.md
rename to docs/classes/Weapon/WeaponItemPostFrame.md
index 9a3f5b6351..4a8f708d66 100644
--- a/docs/classes/Weapon/ItemPostFrame.md
+++ b/docs/classes/Weapon/WeaponItemPostFrame.md
@@ -1,6 +1,6 @@
---
template: lua-class-function.html
-title: ItemPostFrame
+title: WeaponItemPostFrame
icon: lua-shared
tags:
- lua
@@ -9,15 +9,18 @@ tags:
- needs-example
lua:
library: Weapon
- function: ItemPostFrame
+ function: WeaponItemPostFrame
realm: shared
description: "Item post frame."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Weapon
returns:
---
-Weapon:ItemPostFrame – Item post frame.
+Weapon:WeaponItemPostFrame – Item post frame.
diff --git a/docs/classes/Weapon/ItemPreFrame.md b/docs/classes/Weapon/WeaponItemPreFrame.md
similarity index 60%
rename from docs/classes/Weapon/ItemPreFrame.md
rename to docs/classes/Weapon/WeaponItemPreFrame.md
index d54522b61b..db4b709ffe 100644
--- a/docs/classes/Weapon/ItemPreFrame.md
+++ b/docs/classes/Weapon/WeaponItemPreFrame.md
@@ -1,6 +1,6 @@
---
template: lua-class-function.html
-title: ItemPreFrame
+title: WeaponItemPreFrame
icon: lua-shared
tags:
- lua
@@ -9,15 +9,18 @@ tags:
- needs-example
lua:
library: Weapon
- function: ItemPreFrame
+ function: WeaponItemPreFrame
realm: shared
description: "Item pre frame."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Weapon
returns:
---
-Weapon:ItemPreFrame – Item pre frame.
+Weapon:WeaponItemPreFrame – Item pre frame.
diff --git a/docs/classes/Weapon/WeaponState.md b/docs/classes/Weapon/WeaponState.md
index 9d5ac117c0..0c557ec9e1 100644
--- a/docs/classes/Weapon/WeaponState.md
+++ b/docs/classes/Weapon/WeaponState.md
@@ -13,7 +13,10 @@ lua:
realm: shared
description: "Weapon state."
-
+ arguments:
+ - position: 1
+ name: "entity"
+ type: Weapon
returns:
- type: number
description: "Weapon state."
diff --git a/docs/classes/WebConnectionHeadersHandle/__index.md b/docs/classes/WebConnectionHeadersHandle/__index.md
new file mode 100644
index 0000000000..6d6e0f17e0
--- /dev/null
+++ b/docs/classes/WebConnectionHeadersHandle/__index.md
@@ -0,0 +1,29 @@
+---
+template: lua-class-function.html
+title: __index
+icon: lua-client
+tags:
+ - lua
+ - client
+ - needs-verification
+ - needs-example
+lua:
+ library: WebConnectionHeadersHandle
+ function: __index
+ realm: client
+ description: "Get the headers of the HTTP request"
+
+ arguments:
+ - position: 1
+ name: "webConnectionHeaders"
+ type: table
+ - position: 2
+ name: "headerName"
+ type: string
+ returns:
+
+---
+
+
+WebConnectionHeadersHandle:__index – Get the headers of the HTTP request
+
diff --git a/docs/classes/WebConnectionHeadersHandle/index.md b/docs/classes/WebConnectionHeadersHandle/index.md
new file mode 100644
index 0000000000..1c6f2b49c8
--- /dev/null
+++ b/docs/classes/WebConnectionHeadersHandle/index.md
@@ -0,0 +1,10 @@
+---
+template: lua-index.html
+childrenTitle: Methods
+include:
+ startsWith: classes/WebConnectionHeadersHandle/
+exclude:
+ isIndex: true
+---
+
+# WebConnectionHeadersHandle
diff --git a/docs/enumerations/CHAT_MESSAGE_MODE.md b/docs/enumerations/CHAT_MESSAGE_MODE.md
new file mode 100644
index 0000000000..6aae8e3473
--- /dev/null
+++ b/docs/enumerations/CHAT_MESSAGE_MODE.md
@@ -0,0 +1,23 @@
+---
+template: lua-enumeration.html
+title: CHAT_MESSAGE_MODE
+icon: lua-client
+tags:
+ - lua
+ - client
+ - needs-verification
+ - needs-example
+lua:
+ library: CHAT_MESSAGE_MODE
+ realm: client
+ description: ''
+ enumerations:
+ NONE: 0
+ GLOBAL: 1
+ TEAM: 2
+
+---
+
+
+CHAT_MESSAGE_MODE: NONE(0) GLOBAL(1) TEAM(2)
+
diff --git a/docs/enumerations/PLAY_SOUND_FLAG.md b/docs/enumerations/PLAY_SOUND_FLAG.md
new file mode 100644
index 0000000000..27c06ec40a
--- /dev/null
+++ b/docs/enumerations/PLAY_SOUND_FLAG.md
@@ -0,0 +1,25 @@
+---
+template: lua-enumeration.html
+title: PLAY_SOUND_FLAG
+icon: lua-client
+tags:
+ - lua
+ - client
+ - needs-verification
+ - needs-example
+lua:
+ library: PLAY_SOUND_FLAG
+ realm: client
+ description: ''
+ enumerations:
+ SAMPLE_3D: 1
+ SAMPLE_MONO: 2
+ SAMPLE_LOOP: 4
+ DONT_PLAY: 8
+ STREAM_BLOCK: 16
+
+---
+
+
+PLAY_SOUND_FLAG: SAMPLE_3D(1) SAMPLE_MONO(2) SAMPLE_LOOP(4) DONT_PLAY(8) STREAM_BLOCK(16)
+
diff --git a/docs/enumerations/STENCIL_COMPARISON_FUNCTION.md b/docs/enumerations/STENCIL_COMPARISON_FUNCTION.md
new file mode 100644
index 0000000000..75d0255651
--- /dev/null
+++ b/docs/enumerations/STENCIL_COMPARISON_FUNCTION.md
@@ -0,0 +1,28 @@
+---
+template: lua-enumeration.html
+title: STENCIL_COMPARISON_FUNCTION
+icon: lua-client
+tags:
+ - lua
+ - client
+ - needs-verification
+ - needs-example
+lua:
+ library: STENCIL_COMPARISON_FUNCTION
+ realm: client
+ description: ''
+ enumerations:
+ NEVER: 1
+ LESS: 2
+ EQUAL: 3
+ LESS_OR_EQUAL: 4
+ GREATER: 5
+ NOT_EQUAL: 6
+ GREATER_OR_EQUAL: 7
+ ALWAYS: 8
+
+---
+
+
+STENCIL_COMPARISON_FUNCTION: NEVER(1) LESS(2) EQUAL(3) LESS_OR_EQUAL(4) GREATER(5) NOT_EQUAL(6) GREATER_OR_EQUAL(7) ALWAYS(8)
+
diff --git a/docs/enumerations/STENCIL_OPERATION.md b/docs/enumerations/STENCIL_OPERATION.md
new file mode 100644
index 0000000000..cb08956bdb
--- /dev/null
+++ b/docs/enumerations/STENCIL_OPERATION.md
@@ -0,0 +1,28 @@
+---
+template: lua-enumeration.html
+title: STENCIL_OPERATION
+icon: lua-client
+tags:
+ - lua
+ - client
+ - needs-verification
+ - needs-example
+lua:
+ library: STENCIL_OPERATION
+ realm: client
+ description: ''
+ enumerations:
+ KEEP: 1
+ ZERO: 2
+ REPLACE: 3
+ INCREMENT_CLAMP: 4
+ DECREMENT_CLAMP: 5
+ INVERT: 6
+ INCREMENT_WRAP: 7
+ DECREMENT_WRAP: 8
+
+---
+
+
+STENCIL_OPERATION: KEEP(1) ZERO(2) REPLACE(3) INCREMENT_CLAMP(4) DECREMENT_CLAMP(5) INVERT(6) INCREMENT_WRAP(7) DECREMENT_WRAP(8)
+
diff --git a/docs/hooks/client/DrawHeadLabels.md b/docs/hooks/client/DrawHeadLabels.md
index 081c254c96..60e087ea95 100644
--- a/docs/hooks/client/DrawHeadLabels.md
+++ b/docs/hooks/client/DrawHeadLabels.md
@@ -14,7 +14,7 @@ lua:
arguments:
- name: "pPlayer"
description: ""
- type: Entity
+ type: Player
returns:
- type: unknown
description: ""
diff --git a/docs/hooks/client/FinishMove.md b/docs/hooks/client/FinishMove.md
index 0a8d206826..07e12c0470 100644
--- a/docs/hooks/client/FinishMove.md
+++ b/docs/hooks/client/FinishMove.md
@@ -14,7 +14,7 @@ lua:
arguments:
- name: "player"
description: ""
- type: Entity
+ type: Player
- name: "move"
description: ""
type: MoveData
diff --git a/docs/hooks/client/GetPlayerTextColor.md b/docs/hooks/client/GetPlayerTextColor.md
index 68d0518638..519cf42021 100644
--- a/docs/hooks/client/GetPlayerTextColor.md
+++ b/docs/hooks/client/GetPlayerTextColor.md
@@ -14,7 +14,7 @@ lua:
arguments:
- name: "player"
description: ""
- type: Player
+ type: Entity
- name: "color"
description: "the color of the player's name in the scoreboard"
type: Color
diff --git a/docs/hooks/client/NetworkEntityCreated.md b/docs/hooks/client/NetworkEntityCreated.md
index 9ae48c01f6..e232404d32 100644
--- a/docs/hooks/client/NetworkEntityCreated.md
+++ b/docs/hooks/client/NetworkEntityCreated.md
@@ -12,7 +12,9 @@ lua:
realm: client
description: ""
arguments:
-
+ - name: "this"
+ description: ""
+ type: Entity
returns:
---
diff --git a/docs/hooks/client/OnEntityCreated.md b/docs/hooks/client/OnEntityCreated.md
index 1eccaf523e..d04e1ad12f 100644
--- a/docs/hooks/client/OnEntityCreated.md
+++ b/docs/hooks/client/OnEntityCreated.md
@@ -12,7 +12,7 @@ lua:
realm: client
description: ""
arguments:
- - name: "pEntity"
+ - name: "this"
description: ""
type: Entity
returns:
diff --git a/docs/hooks/client/PlayerPostThink.md b/docs/hooks/client/PlayerPostThink.md
index 2105828243..c8f9972f2d 100644
--- a/docs/hooks/client/PlayerPostThink.md
+++ b/docs/hooks/client/PlayerPostThink.md
@@ -14,7 +14,7 @@ lua:
arguments:
- name: "player"
description: ""
- type: Entity
+ type: Player
returns:
---
diff --git a/docs/hooks/client/PostDrawViewModel.md b/docs/hooks/client/PostDrawViewModel.md
index 6cf7b5ba3f..61553a5fe1 100644
--- a/docs/hooks/client/PostDrawViewModel.md
+++ b/docs/hooks/client/PostDrawViewModel.md
@@ -17,7 +17,7 @@ lua:
type: Entity
- name: "pPlayer"
description: ""
- type: Entity
+ type: Player
- name: "pWeapon"
description: ""
type: Entity
diff --git a/docs/hooks/client/PreDrawViewModel.md b/docs/hooks/client/PreDrawViewModel.md
index db7d923064..726475c092 100644
--- a/docs/hooks/client/PreDrawViewModel.md
+++ b/docs/hooks/client/PreDrawViewModel.md
@@ -17,7 +17,7 @@ lua:
type: Entity
- name: "pPlayer"
description: ""
- type: Entity
+ type: Player
- name: "pWeapon"
description: ""
type: Entity
diff --git a/docs/classes/HTML/OnMove.md b/docs/hooks/client/ScoreboardHide.md
similarity index 50%
rename from docs/classes/HTML/OnMove.md
rename to docs/hooks/client/ScoreboardHide.md
index c87663ee1c..84b549765f 100644
--- a/docs/classes/HTML/OnMove.md
+++ b/docs/hooks/client/ScoreboardHide.md
@@ -1,6 +1,6 @@
---
-template: lua-class-function.html
-title: OnMove
+template: lua-hook.html
+title: ScoreboardHide
icon: lua-client
tags:
- lua
@@ -8,16 +8,15 @@ tags:
- needs-verification
- needs-example
lua:
- library: HTML
- function: OnMove
+ function: ScoreboardHide
realm: client
- description: "Handles the move event"
-
+ description: ""
+ arguments:
returns:
---
-HTML:OnMove – Handles the move event
+hook ScoreboardHide – ""
diff --git a/docs/hooks/client/ScoreboardShow.md b/docs/hooks/client/ScoreboardShow.md
new file mode 100644
index 0000000000..8e6273d7f0
--- /dev/null
+++ b/docs/hooks/client/ScoreboardShow.md
@@ -0,0 +1,23 @@
+---
+template: lua-hook.html
+title: ScoreboardShow
+icon: lua-client
+tags:
+ - lua
+ - client
+ - needs-verification
+ - needs-example
+lua:
+ function: ScoreboardShow
+ realm: client
+ description: ""
+ arguments:
+
+ returns:
+ - type: unknown
+ description: ""
+---
+
+
+hook ScoreboardShow – ""
+
diff --git a/docs/hooks/client/SetupMove.md b/docs/hooks/client/SetupMove.md
index a423de0dbb..52348a53cc 100644
--- a/docs/hooks/client/SetupMove.md
+++ b/docs/hooks/client/SetupMove.md
@@ -14,7 +14,7 @@ lua:
arguments:
- name: "player"
description: ""
- type: Entity
+ type: Player
- name: "move"
description: ""
type: MoveData
diff --git a/docs/hooks/client/ShouldDrawLocalPlayer.md b/docs/hooks/client/ShouldDrawLocalPlayer.md
index bf562c434e..42dfbb5189 100644
--- a/docs/hooks/client/ShouldDrawLocalPlayer.md
+++ b/docs/hooks/client/ShouldDrawLocalPlayer.md
@@ -14,7 +14,7 @@ lua:
arguments:
- name: "pPlayer"
description: ""
- type: Entity
+ type: Player
returns:
- type: unknown
description: ""
diff --git a/docs/hooks/client/StartCommand.md b/docs/hooks/client/StartCommand.md
index d177ec148d..b3551740b0 100644
--- a/docs/hooks/client/StartCommand.md
+++ b/docs/hooks/client/StartCommand.md
@@ -14,7 +14,7 @@ lua:
arguments:
- name: "player"
description: ""
- type: Entity
+ type: Player
- name: "cmd"
description: ""
type: UserCmd
diff --git a/docs/hooks/server/CanEnterVehicle.md b/docs/hooks/server/CanEnterVehicle.md
index 4a587cbcaf..814e7e94c2 100644
--- a/docs/hooks/server/CanEnterVehicle.md
+++ b/docs/hooks/server/CanEnterVehicle.md
@@ -14,7 +14,7 @@ lua:
arguments:
- name: "this"
description: ""
- type: Entity
+ type: Player
- name: "nRole"
description: ""
type: number
diff --git a/docs/hooks/server/CreateEntityRagdoll.md b/docs/hooks/server/CreateEntityRagdoll.md
index 48f9d0031a..5008a0bc85 100644
--- a/docs/hooks/server/CreateEntityRagdoll.md
+++ b/docs/hooks/server/CreateEntityRagdoll.md
@@ -12,10 +12,10 @@ lua:
realm: server
description: ""
arguments:
- - name: "entity"
+ - name: "this"
description: ""
type: Entity
- - name: "entity"
+ - name: "pRagdoll"
description: ""
type: Entity
returns:
diff --git a/docs/hooks/server/EntityRemoved.md b/docs/hooks/server/EntityRemoved.md
index 6c84d7536a..8d9c384fec 100644
--- a/docs/hooks/server/EntityRemoved.md
+++ b/docs/hooks/server/EntityRemoved.md
@@ -12,7 +12,7 @@ lua:
realm: server
description: ""
arguments:
- - name: "entity"
+ - name: "oldObj"
description: ""
type: Entity
returns:
diff --git a/docs/hooks/server/FinishMove.md b/docs/hooks/server/FinishMove.md
index ea29dde658..c3a804596b 100644
--- a/docs/hooks/server/FinishMove.md
+++ b/docs/hooks/server/FinishMove.md
@@ -14,7 +14,7 @@ lua:
arguments:
- name: "player"
description: ""
- type: Entity
+ type: Player
- name: "move"
description: ""
type: MoveData
diff --git a/docs/hooks/server/PlayerInitialSpawn.md b/docs/hooks/server/PlayerInitialSpawn.md
index a248ff06cc..4c0e32495b 100644
--- a/docs/hooks/server/PlayerInitialSpawn.md
+++ b/docs/hooks/server/PlayerInitialSpawn.md
@@ -14,7 +14,7 @@ lua:
arguments:
- name: "this"
description: ""
- type: Entity
+ type: Player
returns:
---
diff --git a/docs/hooks/server/PlayerPostThink.md b/docs/hooks/server/PlayerPostThink.md
index cee955108c..a60d39c9b5 100644
--- a/docs/hooks/server/PlayerPostThink.md
+++ b/docs/hooks/server/PlayerPostThink.md
@@ -14,7 +14,7 @@ lua:
arguments:
- name: "player"
description: ""
- type: Entity
+ type: Player
returns:
---
diff --git a/docs/hooks/server/PlayerSay.md b/docs/hooks/server/PlayerSay.md
index 6c5fda918c..e4b70fe245 100644
--- a/docs/hooks/server/PlayerSay.md
+++ b/docs/hooks/server/PlayerSay.md
@@ -14,7 +14,7 @@ lua:
arguments:
- name: "speaker"
description: "The player who is speaking"
- type: Entity
+ type: Player
- name: "chatMessage"
description: ""
type: string
diff --git a/docs/hooks/server/PlayerTraceAttack.md b/docs/hooks/server/PlayerTraceAttack.md
index 9fc2324ffb..2c993d35db 100644
--- a/docs/hooks/server/PlayerTraceAttack.md
+++ b/docs/hooks/server/PlayerTraceAttack.md
@@ -14,7 +14,7 @@ lua:
arguments:
- name: "this"
description: ""
- type: Entity
+ type: Player
- name: "linputInfo"
description: ""
type: CTakeDamageInfo
diff --git a/docs/hooks/server/PlayersCanPickupObject.md b/docs/hooks/server/PlayersCanPickupObject.md
new file mode 100644
index 0000000000..11dfc46cc5
--- /dev/null
+++ b/docs/hooks/server/PlayersCanPickupObject.md
@@ -0,0 +1,31 @@
+---
+template: lua-hook.html
+title: PlayersCanPickupObject
+icon: lua-server
+tags:
+ - lua
+ - server
+ - needs-verification
+ - needs-example
+lua:
+ function: PlayersCanPickupObject
+ realm: server
+ description: "Checks if any player can pickup this type of object."
+ arguments:
+ - name: "entity"
+ description: "The entity that is being checked."
+ type: Entity
+ - name: "massLimit"
+ description: "The mass limit of the object."
+ type: number
+ - name: "sizeLimit"
+ description: "The size limit of the object."
+ type: number
+ returns:
+ - type: boolean
+ description: "Whether or not the object can be picked up."
+---
+
+
+hook PlayersCanPickupObject – "Checks if any player can pickup this type of object."
+
diff --git a/docs/hooks/server/SetupMove.md b/docs/hooks/server/SetupMove.md
index 95d98ab8b1..a7981a94f2 100644
--- a/docs/hooks/server/SetupMove.md
+++ b/docs/hooks/server/SetupMove.md
@@ -14,7 +14,7 @@ lua:
arguments:
- name: "player"
description: ""
- type: Entity
+ type: Player
- name: "move"
description: ""
type: MoveData
diff --git a/docs/hooks/server/ShowHelp.md b/docs/hooks/server/ShowHelp.md
new file mode 100644
index 0000000000..a11ed88367
--- /dev/null
+++ b/docs/hooks/server/ShowHelp.md
@@ -0,0 +1,24 @@
+---
+template: lua-hook.html
+title: ShowHelp
+icon: lua-server
+tags:
+ - lua
+ - server
+ - needs-verification
+ - needs-example
+lua:
+ function: ShowHelp
+ realm: server
+ description: ""
+ arguments:
+ - name: "pPlayer"
+ description: ""
+ type: Player
+ returns:
+
+---
+
+
+hook ShowHelp – ""
+
diff --git a/docs/hooks/server/ShowSpare1.md b/docs/hooks/server/ShowSpare1.md
new file mode 100644
index 0000000000..fe4900f564
--- /dev/null
+++ b/docs/hooks/server/ShowSpare1.md
@@ -0,0 +1,24 @@
+---
+template: lua-hook.html
+title: ShowSpare1
+icon: lua-server
+tags:
+ - lua
+ - server
+ - needs-verification
+ - needs-example
+lua:
+ function: ShowSpare1
+ realm: server
+ description: ""
+ arguments:
+ - name: "pPlayer"
+ description: ""
+ type: Player
+ returns:
+
+---
+
+
+hook ShowSpare1 – ""
+
diff --git a/docs/hooks/server/ShowSpare2.md b/docs/hooks/server/ShowSpare2.md
new file mode 100644
index 0000000000..672212f1ab
--- /dev/null
+++ b/docs/hooks/server/ShowSpare2.md
@@ -0,0 +1,24 @@
+---
+template: lua-hook.html
+title: ShowSpare2
+icon: lua-server
+tags:
+ - lua
+ - server
+ - needs-verification
+ - needs-example
+lua:
+ function: ShowSpare2
+ realm: server
+ description: ""
+ arguments:
+ - name: "pPlayer"
+ description: ""
+ type: Player
+ returns:
+
+---
+
+
+hook ShowSpare2 – ""
+
diff --git a/docs/hooks/server/ShowTeam.md b/docs/hooks/server/ShowTeam.md
new file mode 100644
index 0000000000..6f2e6c7393
--- /dev/null
+++ b/docs/hooks/server/ShowTeam.md
@@ -0,0 +1,24 @@
+---
+template: lua-hook.html
+title: ShowTeam
+icon: lua-server
+tags:
+ - lua
+ - server
+ - needs-verification
+ - needs-example
+lua:
+ function: ShowTeam
+ realm: server
+ description: ""
+ arguments:
+ - name: "pPlayer"
+ description: ""
+ type: Player
+ returns:
+
+---
+
+
+hook ShowTeam – ""
+
diff --git a/docs/hooks/server/StartCommand.md b/docs/hooks/server/StartCommand.md
index 39e1310851..ac3d6fc356 100644
--- a/docs/hooks/server/StartCommand.md
+++ b/docs/hooks/server/StartCommand.md
@@ -14,7 +14,7 @@ lua:
arguments:
- name: "player"
description: ""
- type: Entity
+ type: Player
- name: "cmd"
description: ""
type: UserCmd
diff --git a/docs/hooks/server/VehicleMove.md b/docs/hooks/server/VehicleMove.md
index 5f726d719d..9be65d7238 100644
--- a/docs/hooks/server/VehicleMove.md
+++ b/docs/hooks/server/VehicleMove.md
@@ -14,7 +14,7 @@ lua:
arguments:
- name: "pPlayer"
description: ""
- type: Entity
+ type: Player
- name: "pMoveData"
description: ""
type: MoveData
diff --git a/docs/hooks/server/Weapon_Equip.md b/docs/hooks/server/Weapon_Equip.md
index da7e37c2b5..38dc1f2ad3 100644
--- a/docs/hooks/server/Weapon_Equip.md
+++ b/docs/hooks/server/Weapon_Equip.md
@@ -14,7 +14,7 @@ lua:
arguments:
- name: "this"
description: ""
- type: Entity
+ type: Player
- name: "pWeapon"
description: ""
type: Entity
diff --git a/docs/hooks/shared/CalcVehicleView.md b/docs/hooks/shared/CalcVehicleView.md
index 1d690e1ede..81ac631fa1 100644
--- a/docs/hooks/shared/CalcVehicleView.md
+++ b/docs/hooks/shared/CalcVehicleView.md
@@ -14,7 +14,7 @@ lua:
arguments:
- name: "this"
description: ""
- type: Entity
+ type: Player
- name: "table"
description: ""
type: table
diff --git a/docs/hooks/shared/CalcView.md b/docs/hooks/shared/CalcView.md
index ea2b6fef89..5f18d68d5e 100644
--- a/docs/hooks/shared/CalcView.md
+++ b/docs/hooks/shared/CalcView.md
@@ -14,7 +14,7 @@ lua:
arguments:
- name: "this"
description: ""
- type: Entity
+ type: Player
- name: "origin"
description: ""
type: Vector
diff --git a/docs/hooks/shared/CanHavePlayerItem.md b/docs/hooks/shared/CanHavePlayerItem.md
index 371eb64d0c..c652d96ba1 100644
--- a/docs/hooks/shared/CanHavePlayerItem.md
+++ b/docs/hooks/shared/CanHavePlayerItem.md
@@ -14,7 +14,7 @@ lua:
arguments:
- name: "pPlayer"
description: ""
- type: Entity
+ type: Player
- name: "pItem"
description: ""
type: Entity
diff --git a/docs/hooks/shared/CanPlayerHearPlayer.md b/docs/hooks/shared/CanPlayerHearPlayer.md
index 7edd785e6d..057089991a 100644
--- a/docs/hooks/shared/CanPlayerHearPlayer.md
+++ b/docs/hooks/shared/CanPlayerHearPlayer.md
@@ -14,10 +14,10 @@ lua:
arguments:
- name: "pListener"
description: ""
- type: Entity
+ type: Player
- name: "pTalker"
description: ""
- type: Entity
+ type: Player
- name: "bProximity"
description: ""
type: boolean
diff --git a/docs/hooks/shared/ClientSettingsChanged.md b/docs/hooks/shared/ClientSettingsChanged.md
index b0a93ba326..20f1a37b1e 100644
--- a/docs/hooks/shared/ClientSettingsChanged.md
+++ b/docs/hooks/shared/ClientSettingsChanged.md
@@ -14,7 +14,7 @@ lua:
arguments:
- name: "pPlayer"
description: ""
- type: Entity
+ type: Player
returns:
---
diff --git a/docs/hooks/shared/DeathNotice.md b/docs/hooks/shared/DeathNotice.md
index 5018f0d083..b2590c1803 100644
--- a/docs/hooks/shared/DeathNotice.md
+++ b/docs/hooks/shared/DeathNotice.md
@@ -14,7 +14,7 @@ lua:
arguments:
- name: "pVictim"
description: ""
- type: Entity
+ type: Player
- name: "lInfo"
description: ""
type: CTakeDamageInfo
diff --git a/docs/hooks/shared/FPlayerCanTakeDamage.md b/docs/hooks/shared/FPlayerCanTakeDamage.md
index 477994e1ea..813cedae00 100644
--- a/docs/hooks/shared/FPlayerCanTakeDamage.md
+++ b/docs/hooks/shared/FPlayerCanTakeDamage.md
@@ -14,7 +14,7 @@ lua:
arguments:
- name: "pPlayer"
description: ""
- type: Entity
+ type: Player
- name: "pAttacker"
description: ""
type: Entity
diff --git a/docs/hooks/shared/FShouldSwitchWeapon.md b/docs/hooks/shared/FShouldSwitchWeapon.md
index 3c13a38e04..ab5e4010b5 100644
--- a/docs/hooks/shared/FShouldSwitchWeapon.md
+++ b/docs/hooks/shared/FShouldSwitchWeapon.md
@@ -14,7 +14,7 @@ lua:
arguments:
- name: "pPlayer"
description: ""
- type: Entity
+ type: Player
- name: "pWeapon"
description: ""
type: Entity
diff --git a/docs/hooks/shared/FindUseEntity.md b/docs/hooks/shared/FindUseEntity.md
index 81dc493aa2..f3f0aae04a 100644
--- a/docs/hooks/shared/FindUseEntity.md
+++ b/docs/hooks/shared/FindUseEntity.md
@@ -14,7 +14,7 @@ lua:
arguments:
- name: "this"
description: ""
- type: Entity
+ type: Player
- name: "pNearest"
description: ""
type: Entity
diff --git a/docs/hooks/shared/FlPlayerSpawnTime.md b/docs/hooks/shared/FlPlayerSpawnTime.md
index ec82a3e99c..a891882d3f 100644
--- a/docs/hooks/shared/FlPlayerSpawnTime.md
+++ b/docs/hooks/shared/FlPlayerSpawnTime.md
@@ -14,7 +14,7 @@ lua:
arguments:
- name: "pPlayer"
description: ""
- type: Entity
+ type: Player
returns:
- type: unknown
description: ""
diff --git a/docs/hooks/shared/GetFallDamage.md b/docs/hooks/shared/GetFallDamage.md
index fda2a69543..f35046cd49 100644
--- a/docs/hooks/shared/GetFallDamage.md
+++ b/docs/hooks/shared/GetFallDamage.md
@@ -14,7 +14,7 @@ lua:
arguments:
- name: "player"
description: ""
- type: Entity
+ type: Player
- name: "fallVelocity"
description: ""
type: number
diff --git a/docs/hooks/shared/InitHUD.md b/docs/hooks/shared/InitHUD.md
index c8f0d126bd..37a2dfaeda 100644
--- a/docs/hooks/shared/InitHUD.md
+++ b/docs/hooks/shared/InitHUD.md
@@ -14,7 +14,7 @@ lua:
arguments:
- name: "pPlayer"
description: ""
- type: Entity
+ type: Player
returns:
---
diff --git a/docs/hooks/shared/Move.md b/docs/hooks/shared/Move.md
index e7c5513196..9e8931d820 100644
--- a/docs/hooks/shared/Move.md
+++ b/docs/hooks/shared/Move.md
@@ -14,7 +14,7 @@ lua:
arguments:
- name: "player"
description: ""
- type: Entity
+ type: Player
- name: "mv"
description: ""
type: MoveData
diff --git a/docs/hooks/shared/PlayerCanHearChat.md b/docs/hooks/shared/PlayerCanHearChat.md
index 05df31f334..703192eed8 100644
--- a/docs/hooks/shared/PlayerCanHearChat.md
+++ b/docs/hooks/shared/PlayerCanHearChat.md
@@ -14,10 +14,10 @@ lua:
arguments:
- name: "pListener"
description: ""
- type: Entity
+ type: Player
- name: "pSpeaker"
description: ""
- type: Entity
+ type: Player
returns:
- type: unknown
description: ""
diff --git a/docs/hooks/shared/FPlayerCanRespawn.md b/docs/hooks/shared/PlayerCanRespawn.md
similarity index 73%
rename from docs/hooks/shared/FPlayerCanRespawn.md
rename to docs/hooks/shared/PlayerCanRespawn.md
index 01b641c25e..cabc9a2a02 100644
--- a/docs/hooks/shared/FPlayerCanRespawn.md
+++ b/docs/hooks/shared/PlayerCanRespawn.md
@@ -1,6 +1,6 @@
---
template: lua-hook.html
-title: FPlayerCanRespawn
+title: PlayerCanRespawn
icon: lua-shared
tags:
- lua
@@ -8,18 +8,18 @@ tags:
- needs-verification
- needs-example
lua:
- function: FPlayerCanRespawn
+ function: PlayerCanRespawn
realm: shared
description: ""
arguments:
- name: "pPlayer"
description: ""
- type: Entity
+ type: Player
returns:
- type: unknown
description: ""
---
-hook FPlayerCanRespawn – ""
+hook PlayerCanRespawn – ""
diff --git a/docs/hooks/shared/PlayerGotItem.md b/docs/hooks/shared/PlayerGotItem.md
index 97b61a7aff..a82af31099 100644
--- a/docs/hooks/shared/PlayerGotItem.md
+++ b/docs/hooks/shared/PlayerGotItem.md
@@ -14,7 +14,7 @@ lua:
arguments:
- name: "pPlayer"
description: ""
- type: Entity
+ type: Player
- name: "pItem"
description: ""
type: Entity
diff --git a/docs/hooks/shared/PlayerKilled.md b/docs/hooks/shared/PlayerKilled.md
index dfe670e445..0989ba28d0 100644
--- a/docs/hooks/shared/PlayerKilled.md
+++ b/docs/hooks/shared/PlayerKilled.md
@@ -14,7 +14,7 @@ lua:
arguments:
- name: "pVictim"
description: ""
- type: Entity
+ type: Player
- name: "linfo"
description: ""
type: CTakeDamageInfo
diff --git a/docs/hooks/shared/PlayerNoClip.md b/docs/hooks/shared/PlayerNoClip.md
index 97c31cb588..93aedc3b74 100644
--- a/docs/hooks/shared/PlayerNoClip.md
+++ b/docs/hooks/shared/PlayerNoClip.md
@@ -14,7 +14,7 @@ lua:
arguments:
- name: "player"
description: ""
- type: Entity
+ type: Player
- name: "bNoClipDesired"
description: ""
type: boolean
diff --git a/docs/hooks/shared/PlayerSpawn.md b/docs/hooks/shared/PlayerSpawn.md
index 9e33f0bbf3..eabd51a0a1 100644
--- a/docs/hooks/shared/PlayerSpawn.md
+++ b/docs/hooks/shared/PlayerSpawn.md
@@ -14,10 +14,9 @@ lua:
arguments:
- name: "pPlayer"
description: ""
- type: Entity
+ type: Player
returns:
- - type: unknown
- description: ""
+
---
diff --git a/docs/hooks/shared/PlayerThink.md b/docs/hooks/shared/PlayerThink.md
index b6435c5cc3..1e3ed6c570 100644
--- a/docs/hooks/shared/PlayerThink.md
+++ b/docs/hooks/shared/PlayerThink.md
@@ -14,7 +14,7 @@ lua:
arguments:
- name: "pPlayer"
description: ""
- type: Entity
+ type: Player
returns:
---
diff --git a/docs/hooks/shared/PlayerTick.md b/docs/hooks/shared/PlayerTick.md
index bab8d88603..6c9da90a08 100644
--- a/docs/hooks/shared/PlayerTick.md
+++ b/docs/hooks/shared/PlayerTick.md
@@ -14,7 +14,7 @@ lua:
arguments:
- name: "player"
description: ""
- type: Entity
+ type: Player
- name: "mv"
description: ""
type: MoveData
diff --git a/docs/hooks/shared/PlayerUse.md b/docs/hooks/shared/PlayerUse.md
index ee07f7ec30..c4054d3b20 100644
--- a/docs/hooks/shared/PlayerUse.md
+++ b/docs/hooks/shared/PlayerUse.md
@@ -14,7 +14,7 @@ lua:
arguments:
- name: "this"
description: ""
- type: Entity
+ type: Player
- name: "pUseEntity"
description: ""
type: Entity
diff --git a/docs/libraries/Angles/Create.md b/docs/libraries/Angles/Create.md
index 7be7e5dbfb..a274435949 100644
--- a/docs/libraries/Angles/Create.md
+++ b/docs/libraries/Angles/Create.md
@@ -13,23 +13,24 @@ lua:
realm: shared
description: "Creates a new angle."
- argumentSets:
- - arguments:
+ arguments:
+ - position: 1
+ types:
- name: "angle"
type: Angle
- - arguments:
- name: "angleString"
type: string
- - arguments:
- name: "p"
type: number
- default: "0.0f"
- - name: "y"
- type: number
- default: "0.0f"
- - name: "r"
- type: number
- default: "0.0f"
+ default: "0.0f"
+ - position: 2
+ name: "y"
+ type: number
+ default: "0.0f"
+ - position: 3
+ name: "r"
+ type: number
+ default: "0.0f"
returns:
- type: Angle
description: "The created angle."
diff --git a/docs/libraries/Angles/Lerp.md b/docs/libraries/Angles/Lerp.md
new file mode 100644
index 0000000000..ba940f8209
--- /dev/null
+++ b/docs/libraries/Angles/Lerp.md
@@ -0,0 +1,33 @@
+---
+template: lua-library-function.html
+title: Lerp
+icon: lua-shared
+tags:
+ - lua
+ - shared
+ - needs-verification
+ - needs-example
+lua:
+ library: Angles
+ function: Lerp
+ realm: shared
+ description: "Linearly interpolates between two angles."
+
+ arguments:
+ - position: 1
+ name: "fraction"
+ type: number
+ - position: 2
+ name: "angleStart"
+ type: Angle
+ - position: 3
+ name: "angleEnd"
+ type: Angle
+ returns:
+ - type: Angle
+ description: "The interpolated angle."
+---
+
+
+Angles.Lerp – Linearly interpolates between two angles.
+
diff --git a/docs/libraries/Chats/AddText.md b/docs/libraries/Chats/AddText.md
new file mode 100644
index 0000000000..8de879874d
--- /dev/null
+++ b/docs/libraries/Chats/AddText.md
@@ -0,0 +1,24 @@
+---
+template: lua-library-function.html
+title: AddText
+icon: lua-client
+tags:
+ - lua
+ - client
+ - needs-verification
+ - needs-example
+lua:
+ library: Chats
+ function: AddText
+ realm: client
+ description: "Adds (optionally colored) text to the local chatbox"
+
+ arguments:
+
+ returns:
+
+---
+
+
+Chats.AddText – Adds (optionally colored) text to the local chatbox
+
diff --git a/docs/libraries/Chats/GetChatBoxPosition.md b/docs/libraries/Chats/GetChatBoxPosition.md
new file mode 100644
index 0000000000..f1720d502c
--- /dev/null
+++ b/docs/libraries/Chats/GetChatBoxPosition.md
@@ -0,0 +1,24 @@
+---
+template: lua-library-function.html
+title: GetChatBoxPosition
+icon: lua-client
+tags:
+ - lua
+ - client
+ - needs-verification
+ - needs-example
+lua:
+ library: Chats
+ function: GetChatBoxPosition
+ realm: client
+ description: "Get the position of the chat box."
+
+ arguments:
+
+ returns:
+
+---
+
+
+Chats.GetChatBoxPosition – Get the position of the chat box.
+
diff --git a/docs/libraries/Chats/GetChatBoxSize.md b/docs/libraries/Chats/GetChatBoxSize.md
new file mode 100644
index 0000000000..49a3cb17de
--- /dev/null
+++ b/docs/libraries/Chats/GetChatBoxSize.md
@@ -0,0 +1,24 @@
+---
+template: lua-library-function.html
+title: GetChatBoxSize
+icon: lua-client
+tags:
+ - lua
+ - client
+ - needs-verification
+ - needs-example
+lua:
+ library: Chats
+ function: GetChatBoxSize
+ realm: client
+ description: "Get the size of the chat box."
+
+ arguments:
+
+ returns:
+
+---
+
+
+Chats.GetChatBoxSize – Get the size of the chat box.
+
diff --git a/docs/libraries/Chats/PlaySound.md b/docs/libraries/Chats/PlaySound.md
new file mode 100644
index 0000000000..b2b463511d
--- /dev/null
+++ b/docs/libraries/Chats/PlaySound.md
@@ -0,0 +1,24 @@
+---
+template: lua-library-function.html
+title: PlaySound
+icon: lua-client
+tags:
+ - lua
+ - client
+ - needs-verification
+ - needs-example
+lua:
+ library: Chats
+ function: PlaySound
+ realm: client
+ description: "Play the 'tick' chat sound."
+
+ arguments:
+
+ returns:
+
+---
+
+
+Chats.PlaySound – Play the 'tick' chat sound.
+
diff --git a/docs/libraries/Chats/StartMessageMode.md b/docs/libraries/Chats/StartMessageMode.md
new file mode 100644
index 0000000000..667e3f49c0
--- /dev/null
+++ b/docs/libraries/Chats/StartMessageMode.md
@@ -0,0 +1,26 @@
+---
+template: lua-library-function.html
+title: StartMessageMode
+icon: lua-client
+tags:
+ - lua
+ - client
+ - needs-verification
+ - needs-example
+lua:
+ library: Chats
+ function: StartMessageMode
+ realm: client
+ description: "Open the chat with the specified message mode."
+
+ arguments:
+ - position: 1
+ name: "messageMode"
+ type: enumeration/CHAT_MESSAGE_MODE
+ returns:
+
+---
+
+
+Chats.StartMessageMode – Open the chat with the specified message mode.
+
diff --git a/docs/libraries/Chats/StopMessageMode.md b/docs/libraries/Chats/StopMessageMode.md
new file mode 100644
index 0000000000..66b846d6de
--- /dev/null
+++ b/docs/libraries/Chats/StopMessageMode.md
@@ -0,0 +1,24 @@
+---
+template: lua-library-function.html
+title: StopMessageMode
+icon: lua-client
+tags:
+ - lua
+ - client
+ - needs-verification
+ - needs-example
+lua:
+ library: Chats
+ function: StopMessageMode
+ realm: client
+ description: "Close the chat."
+
+ arguments:
+
+ returns:
+
+---
+
+
+Chats.StopMessageMode – Close the chat.
+
diff --git a/docs/libraries/Chats/index.md b/docs/libraries/Chats/index.md
new file mode 100644
index 0000000000..fd52fc5baf
--- /dev/null
+++ b/docs/libraries/Chats/index.md
@@ -0,0 +1,10 @@
+---
+template: lua-index.html
+childrenTitle: Functions
+include:
+ startsWith: libraries/Chats/
+exclude:
+ isIndex: true
+---
+
+# Chats
diff --git a/docs/libraries/ClientShadows/AdvanceFrame.md b/docs/libraries/ClientShadows/AdvanceFrame.md
index ed5990b51d..99956a2939 100644
--- a/docs/libraries/ClientShadows/AdvanceFrame.md
+++ b/docs/libraries/ClientShadows/AdvanceFrame.md
@@ -13,6 +13,7 @@ lua:
realm: client
description: "Advance shadow frame processing."
+ arguments:
returns:
diff --git a/docs/libraries/ClientShadows/GetShadowDirection.md b/docs/libraries/ClientShadows/GetShadowDirection.md
index fa25749562..35cc7143c1 100644
--- a/docs/libraries/ClientShadows/GetShadowDirection.md
+++ b/docs/libraries/ClientShadows/GetShadowDirection.md
@@ -13,6 +13,7 @@ lua:
realm: client
description: "Get the current shadow direction as a vector."
+ arguments:
returns:
- type: Vector
diff --git a/docs/libraries/ClientShadows/RenderShadowTexture.md b/docs/libraries/ClientShadows/RenderShadowTexture.md
index f7d15392bf..8710c35af2 100644
--- a/docs/libraries/ClientShadows/RenderShadowTexture.md
+++ b/docs/libraries/ClientShadows/RenderShadowTexture.md
@@ -14,10 +14,12 @@ lua:
description: "Render shadow texture using provided width and height."
arguments:
- - name: "width"
- type: number
- - name: "height"
- type: number
+ - position: 1
+ name: "width"
+ type: number
+ - position: 2
+ name: "height"
+ type: number
returns:
---
diff --git a/docs/libraries/ClientShadows/SetShadowBlobbyCutoffArea.md b/docs/libraries/ClientShadows/SetShadowBlobbyCutoffArea.md
index ad7c9cc07e..8418aa599f 100644
--- a/docs/libraries/ClientShadows/SetShadowBlobbyCutoffArea.md
+++ b/docs/libraries/ClientShadows/SetShadowBlobbyCutoffArea.md
@@ -14,8 +14,9 @@ lua:
description: "Set the blobby cutoff area for shadows."
arguments:
- - name: "area"
- type: number
+ - position: 1
+ name: "area"
+ type: number
returns:
---
diff --git a/docs/libraries/ClientShadows/SetShadowColor.md b/docs/libraries/ClientShadows/SetShadowColor.md
index 643532d9de..7a5b3a8f5e 100644
--- a/docs/libraries/ClientShadows/SetShadowColor.md
+++ b/docs/libraries/ClientShadows/SetShadowColor.md
@@ -14,12 +14,15 @@ lua:
description: "Set shadow color using RGB values."
arguments:
- - name: "r"
- type: number
- - name: "g"
- type: number
- - name: "b"
- type: number
+ - position: 1
+ name: "r"
+ type: number
+ - position: 2
+ name: "g"
+ type: number
+ - position: 3
+ name: "b"
+ type: number
returns:
---
diff --git a/docs/libraries/ClientShadows/SetShadowDirection.md b/docs/libraries/ClientShadows/SetShadowDirection.md
index 120cabcdb1..84c5d11ff6 100644
--- a/docs/libraries/ClientShadows/SetShadowDirection.md
+++ b/docs/libraries/ClientShadows/SetShadowDirection.md
@@ -14,8 +14,9 @@ lua:
description: "Set the direction of shadows as a vector."
arguments:
- - name: "direction"
- type: Vector
+ - position: 1
+ name: "direction"
+ type: Vector
returns:
---
diff --git a/docs/libraries/ClientShadows/SetShadowDistance.md b/docs/libraries/ClientShadows/SetShadowDistance.md
index fdb410162c..a33f62d06b 100644
--- a/docs/libraries/ClientShadows/SetShadowDistance.md
+++ b/docs/libraries/ClientShadows/SetShadowDistance.md
@@ -14,8 +14,9 @@ lua:
description: "Set the distance for shadow rendering."
arguments:
- - name: "distance"
- type: number
+ - position: 1
+ name: "distance"
+ type: number
returns:
---
diff --git a/docs/libraries/ClientShadows/SetShadowsDisabled.md b/docs/libraries/ClientShadows/SetShadowsDisabled.md
index 61ef70eb64..3d0424a1fb 100644
--- a/docs/libraries/ClientShadows/SetShadowsDisabled.md
+++ b/docs/libraries/ClientShadows/SetShadowsDisabled.md
@@ -14,8 +14,9 @@ lua:
description: "Enable or disable shadow rendering."
arguments:
- - name: "disabled"
- type: boolean
+ - position: 1
+ name: "disabled"
+ type: boolean
returns:
---
diff --git a/docs/libraries/ClientShadows/UnlockAllShadowDepthTextures.md b/docs/libraries/ClientShadows/UnlockAllShadowDepthTextures.md
index b2c3d91d88..73121128ba 100644
--- a/docs/libraries/ClientShadows/UnlockAllShadowDepthTextures.md
+++ b/docs/libraries/ClientShadows/UnlockAllShadowDepthTextures.md
@@ -13,6 +13,7 @@ lua:
realm: client
description: "Unlock all shadow depth textures."
+ arguments:
returns:
diff --git a/docs/libraries/Colors/ColorToHsl.md b/docs/libraries/Colors/ColorToHsl.md
index c2bf780e63..c607e94cd1 100644
--- a/docs/libraries/Colors/ColorToHsl.md
+++ b/docs/libraries/Colors/ColorToHsl.md
@@ -13,6 +13,7 @@ lua:
realm: shared
description: "Converts RGB to HSL."
+ arguments:
returns:
- type: number
diff --git a/docs/libraries/Colors/ColorToHsv.md b/docs/libraries/Colors/ColorToHsv.md
index 218f8f1974..407855774d 100644
--- a/docs/libraries/Colors/ColorToHsv.md
+++ b/docs/libraries/Colors/ColorToHsv.md
@@ -13,6 +13,7 @@ lua:
realm: shared
description: "Converts RGB to HSV."
+ arguments:
returns:
- type: number
diff --git a/docs/libraries/Colors/Create.md b/docs/libraries/Colors/Create.md
index 14f38fa8a2..d9421d977d 100644
--- a/docs/libraries/Colors/Create.md
+++ b/docs/libraries/Colors/Create.md
@@ -14,15 +14,19 @@ lua:
description: "Creates a new color."
arguments:
- - name: "red"
- type: number
- - name: "green"
- type: number
- - name: "blue"
- type: number
- - name: "alpha"
- type: number
- default: "255"
+ - position: 1
+ name: "red"
+ type: number
+ - position: 2
+ name: "green"
+ type: number
+ - position: 3
+ name: "blue"
+ type: number
+ - position: 4
+ name: "alpha"
+ type: number
+ default: "255"
returns:
- type: Color
description: "The created color."
diff --git a/docs/libraries/Colors/HslToColor.md b/docs/libraries/Colors/HslToColor.md
index 0517b527de..c9e272ca0d 100644
--- a/docs/libraries/Colors/HslToColor.md
+++ b/docs/libraries/Colors/HslToColor.md
@@ -13,6 +13,7 @@ lua:
realm: shared
description: "Converts HSL to RGB."
+ arguments:
returns:
- type: Color
diff --git a/docs/libraries/Colors/HsvToColor.md b/docs/libraries/Colors/HsvToColor.md
index 155ca9038d..ec58e2e7fb 100644
--- a/docs/libraries/Colors/HsvToColor.md
+++ b/docs/libraries/Colors/HsvToColor.md
@@ -14,12 +14,15 @@ lua:
description: "Converts HSV to RGB."
arguments:
- - name: "hue"
- type: number
- - name: "saturation"
- type: number
- - name: "value"
- type: number
+ - position: 1
+ name: "hue"
+ type: number
+ - position: 2
+ name: "saturation"
+ type: number
+ - position: 3
+ name: "value"
+ type: number
returns:
- type: Color
description: "The converted color."
diff --git a/docs/libraries/ConsoleCommands/Create.md b/docs/libraries/ConsoleCommands/Create.md
index df30d4e563..deefe85ba2 100644
--- a/docs/libraries/ConsoleCommands/Create.md
+++ b/docs/libraries/ConsoleCommands/Create.md
@@ -14,14 +14,17 @@ lua:
description: "Creates a console command or returns the existing one with the given name"
arguments:
- - name: "name"
- type: string
- - name: "helpString"
- type: string
- default: "\"\""
- - name: "flags"
- type: number
- default: "0"
+ - position: 1
+ name: "name"
+ type: string
+ - position: 2
+ name: "helpString"
+ type: string
+ default: "\"\""
+ - position: 3
+ name: "flags"
+ type: number
+ default: "0"
returns:
- type: ConsoleCommand
description: "Created console command (returns existing command if one with the same name exists)"
diff --git a/docs/libraries/ConsoleCommands/GetCommandClient.md b/docs/libraries/ConsoleCommands/GetCommandClient.md
index d175f5725d..379aa28176 100644
--- a/docs/libraries/ConsoleCommands/GetCommandClient.md
+++ b/docs/libraries/ConsoleCommands/GetCommandClient.md
@@ -13,6 +13,7 @@ lua:
realm: server
description: "Get the client that issued the command"
+ arguments:
returns:
- type: Player
diff --git a/docs/libraries/ConsoleCommands/GetCommandClientIndex.md b/docs/libraries/ConsoleCommands/GetCommandClientIndex.md
index f0ea0a18ca..d55ec5dd04 100644
--- a/docs/libraries/ConsoleCommands/GetCommandClientIndex.md
+++ b/docs/libraries/ConsoleCommands/GetCommandClientIndex.md
@@ -13,6 +13,7 @@ lua:
realm: server
description: "Get the index of the client that issued the command"
+ arguments:
returns:
- type: integer
diff --git a/docs/libraries/ConsoleCommands/IsCommandIssuedByServerAdmin.md b/docs/libraries/ConsoleCommands/IsCommandIssuedByServerAdmin.md
index 119d872017..80ba5ca10d 100644
--- a/docs/libraries/ConsoleCommands/IsCommandIssuedByServerAdmin.md
+++ b/docs/libraries/ConsoleCommands/IsCommandIssuedByServerAdmin.md
@@ -13,6 +13,7 @@ lua:
realm: server
description: "Whether the command was issued by a server admin"
+ arguments:
returns:
- type: boolean
diff --git a/docs/libraries/ConsoleVariables/AllocateDllIdentifier.md b/docs/libraries/ConsoleVariables/AllocateDllIdentifier.md
index 6e8a176ab8..e3cd0d3ef7 100644
--- a/docs/libraries/ConsoleVariables/AllocateDllIdentifier.md
+++ b/docs/libraries/ConsoleVariables/AllocateDllIdentifier.md
@@ -13,6 +13,7 @@ lua:
realm: shared
description: "Allocate a DLL identifier."
+ arguments:
returns:
- type: integer
diff --git a/docs/libraries/ConsoleVariables/ConsoleColorColorPrint.md b/docs/libraries/ConsoleVariables/ConsoleColorColorPrint.md
index 2d6e880839..22be2e4cc3 100644
--- a/docs/libraries/ConsoleVariables/ConsoleColorColorPrint.md
+++ b/docs/libraries/ConsoleVariables/ConsoleColorColorPrint.md
@@ -14,10 +14,12 @@ lua:
description: "Print a message to the console with a specific color."
arguments:
- - name: "color"
- type: Color
- - name: "message"
- type: string
+ - position: 1
+ name: "color"
+ type: Color
+ - position: 2
+ name: "message"
+ type: string
returns:
---
diff --git a/docs/libraries/ConsoleVariables/ConsoleDebugPrint.md b/docs/libraries/ConsoleVariables/ConsoleDebugPrint.md
index 1061f30b69..067fac6441 100644
--- a/docs/libraries/ConsoleVariables/ConsoleDebugPrint.md
+++ b/docs/libraries/ConsoleVariables/ConsoleDebugPrint.md
@@ -14,8 +14,9 @@ lua:
description: "Print a debug message to the console."
arguments:
- - name: "message"
- type: string
+ - position: 1
+ name: "message"
+ type: string
returns:
---
diff --git a/docs/libraries/ConsoleVariables/ConsolePrint.md b/docs/libraries/ConsoleVariables/ConsolePrint.md
index 95676ac790..0e63645f9e 100644
--- a/docs/libraries/ConsoleVariables/ConsolePrint.md
+++ b/docs/libraries/ConsoleVariables/ConsolePrint.md
@@ -14,8 +14,9 @@ lua:
description: "Print a message to the console."
arguments:
- - name: "message"
- type: string
+ - position: 1
+ name: "message"
+ type: string
returns:
---
diff --git a/docs/libraries/ConsoleVariables/Create.md b/docs/libraries/ConsoleVariables/Create.md
index 68e159f8b3..2ef30673f3 100644
--- a/docs/libraries/ConsoleVariables/Create.md
+++ b/docs/libraries/ConsoleVariables/Create.md
@@ -14,22 +14,28 @@ lua:
description: "Creates a console variable or returns the existing one with the given name"
arguments:
- - name: "name"
- type: string
- - name: "value"
- type: string
- - name: "flags"
- type: number
- default: "0"
- - name: "helpText"
- type: string
- default: "\"\""
- - name: "minimum"
- type: number
- default: "0.0"
- - name: "maximum"
- type: number
- default: "0"
+ - position: 1
+ name: "name"
+ type: string
+ - position: 2
+ name: "value"
+ type: string
+ - position: 3
+ name: "flags"
+ type: number
+ default: "0"
+ - position: 4
+ name: "helpText"
+ type: string
+ default: "\"\""
+ - position: 5
+ name: "minimum"
+ type: number
+ default: "0.0"
+ - position: 6
+ name: "maximum"
+ type: number
+ default: "0"
returns:
- type: ConsoleVariable
description: "The ConsoleVariable created or found"
diff --git a/docs/libraries/ConsoleVariables/FindVariable.md b/docs/libraries/ConsoleVariables/FindVariable.md
index a36b83f0fb..5512f5b60c 100644
--- a/docs/libraries/ConsoleVariables/FindVariable.md
+++ b/docs/libraries/ConsoleVariables/FindVariable.md
@@ -14,8 +14,9 @@ lua:
description: "Find a console variable by name."
arguments:
- - name: "name"
- type: string
+ - position: 1
+ name: "name"
+ type: string
returns:
- type: ConsoleVariable
description: "Found console variable or NULL."
diff --git a/docs/libraries/ConsoleVariables/Get.md b/docs/libraries/ConsoleVariables/Get.md
index ce8e853c1a..d71ec0c825 100644
--- a/docs/libraries/ConsoleVariables/Get.md
+++ b/docs/libraries/ConsoleVariables/Get.md
@@ -14,8 +14,9 @@ lua:
description: "Gets a console variable"
arguments:
- - name: "name"
- type: string
+ - position: 1
+ name: "name"
+ type: string
returns:
- type: ConsoleVariable
description: "The ConsoleVariable found"
diff --git a/docs/libraries/ConsoleVariables/GetCommandLineValue.md b/docs/libraries/ConsoleVariables/GetCommandLineValue.md
index f5f111699e..e888c19e43 100644
--- a/docs/libraries/ConsoleVariables/GetCommandLineValue.md
+++ b/docs/libraries/ConsoleVariables/GetCommandLineValue.md
@@ -14,8 +14,9 @@ lua:
description: "Get the value of a command line parameter."
arguments:
- - name: "name"
- type: string
+ - position: 1
+ name: "name"
+ type: string
returns:
- type: string
description: "Value of the command line parameter."
diff --git a/docs/libraries/ConsoleVariables/RevertFlaggedConVars.md b/docs/libraries/ConsoleVariables/RevertFlaggedConVars.md
index 46110e4f3e..a25d41d09e 100644
--- a/docs/libraries/ConsoleVariables/RevertFlaggedConVars.md
+++ b/docs/libraries/ConsoleVariables/RevertFlaggedConVars.md
@@ -14,8 +14,9 @@ lua:
description: "Revert flagged console variables."
arguments:
- - name: "flag"
- type: number
+ - position: 1
+ name: "flag"
+ type: number
returns:
---
diff --git a/docs/libraries/DebugOverlays/AddBox.md b/docs/libraries/DebugOverlays/AddBox.md
index 2e0ca6388c..eebd7fd4d3 100644
--- a/docs/libraries/DebugOverlays/AddBox.md
+++ b/docs/libraries/DebugOverlays/AddBox.md
@@ -14,20 +14,30 @@ lua:
description: "Add a box overlay to the screen with specific colors."
arguments:
- - name: "start"
- type: Vector
- - name: "mins"
- type: Vector
- - name: "maxs"
- type: Vector
- - name: "angles"
- type: Angle
- - name: "duration"
- type: number
- default: "1"
- - name: "edgeColor"
- type: Color
- default: "faceColor"
+ - position: 1
+ name: "start"
+ type: Vector
+ - position: 2
+ name: "mins"
+ type: Vector
+ - position: 3
+ name: "maxs"
+ type: Vector
+ - position: 4
+ name: "angles"
+ type: Angle
+ - position: 5
+ name: "duration"
+ type: number
+ default: "1"
+ - position: 6
+ name: "faceColor"
+ type: Color
+ default: "color_white"
+ - position: 7
+ name: "edgeColor"
+ type: Color
+ default: "faceColor"
returns:
---
diff --git a/docs/libraries/DebugOverlays/AddEntityTextOverlay.md b/docs/libraries/DebugOverlays/AddEntityTextOverlay.md
index 93854db7dd..757d3419c1 100644
--- a/docs/libraries/DebugOverlays/AddEntityTextOverlay.md
+++ b/docs/libraries/DebugOverlays/AddEntityTextOverlay.md
@@ -14,15 +14,23 @@ lua:
description: "Displays 2D text at the specified coordinates."
arguments:
- - name: "entity"
- type: Entity
- - name: "lineOffset"
- type: number
- - name: "text"
- type: string
- - name: "duration"
- type: number
- default: "1"
+ - position: 1
+ name: "entity"
+ type: Entity
+ - position: 2
+ name: "lineOffset"
+ type: number
+ - position: 3
+ name: "text"
+ type: string
+ - position: 4
+ name: "duration"
+ type: number
+ default: "1"
+ - position: 5
+ name: "color"
+ type: Color
+ default: "color_white"
returns:
---
diff --git a/docs/libraries/DebugOverlays/AddGrid.md b/docs/libraries/DebugOverlays/AddGrid.md
index 2b2fa3fe85..18f7c7d8b8 100644
--- a/docs/libraries/DebugOverlays/AddGrid.md
+++ b/docs/libraries/DebugOverlays/AddGrid.md
@@ -14,8 +14,9 @@ lua:
description: "Add a grid overlay to the screen."
arguments:
- - name: "origin"
- type: Vector
+ - position: 1
+ name: "origin"
+ type: Vector
returns:
---
diff --git a/docs/libraries/DebugOverlays/AddLine.md b/docs/libraries/DebugOverlays/AddLine.md
index 9a3c28daca..85902f4013 100644
--- a/docs/libraries/DebugOverlays/AddLine.md
+++ b/docs/libraries/DebugOverlays/AddLine.md
@@ -14,16 +14,24 @@ lua:
description: "Add a line overlay to the screen with alpha."
arguments:
- - name: "start"
- type: Vector
- - name: "end"
- type: Vector
- - name: "duration"
- type: number
- default: "1"
- - name: "noDepthTest"
- type: boolean
- default: "false"
+ - position: 1
+ name: "start"
+ type: Vector
+ - position: 2
+ name: "end"
+ type: Vector
+ - position: 3
+ name: "duration"
+ type: number
+ default: "1"
+ - position: 4
+ name: "color"
+ type: Color
+ default: "color_white"
+ - position: 5
+ name: "noDepthTest"
+ type: boolean
+ default: "false"
returns:
---
diff --git a/docs/libraries/DebugOverlays/AddScreenText.md b/docs/libraries/DebugOverlays/AddScreenText.md
index a058b14b35..a3491f070e 100644
--- a/docs/libraries/DebugOverlays/AddScreenText.md
+++ b/docs/libraries/DebugOverlays/AddScreenText.md
@@ -14,15 +14,23 @@ lua:
description: "Add a screen text overlay."
arguments:
- - name: "x"
- type: number
- - name: "y"
- type: number
- - name: "text"
- type: string
- - name: "duration"
- type: number
- default: "1"
+ - position: 1
+ name: "x"
+ type: number
+ - position: 2
+ name: "y"
+ type: number
+ - position: 3
+ name: "text"
+ type: string
+ - position: 4
+ name: "duration"
+ type: number
+ default: "1"
+ - position: 5
+ name: "color"
+ type: Color
+ default: "color_white"
returns:
---
diff --git a/docs/libraries/DebugOverlays/AddSweptBox.md b/docs/libraries/DebugOverlays/AddSweptBox.md
index 4693bf2202..97cb06de1d 100644
--- a/docs/libraries/DebugOverlays/AddSweptBox.md
+++ b/docs/libraries/DebugOverlays/AddSweptBox.md
@@ -14,19 +14,29 @@ lua:
description: "Add a swept box overlay to the screen."
arguments:
- - name: "start"
- type: Vector
- - name: "end"
- type: Vector
- - name: "mins"
- type: Vector
- - name: "maxs"
- type: Vector
- - name: "angles"
- type: Angle
- - name: "duration"
- type: number
- default: "1"
+ - position: 1
+ name: "start"
+ type: Vector
+ - position: 2
+ name: "end"
+ type: Vector
+ - position: 3
+ name: "mins"
+ type: Vector
+ - position: 4
+ name: "maxs"
+ type: Vector
+ - position: 5
+ name: "angles"
+ type: Angle
+ - position: 6
+ name: "duration"
+ type: number
+ default: "1"
+ - position: 7
+ name: "color"
+ type: Color
+ default: "color_white"
returns:
---
diff --git a/docs/libraries/DebugOverlays/AddText.md b/docs/libraries/DebugOverlays/AddText.md
index 07e18336d4..db5fca5fa2 100644
--- a/docs/libraries/DebugOverlays/AddText.md
+++ b/docs/libraries/DebugOverlays/AddText.md
@@ -14,19 +14,28 @@ lua:
description: "Add a text overlay to the screen with specific colors."
arguments:
- - name: "origin"
- type: Vector
- - name: "text"
- type: string
- - name: "duration"
- type: number
- default: "1"
- - name: "viewCheck"
- type: boolean
- default: "false"
- - name: "lineOffset"
- type: number
- default: "64"
+ - position: 1
+ name: "origin"
+ type: Vector
+ - position: 2
+ name: "text"
+ type: string
+ - position: 3
+ name: "duration"
+ type: number
+ default: "1"
+ - position: 4
+ name: "viewCheck"
+ type: boolean
+ default: "false"
+ - position: 5
+ name: "lineOffset"
+ type: number
+ default: "64"
+ - position: 6
+ name: "color"
+ type: Color
+ default: "color_white"
returns:
---
diff --git a/docs/libraries/DebugOverlays/AddTriangle.md b/docs/libraries/DebugOverlays/AddTriangle.md
index fe66a2773f..a2f0d191dc 100644
--- a/docs/libraries/DebugOverlays/AddTriangle.md
+++ b/docs/libraries/DebugOverlays/AddTriangle.md
@@ -14,18 +14,27 @@ lua:
description: "Add a triangle overlay to the screen."
arguments:
- - name: "p1"
- type: Vector
- - name: "p2"
- type: Vector
- - name: "p3"
- type: Vector
- - name: "duration"
- type: number
- default: "1"
- - name: "noDepthTest"
- type: boolean
- default: "false"
+ - position: 1
+ name: "p1"
+ type: Vector
+ - position: 2
+ name: "p2"
+ type: Vector
+ - position: 3
+ name: "p3"
+ type: Vector
+ - position: 4
+ name: "duration"
+ type: number
+ default: "1"
+ - position: 5
+ name: "color"
+ type: Color
+ default: "color_white"
+ - position: 6
+ name: "noDepthTest"
+ type: boolean
+ default: "false"
returns:
---
diff --git a/docs/libraries/DebugOverlays/ClearAll.md b/docs/libraries/DebugOverlays/ClearAll.md
index 2fd161c40f..614585b68f 100644
--- a/docs/libraries/DebugOverlays/ClearAll.md
+++ b/docs/libraries/DebugOverlays/ClearAll.md
@@ -13,6 +13,7 @@ lua:
realm: shared
description: "Clear all overlays."
+ arguments:
returns:
diff --git a/docs/libraries/DebugOverlays/ClearDead.md b/docs/libraries/DebugOverlays/ClearDead.md
index fcf1b99b6c..6ce4252aa5 100644
--- a/docs/libraries/DebugOverlays/ClearDead.md
+++ b/docs/libraries/DebugOverlays/ClearDead.md
@@ -13,6 +13,7 @@ lua:
realm: shared
description: "Clear dead overlays."
+ arguments:
returns:
diff --git a/docs/libraries/DebugOverlays/ScreenPosition.md b/docs/libraries/DebugOverlays/ScreenPosition.md
index 7aa67c6cbc..b7fda66dd5 100644
--- a/docs/libraries/DebugOverlays/ScreenPosition.md
+++ b/docs/libraries/DebugOverlays/ScreenPosition.md
@@ -14,8 +14,9 @@ lua:
description: "Get the screen position of a vector."
arguments:
- - name: "vec"
- type: Vector
+ - position: 1
+ name: "vec"
+ type: Vector
returns:
- type: Vector
description: "The screen position of the vector, or nil if the vector is not on the screen."
diff --git a/docs/libraries/Effects/Create.md b/docs/libraries/Effects/Create.md
index 29acd17b02..7515951a06 100644
--- a/docs/libraries/Effects/Create.md
+++ b/docs/libraries/Effects/Create.md
@@ -13,6 +13,7 @@ lua:
realm: shared
description: "Creates an effect (EffectData)."
+ arguments:
returns:
- type: EffectData
diff --git a/docs/libraries/Effects/Dispatch.md b/docs/libraries/Effects/Dispatch.md
index cf4683fb91..c0226d0877 100644
--- a/docs/libraries/Effects/Dispatch.md
+++ b/docs/libraries/Effects/Dispatch.md
@@ -14,10 +14,12 @@ lua:
description: "Dispatches an effect."
arguments:
- - name: "effectName"
- type: string
- - name: "effectData"
- type: EffectData
+ - position: 1
+ name: "effectName"
+ type: string
+ - position: 2
+ name: "effectData"
+ type: EffectData
returns:
---
diff --git a/docs/libraries/Effects/SpawnBloodDrips.md b/docs/libraries/Effects/SpawnBloodDrips.md
index 1b8c097fd1..fcc9ad26a8 100644
--- a/docs/libraries/Effects/SpawnBloodDrips.md
+++ b/docs/libraries/Effects/SpawnBloodDrips.md
@@ -14,14 +14,18 @@ lua:
description: "Creates a blood drip effect."
arguments:
- - name: "origin"
- type: Vector
- - name: "direction"
- type: Vector
- - name: "color"
- type: number
- - name: "amount"
- type: number
+ - position: 1
+ name: "origin"
+ type: Vector
+ - position: 2
+ name: "direction"
+ type: Vector
+ - position: 3
+ name: "color"
+ type: number
+ - position: 4
+ name: "amount"
+ type: number
returns:
---
diff --git a/docs/libraries/Effects/SpawnBloodImpact.md b/docs/libraries/Effects/SpawnBloodImpact.md
index 34ef14331f..a9757d3a2b 100644
--- a/docs/libraries/Effects/SpawnBloodImpact.md
+++ b/docs/libraries/Effects/SpawnBloodImpact.md
@@ -14,14 +14,18 @@ lua:
description: "Creates a blood impact effect."
arguments:
- - name: "origin"
- type: Vector
- - name: "direction"
- type: Vector
- - name: "color"
- type: number
- - name: "amount"
- type: number
+ - position: 1
+ name: "origin"
+ type: Vector
+ - position: 2
+ name: "direction"
+ type: Vector
+ - position: 3
+ name: "color"
+ type: number
+ - position: 4
+ name: "amount"
+ type: number
returns:
---
diff --git a/docs/libraries/Effects/SpawnBloodSpray.md b/docs/libraries/Effects/SpawnBloodSpray.md
index 45fe8e6e6d..2a6bdbfa99 100644
--- a/docs/libraries/Effects/SpawnBloodSpray.md
+++ b/docs/libraries/Effects/SpawnBloodSpray.md
@@ -14,16 +14,21 @@ lua:
description: "Creates a blood spray effect.\nColor can be DONT_BLEED(-1), BLOOD_COLOR_RED(0), BLOOD_COLOR_YELLOW(1), BLOOD_COLOR_GREEN(2), BLOOD_COLOR_MECH(3) - enums don't exist yet in Lua\nFlags can be FX_BLOODSPRAY_DROPS(1), FX_BLOODSPRAY_GORE(2), FX_BLOODSPRAY_CLOUD(4), FX_BLOODSPRAY_ALL(255) - enums don't exist yet in Lua"
arguments:
- - name: "origin"
- type: Vector
- - name: "direction"
- type: Vector
- - name: "color"
- type: number
- - name: "amount"
- type: number
- - name: "flags"
- type: number
+ - position: 1
+ name: "origin"
+ type: Vector
+ - position: 2
+ name: "direction"
+ type: Vector
+ - position: 3
+ name: "color"
+ type: number
+ - position: 4
+ name: "amount"
+ type: number
+ - position: 5
+ name: "flags"
+ type: number
returns:
---
diff --git a/docs/libraries/Effects/SpawnBloodStream.md b/docs/libraries/Effects/SpawnBloodStream.md
index 1329875e44..1821424345 100644
--- a/docs/libraries/Effects/SpawnBloodStream.md
+++ b/docs/libraries/Effects/SpawnBloodStream.md
@@ -14,14 +14,18 @@ lua:
description: "Creates a blood stream effect. Color can be DONT_BLEED(-1), BLOOD_COLOR_RED(0), BLOOD_COLOR_YELLOW(1), BLOOD_COLOR_GREEN(2), BLOOD_COLOR_MECH(3) - enums don't exist yet in Lua"
arguments:
- - name: "origin"
- type: Vector
- - name: "direction"
- type: Vector
- - name: "color"
- type: number
- - name: "amount"
- type: number
+ - position: 1
+ name: "origin"
+ type: Vector
+ - position: 2
+ name: "direction"
+ type: Vector
+ - position: 3
+ name: "color"
+ type: number
+ - position: 4
+ name: "amount"
+ type: number
returns:
---
diff --git a/docs/libraries/Effects/SpawnBubbleTrail.md b/docs/libraries/Effects/SpawnBubbleTrail.md
index ce3721bf34..ab635bb8b6 100644
--- a/docs/libraries/Effects/SpawnBubbleTrail.md
+++ b/docs/libraries/Effects/SpawnBubbleTrail.md
@@ -14,12 +14,15 @@ lua:
description: "Creates a bubble trail effect."
arguments:
- - name: "start"
- type: Vector
- - name: "end"
- type: Vector
- - name: "count"
- type: number
+ - position: 1
+ name: "start"
+ type: Vector
+ - position: 2
+ name: "end"
+ type: Vector
+ - position: 3
+ name: "count"
+ type: number
returns:
---
diff --git a/docs/libraries/Effects/SpawnMuzzleFlash.md b/docs/libraries/Effects/SpawnMuzzleFlash.md
index 4f6c0bfc8e..a2c4b87f43 100644
--- a/docs/libraries/Effects/SpawnMuzzleFlash.md
+++ b/docs/libraries/Effects/SpawnMuzzleFlash.md
@@ -14,15 +14,19 @@ lua:
description: "Creates a muzzle flash effect. Types can be MUZZLEFLASH_TYPE_DEFAULT(1), MUZZLEFLASH_TYPE_GUNSHIP(2), MUZZLEFLASH_TYPE_STRIDER(4) - enums don't exist yet in Lua"
arguments:
- - name: "origin"
- type: Vector
- - name: "angles"
- type: Angle
- - name: "scale"
- type: number
- - name: "type"
- type: number
- default: "MUZZLEFLASH_TYPE_DEFAULT"
+ - position: 1
+ name: "origin"
+ type: Vector
+ - position: 2
+ name: "angles"
+ type: Angle
+ - position: 3
+ name: "scale"
+ type: number
+ - position: 4
+ name: "type"
+ type: number
+ default: "MUZZLEFLASH_TYPE_DEFAULT"
returns:
---
diff --git a/docs/libraries/Effects/SpawnParticleTracer.md b/docs/libraries/Effects/SpawnParticleTracer.md
index e6f9055e95..bd67b36b47 100644
--- a/docs/libraries/Effects/SpawnParticleTracer.md
+++ b/docs/libraries/Effects/SpawnParticleTracer.md
@@ -14,21 +14,27 @@ lua:
description: "Spawns a tracer particle effect."
arguments:
- - name: "effect"
- type: string
- - name: "start"
- type: Vector
- - name: "end"
- type: Vector
- - name: "whiz"
- type: boolean
- default: "false"
- - name: "entityIndex"
- type: number
- default: "0"
- - name: "attachment"
- type: number
- default: "0"
+ - position: 1
+ name: "effect"
+ type: string
+ - position: 2
+ name: "start"
+ type: Vector
+ - position: 3
+ name: "end"
+ type: Vector
+ - position: 4
+ name: "whiz"
+ type: boolean
+ default: "false"
+ - position: 5
+ name: "entityIndex"
+ type: number
+ default: "0"
+ - position: 6
+ name: "attachment"
+ type: number
+ default: "0"
returns:
---
diff --git a/docs/libraries/Effects/SpawnTracer.md b/docs/libraries/Effects/SpawnTracer.md
index b0d11f3df0..80ea98a61a 100644
--- a/docs/libraries/Effects/SpawnTracer.md
+++ b/docs/libraries/Effects/SpawnTracer.md
@@ -14,28 +14,36 @@ lua:
description: "Creates a tracer effect."
arguments:
- - name: "start"
- type: Vector
- - name: "end"
- type: Vector
- - name: "entityIndex"
- type: number
- default: "0"
- - name: "attachment"
- type: number
- default: "0"
- - name: "velocity"
- type: number
- default: "0"
- - name: "shouldWhiz"
- type: boolean
- default: "false"
- - name: "customTracerName"
- type: string
- default: "NULL"
- - name: "particleId"
- type: number
- default: "0"
+ - position: 1
+ name: "start"
+ type: Vector
+ - position: 2
+ name: "end"
+ type: Vector
+ - position: 3
+ name: "entityIndex"
+ type: number
+ default: "0"
+ - position: 4
+ name: "attachment"
+ type: number
+ default: "0"
+ - position: 5
+ name: "velocity"
+ type: number
+ default: "0"
+ - position: 6
+ name: "shouldWhiz"
+ type: boolean
+ default: "false"
+ - position: 7
+ name: "customTracerName"
+ type: string
+ default: "NULL"
+ - position: 8
+ name: "particleId"
+ type: number
+ default: "0"
returns:
---
diff --git a/docs/libraries/EngineVgui/GetPanel.md b/docs/libraries/EngineVgui/GetPanel.md
index ce1dea9e98..b2864fcf6f 100644
--- a/docs/libraries/EngineVgui/GetPanel.md
+++ b/docs/libraries/EngineVgui/GetPanel.md
@@ -14,8 +14,9 @@ lua:
description: "Get a VGUI panel instance by panel type."
arguments:
- - name: "panelType"
- type: enumeration/VGUI_PANEL
+ - position: 1
+ name: "panelType"
+ type: enumeration/VGUI_PANEL
returns:
- type: VPanel
description: "The VGUI panel instance."
diff --git a/docs/libraries/EngineVgui/IsGameUiVisible.md b/docs/libraries/EngineVgui/IsGameUiVisible.md
new file mode 100644
index 0000000000..0b0aed4b7c
--- /dev/null
+++ b/docs/libraries/EngineVgui/IsGameUiVisible.md
@@ -0,0 +1,25 @@
+---
+template: lua-library-function.html
+title: IsGameUiVisible
+icon: lua-client
+tags:
+ - lua
+ - client
+ - needs-verification
+ - needs-example
+lua:
+ library: EngineVgui
+ function: IsGameUiVisible
+ realm: client
+ description: "Check if the game UI is currently visible."
+
+ arguments:
+
+ returns:
+ - type: boolean
+ description: "True if the game UI is visible, otherwise false."
+---
+
+
+EngineVgui.IsGameUiVisible – Check if the game UI is currently visible.
+
diff --git a/docs/libraries/Engines/ActivateOccluder.md b/docs/libraries/Engines/ActivateOccluder.md
index 914c414bcc..0e287c2a5c 100644
--- a/docs/libraries/Engines/ActivateOccluder.md
+++ b/docs/libraries/Engines/ActivateOccluder.md
@@ -14,10 +14,12 @@ lua:
description: "Allow immediate edict reuse."
arguments:
- - name: "occluderIndex"
- type: number
- - name: "shouldActivate"
- type: boolean
+ - position: 1
+ name: "occluderIndex"
+ type: number
+ - position: 2
+ name: "shouldActivate"
+ type: boolean
returns:
---
diff --git a/docs/libraries/Engines/AllowEdictReuse.md b/docs/libraries/Engines/AllowEdictReuse.md
index aac2613e61..4614a53056 100644
--- a/docs/libraries/Engines/AllowEdictReuse.md
+++ b/docs/libraries/Engines/AllowEdictReuse.md
@@ -13,6 +13,7 @@ lua:
realm: server
description: "Allow immediate edict reuse."
+ arguments:
returns:
diff --git a/docs/libraries/Engines/ChangeLevel.md b/docs/libraries/Engines/ChangeLevel.md
index 3cba27808b..ae45f65978 100644
--- a/docs/libraries/Engines/ChangeLevel.md
+++ b/docs/libraries/Engines/ChangeLevel.md
@@ -14,11 +14,13 @@ lua:
description: "Change the level."
arguments:
- - name: "levelName"
- type: string
- - name: "transitionMap"
- type: string
- default: "NULL"
+ - position: 1
+ name: "levelName"
+ type: string
+ - position: 2
+ name: "transitionMap"
+ type: string
+ default: "NULL"
returns:
---
diff --git a/docs/libraries/Engines/ChangeTeam.md b/docs/libraries/Engines/ChangeTeam.md
index a87842baca..bb1a9109ab 100644
--- a/docs/libraries/Engines/ChangeTeam.md
+++ b/docs/libraries/Engines/ChangeTeam.md
@@ -14,8 +14,9 @@ lua:
description: "Change the player's team."
arguments:
- - name: "teamName"
- type: string
+ - position: 1
+ name: "teamName"
+ type: string
returns:
---
diff --git a/docs/libraries/Engines/CheckAreasConnected.md b/docs/libraries/Engines/CheckAreasConnected.md
index 534dff3a3f..165e810480 100644
--- a/docs/libraries/Engines/CheckAreasConnected.md
+++ b/docs/libraries/Engines/CheckAreasConnected.md
@@ -14,10 +14,12 @@ lua:
description: "Check if two areas are connected."
arguments:
- - name: "startArea"
- type: number
- - name: "endArea"
- type: number
+ - position: 1
+ name: "startArea"
+ type: number
+ - position: 2
+ name: "endArea"
+ type: number
returns:
- type: boolean
description: "True if the areas are connected, false otherwise."
diff --git a/docs/libraries/Engines/CheckKeyTrapping.md b/docs/libraries/Engines/CheckKeyTrapping.md
index 2aa5d979d4..6e14318399 100644
--- a/docs/libraries/Engines/CheckKeyTrapping.md
+++ b/docs/libraries/Engines/CheckKeyTrapping.md
@@ -13,6 +13,7 @@ lua:
realm: client
description: "Check which key was last trapped."
+ arguments:
returns:
- type: enumeration/BUTTON
diff --git a/docs/libraries/Engines/CheckPoint.md b/docs/libraries/Engines/CheckPoint.md
index 29f63a9e1b..6f5dea9c9d 100644
--- a/docs/libraries/Engines/CheckPoint.md
+++ b/docs/libraries/Engines/CheckPoint.md
@@ -14,8 +14,9 @@ lua:
description: "Check a point."
arguments:
- - name: "pointName"
- type: string
+ - position: 1
+ name: "pointName"
+ type: string
returns:
---
diff --git a/docs/libraries/Engines/ClientCommand.md b/docs/libraries/Engines/ClientCommand.md
index f3350476fb..71e458fd84 100644
--- a/docs/libraries/Engines/ClientCommand.md
+++ b/docs/libraries/Engines/ClientCommand.md
@@ -14,8 +14,9 @@ lua:
description: "Send a command to the client."
arguments:
- - name: "command"
- type: string
+ - position: 1
+ name: "command"
+ type: string
returns:
---
diff --git a/docs/libraries/Engines/ClientCommandUnrestricted.md b/docs/libraries/Engines/ClientCommandUnrestricted.md
index 8f1ef52695..b4e67a5347 100644
--- a/docs/libraries/Engines/ClientCommandUnrestricted.md
+++ b/docs/libraries/Engines/ClientCommandUnrestricted.md
@@ -14,8 +14,9 @@ lua:
description: "Send a command to the client without any restrictions."
arguments:
- - name: "command"
- type: string
+ - position: 1
+ name: "command"
+ type: string
returns:
---
diff --git a/docs/libraries/Engines/CopyFile.md b/docs/libraries/Engines/CopyFile.md
index a35dd34b7b..e9ff0830ab 100644
--- a/docs/libraries/Engines/CopyFile.md
+++ b/docs/libraries/Engines/CopyFile.md
@@ -14,10 +14,12 @@ lua:
description: "Copy a file."
arguments:
- - name: "source"
- type: string
- - name: "destination"
- type: string
+ - position: 1
+ name: "source"
+ type: string
+ - position: 2
+ name: "destination"
+ type: string
returns:
- type: boolean
description: "True if the file was copied, false otherwise."
diff --git a/docs/libraries/Engines/CopyFrameBufferToMaterial.md b/docs/libraries/Engines/CopyFrameBufferToMaterial.md
index 7b285f1133..52a8644f90 100644
--- a/docs/libraries/Engines/CopyFrameBufferToMaterial.md
+++ b/docs/libraries/Engines/CopyFrameBufferToMaterial.md
@@ -14,8 +14,9 @@ lua:
description: "Copy the frame buffer to a material."
arguments:
- - name: "materialName"
- type: string
+ - position: 1
+ name: "materialName"
+ type: string
returns:
- type: boolean
description: "True if the frame buffer was copied to the material, false otherwise."
diff --git a/docs/libraries/Engines/CreateFakeClient.md b/docs/libraries/Engines/CreateFakeClient.md
index 3d4536aa32..e7c1906c36 100644
--- a/docs/libraries/Engines/CreateFakeClient.md
+++ b/docs/libraries/Engines/CreateFakeClient.md
@@ -14,8 +14,9 @@ lua:
description: "Create a fake client."
arguments:
- - name: "name"
- type: string
+ - position: 1
+ name: "name"
+ type: string
returns:
- type: Entity
description: "The created fake client."
diff --git a/docs/libraries/Engines/CullBox.md b/docs/libraries/Engines/CullBox.md
index 71659c398a..ee76cdcab1 100644
--- a/docs/libraries/Engines/CullBox.md
+++ b/docs/libraries/Engines/CullBox.md
@@ -14,10 +14,12 @@ lua:
description: "Cull a box."
arguments:
- - name: "boxMin"
- type: Vector
- - name: "boxMax"
- type: Vector
+ - position: 1
+ name: "boxMin"
+ type: Vector
+ - position: 2
+ name: "boxMax"
+ type: Vector
returns:
- type: boolean
description: "True if the box was culled, false otherwise."
diff --git a/docs/libraries/Engines/DoesBoxTouchAreaFrustum.md b/docs/libraries/Engines/DoesBoxTouchAreaFrustum.md
index df99a147e4..ecdd2b964a 100644
--- a/docs/libraries/Engines/DoesBoxTouchAreaFrustum.md
+++ b/docs/libraries/Engines/DoesBoxTouchAreaFrustum.md
@@ -14,12 +14,15 @@ lua:
description: "Check if a box touches an area frustum."
arguments:
- - name: "boxMin"
- type: Vector
- - name: "boxMax"
- type: Vector
- - name: "area"
- type: number
+ - position: 1
+ name: "boxMin"
+ type: Vector
+ - position: 2
+ name: "boxMax"
+ type: Vector
+ - position: 3
+ name: "area"
+ type: number
returns:
- type: boolean
description: "True if the box touches the area frustum, false otherwise."
diff --git a/docs/libraries/Engines/DrawPortals.md b/docs/libraries/Engines/DrawPortals.md
index 7c42133e97..af249f4926 100644
--- a/docs/libraries/Engines/DrawPortals.md
+++ b/docs/libraries/Engines/DrawPortals.md
@@ -13,6 +13,7 @@ lua:
realm: client
description: "Draw portals."
+ arguments:
returns:
diff --git a/docs/libraries/Engines/EngineStatsBeginFrame.md b/docs/libraries/Engines/EngineStatsBeginFrame.md
index fbe65be496..4f3c7f3c5d 100644
--- a/docs/libraries/Engines/EngineStatsBeginFrame.md
+++ b/docs/libraries/Engines/EngineStatsBeginFrame.md
@@ -13,6 +13,7 @@ lua:
realm: client
description: "Begin engine stats frame."
+ arguments:
returns:
diff --git a/docs/libraries/Engines/EngineStatsEndFrame.md b/docs/libraries/Engines/EngineStatsEndFrame.md
index d59d570395..0d7fbecad1 100644
--- a/docs/libraries/Engines/EngineStatsEndFrame.md
+++ b/docs/libraries/Engines/EngineStatsEndFrame.md
@@ -13,6 +13,7 @@ lua:
realm: client
description: "End engine stats frame."
+ arguments:
returns:
diff --git a/docs/libraries/Engines/ExecuteClientCommand.md b/docs/libraries/Engines/ExecuteClientCommand.md
index c7cad1e76c..cfc0570ad8 100644
--- a/docs/libraries/Engines/ExecuteClientCommand.md
+++ b/docs/libraries/Engines/ExecuteClientCommand.md
@@ -14,8 +14,9 @@ lua:
description: "Execute a client command."
arguments:
- - name: "command"
- type: string
+ - position: 1
+ name: "command"
+ type: string
returns:
---
diff --git a/docs/libraries/Engines/FireEvents.md b/docs/libraries/Engines/FireEvents.md
index 00fd6b900f..b7e71c95ac 100644
--- a/docs/libraries/Engines/FireEvents.md
+++ b/docs/libraries/Engines/FireEvents.md
@@ -13,6 +13,7 @@ lua:
realm: client
description: "Fire events."
+ arguments:
returns:
diff --git a/docs/libraries/Engines/ForceExactFile.md b/docs/libraries/Engines/ForceExactFile.md
index 36b8e2d7fe..b94b316d6f 100644
--- a/docs/libraries/Engines/ForceExactFile.md
+++ b/docs/libraries/Engines/ForceExactFile.md
@@ -14,8 +14,9 @@ lua:
description: "Force a file to be exact."
arguments:
- - name: "fileName"
- type: string
+ - position: 1
+ name: "fileName"
+ type: string
returns:
---
diff --git a/docs/libraries/Engines/ForceSimpleMaterial.md b/docs/libraries/Engines/ForceSimpleMaterial.md
index f5bf1b78de..9c596b41e4 100644
--- a/docs/libraries/Engines/ForceSimpleMaterial.md
+++ b/docs/libraries/Engines/ForceSimpleMaterial.md
@@ -14,8 +14,9 @@ lua:
description: "Force a material to be simple."
arguments:
- - name: "materialName"
- type: string
+ - position: 1
+ name: "materialName"
+ type: string
returns:
---
diff --git a/docs/libraries/Engines/GameLumpSize.md b/docs/libraries/Engines/GameLumpSize.md
index 9bcc7a6898..d29bd065a8 100644
--- a/docs/libraries/Engines/GameLumpSize.md
+++ b/docs/libraries/Engines/GameLumpSize.md
@@ -14,8 +14,9 @@ lua:
description: "Get the size of a game lump."
arguments:
- - name: "lumpId"
- type: number
+ - position: 1
+ name: "lumpId"
+ type: number
returns:
- type: integer
description: "The size of the game lump."
diff --git a/docs/libraries/Engines/GameLumpVersion.md b/docs/libraries/Engines/GameLumpVersion.md
index 1cff5b20bd..74f4056a42 100644
--- a/docs/libraries/Engines/GameLumpVersion.md
+++ b/docs/libraries/Engines/GameLumpVersion.md
@@ -14,8 +14,9 @@ lua:
description: "Get the version of a game lump."
arguments:
- - name: "lumpId"
- type: number
+ - position: 1
+ name: "lumpId"
+ type: number
returns:
- type: integer
description: "The version of the game lump."
diff --git a/docs/libraries/Engines/GetAbsoluteFrameTime.md b/docs/libraries/Engines/GetAbsoluteFrameTime.md
index 46c8f2008b..b1aa04bccc 100644
--- a/docs/libraries/Engines/GetAbsoluteFrameTime.md
+++ b/docs/libraries/Engines/GetAbsoluteFrameTime.md
@@ -13,6 +13,7 @@ lua:
realm: shared
description: "Get the absolute frame time."
+ arguments:
returns:
- type: number
diff --git a/docs/libraries/Engines/GetAppId.md b/docs/libraries/Engines/GetAppId.md
index 5ae9a142e0..be6975d436 100644
--- a/docs/libraries/Engines/GetAppId.md
+++ b/docs/libraries/Engines/GetAppId.md
@@ -13,6 +13,7 @@ lua:
realm: shared
description: "Get the AppID of the game."
+ arguments:
returns:
- type: integer
diff --git a/docs/libraries/Engines/GetClientConsoleVariableValue.client.md b/docs/libraries/Engines/GetClientConsoleVariableValue.client.md
index 572daa7756..db021cde4e 100644
--- a/docs/libraries/Engines/GetClientConsoleVariableValue.client.md
+++ b/docs/libraries/Engines/GetClientConsoleVariableValue.client.md
@@ -13,15 +13,16 @@ lua:
realm: client
description: "Get the value of a client console variable."
- argumentSets:
- - arguments:
+ arguments:
+ - position: 1
+ types:
- name: "playerOrIndex"
type: Player
- - arguments:
- name: "playerOrIndex"
type: number
- - name: "varName"
- type: string
+ - position: 2
+ name: "varName"
+ type: string
returns:
- type: string
description: "The value of the client console variable."
diff --git a/docs/libraries/Engines/GetClientConsoleVariableValue.server.md b/docs/libraries/Engines/GetClientConsoleVariableValue.server.md
index fd4530f659..b38486e407 100644
--- a/docs/libraries/Engines/GetClientConsoleVariableValue.server.md
+++ b/docs/libraries/Engines/GetClientConsoleVariableValue.server.md
@@ -13,15 +13,16 @@ lua:
realm: server
description: "Get a client's ConsoleVariable value."
- argumentSets:
- - arguments:
+ arguments:
+ - position: 1
+ types:
- name: "playerOrIndex"
type: Player
- - arguments:
- name: "playerOrIndex"
type: number
- - name: "conVarName"
- type: string
+ - position: 2
+ name: "conVarName"
+ type: string
returns:
- type: string
description: "The client's ConsoleVariable value."
diff --git a/docs/libraries/Engines/GetClientConsoleVariableValueAsNumber.client.md b/docs/libraries/Engines/GetClientConsoleVariableValueAsNumber.client.md
index 56c14260af..01f9f3c840 100644
--- a/docs/libraries/Engines/GetClientConsoleVariableValueAsNumber.client.md
+++ b/docs/libraries/Engines/GetClientConsoleVariableValueAsNumber.client.md
@@ -13,15 +13,16 @@ lua:
realm: client
description: "Get the value of a client console variable as a number."
- argumentSets:
- - arguments:
+ arguments:
+ - position: 1
+ types:
- name: "playerOrIndex"
type: Player
- - arguments:
- name: "playerOrIndex"
type: number
- - name: "varName"
- type: string
+ - position: 2
+ name: "varName"
+ type: string
returns:
- type: number
description: "The value of the client console variable as a number."
diff --git a/docs/libraries/Engines/GetClientConsoleVariableValueAsNumber.server.md b/docs/libraries/Engines/GetClientConsoleVariableValueAsNumber.server.md
index 5740d51de9..9f53f4bb8b 100644
--- a/docs/libraries/Engines/GetClientConsoleVariableValueAsNumber.server.md
+++ b/docs/libraries/Engines/GetClientConsoleVariableValueAsNumber.server.md
@@ -13,15 +13,16 @@ lua:
realm: server
description: "Get a client's ConsoleVariable value as a number."
- argumentSets:
- - arguments:
+ arguments:
+ - position: 1
+ types:
- name: "playerOrIndex"
type: Player
- - arguments:
- name: "playerOrIndex"
type: number
- - name: "conVarName"
- type: string
+ - position: 2
+ name: "conVarName"
+ type: string
returns:
- type: integer
description: "The client's ConsoleVariable value as a number."
diff --git a/docs/libraries/Engines/GetCurrentTime.md b/docs/libraries/Engines/GetCurrentTime.md
index ecd4d8cc83..a097ea2c17 100644
--- a/docs/libraries/Engines/GetCurrentTime.md
+++ b/docs/libraries/Engines/GetCurrentTime.md
@@ -13,6 +13,7 @@ lua:
realm: shared
description: "Get the current time."
+ arguments:
returns:
- type: number
diff --git a/docs/libraries/Engines/GetDxSupportLevel.md b/docs/libraries/Engines/GetDxSupportLevel.md
index c5e4add209..69543165da 100644
--- a/docs/libraries/Engines/GetDxSupportLevel.md
+++ b/docs/libraries/Engines/GetDxSupportLevel.md
@@ -13,6 +13,7 @@ lua:
realm: client
description: "Get the DirectX support level."
+ arguments:
returns:
- type: integer
diff --git a/docs/libraries/Engines/GetEngineBuildNumber.md b/docs/libraries/Engines/GetEngineBuildNumber.md
index ff43154472..a80491359f 100644
--- a/docs/libraries/Engines/GetEngineBuildNumber.md
+++ b/docs/libraries/Engines/GetEngineBuildNumber.md
@@ -13,6 +13,7 @@ lua:
realm: client
description: "Get the engine build number."
+ arguments:
returns:
- type: integer
diff --git a/docs/libraries/Engines/GetEntityCount.md b/docs/libraries/Engines/GetEntityCount.md
index 4596e23b7a..f53cf79065 100644
--- a/docs/libraries/Engines/GetEntityCount.md
+++ b/docs/libraries/Engines/GetEntityCount.md
@@ -13,6 +13,7 @@ lua:
realm: server
description: "Get the entity count."
+ arguments:
returns:
- type: integer
diff --git a/docs/libraries/Engines/GetFrameCount.md b/docs/libraries/Engines/GetFrameCount.md
index b85f61c300..9a32e52f56 100644
--- a/docs/libraries/Engines/GetFrameCount.md
+++ b/docs/libraries/Engines/GetFrameCount.md
@@ -13,6 +13,7 @@ lua:
realm: shared
description: "Get the frame count."
+ arguments:
returns:
- type: integer
diff --git a/docs/libraries/Engines/GetFrameTime.md b/docs/libraries/Engines/GetFrameTime.md
index 5118ce66cd..54f2ccc17f 100644
--- a/docs/libraries/Engines/GetFrameTime.md
+++ b/docs/libraries/Engines/GetFrameTime.md
@@ -13,6 +13,7 @@ lua:
realm: shared
description: "Get the frame time."
+ arguments:
returns:
- type: number
diff --git a/docs/libraries/Engines/GetGameDir.md b/docs/libraries/Engines/GetGameDir.md
index 1539cb481b..062b19e290 100644
--- a/docs/libraries/Engines/GetGameDir.md
+++ b/docs/libraries/Engines/GetGameDir.md
@@ -13,6 +13,7 @@ lua:
realm: shared
description: "Get the game directory."
+ arguments:
returns:
- type: string
diff --git a/docs/libraries/Engines/GetGameDirectory.md b/docs/libraries/Engines/GetGameDirectory.md
index 2b6c771e2f..a05f7d21a3 100644
--- a/docs/libraries/Engines/GetGameDirectory.md
+++ b/docs/libraries/Engines/GetGameDirectory.md
@@ -13,6 +13,7 @@ lua:
realm: client
description: "Get the game directory."
+ arguments:
returns:
- type: string
diff --git a/docs/libraries/Engines/GetIntervalPerTick.md b/docs/libraries/Engines/GetIntervalPerTick.md
index 6cd08e752b..7823f3c992 100644
--- a/docs/libraries/Engines/GetIntervalPerTick.md
+++ b/docs/libraries/Engines/GetIntervalPerTick.md
@@ -13,6 +13,7 @@ lua:
realm: shared
description: "Get the interval per tick."
+ arguments:
returns:
- type: number
diff --git a/docs/libraries/Engines/GetLastTimeStamp.md b/docs/libraries/Engines/GetLastTimeStamp.md
index dd7cd9b646..6ab28b4526 100644
--- a/docs/libraries/Engines/GetLastTimeStamp.md
+++ b/docs/libraries/Engines/GetLastTimeStamp.md
@@ -13,6 +13,7 @@ lua:
realm: client
description: "Get the last time stamp."
+ arguments:
returns:
- type: number
diff --git a/docs/libraries/Engines/GetLevelName.md b/docs/libraries/Engines/GetLevelName.md
index a6d56304f2..bacaff156a 100644
--- a/docs/libraries/Engines/GetLevelName.md
+++ b/docs/libraries/Engines/GetLevelName.md
@@ -13,6 +13,7 @@ lua:
realm: shared
description: "Get the name of the current level."
+ arguments:
returns:
- type: string
diff --git a/docs/libraries/Engines/GetLightForPoint.md b/docs/libraries/Engines/GetLightForPoint.md
index b2dec05839..79e83c130b 100644
--- a/docs/libraries/Engines/GetLightForPoint.md
+++ b/docs/libraries/Engines/GetLightForPoint.md
@@ -14,10 +14,12 @@ lua:
description: "Get the light for a point."
arguments:
- - name: "point"
- type: Vector
- - name: "clamp"
- type: boolean
+ - position: 1
+ name: "point"
+ type: Vector
+ - position: 2
+ name: "clamp"
+ type: boolean
returns:
- type: Vector
description: "The light for the point."
diff --git a/docs/libraries/Engines/GetLightForPointFast.md b/docs/libraries/Engines/GetLightForPointFast.md
index 21b908e376..e4685f96b3 100644
--- a/docs/libraries/Engines/GetLightForPointFast.md
+++ b/docs/libraries/Engines/GetLightForPointFast.md
@@ -14,10 +14,12 @@ lua:
description: "Get the light for a point quickly."
arguments:
- - name: "point"
- type: Vector
- - name: "clamp"
- type: boolean
+ - position: 1
+ name: "point"
+ type: Vector
+ - position: 2
+ name: "clamp"
+ type: boolean
returns:
- type: Vector
description: "The light for the point."
diff --git a/docs/libraries/Engines/GetListenServerHost.md b/docs/libraries/Engines/GetListenServerHost.md
index 02720537e9..99d84d387b 100644
--- a/docs/libraries/Engines/GetListenServerHost.md
+++ b/docs/libraries/Engines/GetListenServerHost.md
@@ -13,6 +13,7 @@ lua:
realm: server
description: "Get the local player on a listen server - this is for multiplayer use only."
+ arguments:
returns:
- type: Entity
diff --git a/docs/libraries/Engines/GetLocalPlayerEntityIndex.md b/docs/libraries/Engines/GetLocalPlayerEntityIndex.md
index b133f4a972..7fe0644442 100644
--- a/docs/libraries/Engines/GetLocalPlayerEntityIndex.md
+++ b/docs/libraries/Engines/GetLocalPlayerEntityIndex.md
@@ -13,6 +13,7 @@ lua:
realm: client
description: "Get the local player entity index."
+ arguments:
returns:
- type: integer
diff --git a/docs/libraries/Engines/GetMainMenuBackgroundName.md b/docs/libraries/Engines/GetMainMenuBackgroundName.md
index 693d93639f..40b1fd9b10 100644
--- a/docs/libraries/Engines/GetMainMenuBackgroundName.md
+++ b/docs/libraries/Engines/GetMainMenuBackgroundName.md
@@ -13,6 +13,7 @@ lua:
realm: client
description: "Get the main menu background name."
+ arguments:
returns:
- type: string
diff --git a/docs/libraries/Engines/GetMapEntitiesString.md b/docs/libraries/Engines/GetMapEntitiesString.md
index d4c7a59176..09e46d4d9c 100644
--- a/docs/libraries/Engines/GetMapEntitiesString.md
+++ b/docs/libraries/Engines/GetMapEntitiesString.md
@@ -13,6 +13,7 @@ lua:
realm: shared
description: "Get the map entities string."
+ arguments:
returns:
- type: string
diff --git a/docs/libraries/Engines/GetMaxClients.md b/docs/libraries/Engines/GetMaxClients.md
index dd1c97af8b..cf6e583ce2 100644
--- a/docs/libraries/Engines/GetMaxClients.md
+++ b/docs/libraries/Engines/GetMaxClients.md
@@ -13,6 +13,7 @@ lua:
realm: shared
description: "Get the maximum number of clients."
+ arguments:
returns:
- type: integer
diff --git a/docs/libraries/Engines/GetMostRecentSaveGame.md b/docs/libraries/Engines/GetMostRecentSaveGame.md
index 6723d191c8..f8ef397b76 100644
--- a/docs/libraries/Engines/GetMostRecentSaveGame.md
+++ b/docs/libraries/Engines/GetMostRecentSaveGame.md
@@ -13,6 +13,7 @@ lua:
realm: client
description: "Get the most recent save game."
+ arguments:
returns:
- type: string
diff --git a/docs/libraries/Engines/GetMostRecentlyLoadedFileName.md b/docs/libraries/Engines/GetMostRecentlyLoadedFileName.md
index 908394f309..0ddcb81b7f 100644
--- a/docs/libraries/Engines/GetMostRecentlyLoadedFileName.md
+++ b/docs/libraries/Engines/GetMostRecentlyLoadedFileName.md
@@ -13,6 +13,7 @@ lua:
realm: server
description: "Get the most recently loaded file name."
+ arguments:
returns:
- type: string
diff --git a/docs/libraries/Engines/GetMountableGames.md b/docs/libraries/Engines/GetMountableGames.md
index 33c5525011..271b96f038 100644
--- a/docs/libraries/Engines/GetMountableGames.md
+++ b/docs/libraries/Engines/GetMountableGames.md
@@ -13,6 +13,7 @@ lua:
realm: shared
description: "Get a list of mountable games."
+ arguments:
returns:
- type: table
diff --git a/docs/libraries/Engines/GetNetworkProtocol.md b/docs/libraries/Engines/GetNetworkProtocol.md
index 3edbdf093c..5ca522560a 100644
--- a/docs/libraries/Engines/GetNetworkProtocol.md
+++ b/docs/libraries/Engines/GetNetworkProtocol.md
@@ -13,6 +13,7 @@ lua:
realm: shared
description: "Get the network protocol."
+ arguments:
returns:
- type: integer
diff --git a/docs/libraries/Engines/GetPlayerByAddress.md b/docs/libraries/Engines/GetPlayerByAddress.md
index 86b2719978..96f3c49cd1 100644
--- a/docs/libraries/Engines/GetPlayerByAddress.md
+++ b/docs/libraries/Engines/GetPlayerByAddress.md
@@ -14,8 +14,9 @@ lua:
description: "Get a player by their address."
arguments:
- - name: "address"
- type: string
+ - position: 1
+ name: "address"
+ type: string
returns:
- type: Player
description: "The player entity."
diff --git a/docs/libraries/Engines/GetPlayerEntityIndexForUserId.md b/docs/libraries/Engines/GetPlayerEntityIndexForUserId.md
index 2b76ce58e2..b8d306cef4 100644
--- a/docs/libraries/Engines/GetPlayerEntityIndexForUserId.md
+++ b/docs/libraries/Engines/GetPlayerEntityIndexForUserId.md
@@ -14,8 +14,9 @@ lua:
description: "Get the player entity number for a user ID."
arguments:
- - name: "userId"
- type: number
+ - position: 1
+ name: "userId"
+ type: number
returns:
- type: integer
description: "The player entity number for the user ID."
diff --git a/docs/libraries/Engines/GetPlayerInfo.md b/docs/libraries/Engines/GetPlayerInfo.md
index 4f2f7f262c..200857d7ca 100644
--- a/docs/libraries/Engines/GetPlayerInfo.md
+++ b/docs/libraries/Engines/GetPlayerInfo.md
@@ -14,8 +14,9 @@ lua:
description: "Get the player information."
arguments:
- - name: "playerIndex"
- type: number
+ - position: 1
+ name: "playerIndex"
+ type: number
returns:
- type: table
description: "The player information."
diff --git a/docs/libraries/Engines/GetPlayerNetInfo.md b/docs/libraries/Engines/GetPlayerNetInfo.md
index 9d878ecf22..547955cd14 100644
--- a/docs/libraries/Engines/GetPlayerNetInfo.md
+++ b/docs/libraries/Engines/GetPlayerNetInfo.md
@@ -14,8 +14,9 @@ lua:
description: "Get the player's net info."
arguments:
- - name: "playerIndex"
- type: number
+ - position: 1
+ name: "playerIndex"
+ type: number
returns:
- type: netchannel
description: "The player's net info."
diff --git a/docs/libraries/Engines/GetProductVersionString.md b/docs/libraries/Engines/GetProductVersionString.md
index a942f11a36..662c5969e9 100644
--- a/docs/libraries/Engines/GetProductVersionString.md
+++ b/docs/libraries/Engines/GetProductVersionString.md
@@ -13,6 +13,7 @@ lua:
realm: client
description: "Get the product version string."
+ arguments:
returns:
- type: string
diff --git a/docs/libraries/Engines/GetRealTime.md b/docs/libraries/Engines/GetRealTime.md
index f1f9ba04ba..d00bea30b0 100644
--- a/docs/libraries/Engines/GetRealTime.md
+++ b/docs/libraries/Engines/GetRealTime.md
@@ -13,6 +13,7 @@ lua:
realm: shared
description: "Get the real time."
+ arguments:
returns:
- type: number
diff --git a/docs/libraries/Engines/GetSaveFileName.md b/docs/libraries/Engines/GetSaveFileName.md
index c058c5d0a0..c55a2a1654 100644
--- a/docs/libraries/Engines/GetSaveFileName.md
+++ b/docs/libraries/Engines/GetSaveFileName.md
@@ -13,6 +13,7 @@ lua:
realm: server
description: "Get the save file name."
+ arguments:
returns:
- type: string
diff --git a/docs/libraries/Engines/GetScreenAspectRatio.md b/docs/libraries/Engines/GetScreenAspectRatio.md
index 34b41051a8..4fda5764c7 100644
--- a/docs/libraries/Engines/GetScreenAspectRatio.md
+++ b/docs/libraries/Engines/GetScreenAspectRatio.md
@@ -13,6 +13,7 @@ lua:
realm: client
description: "Get the screen aspect ratio."
+ arguments:
returns:
- type: number
diff --git a/docs/libraries/Engines/GetScreenSize.md b/docs/libraries/Engines/GetScreenSize.md
index 3079706f11..9e10039bfb 100644
--- a/docs/libraries/Engines/GetScreenSize.md
+++ b/docs/libraries/Engines/GetScreenSize.md
@@ -13,6 +13,7 @@ lua:
realm: client
description: "Get the screen size."
+ arguments:
returns:
- type: integer
diff --git a/docs/libraries/Engines/GetServerAddress.md b/docs/libraries/Engines/GetServerAddress.md
index 6a43b498f0..061697724c 100644
--- a/docs/libraries/Engines/GetServerAddress.md
+++ b/docs/libraries/Engines/GetServerAddress.md
@@ -13,6 +13,7 @@ lua:
realm: shared
description: "Get the server address."
+ arguments:
returns:
- type: string
diff --git a/docs/libraries/Engines/GetServerName.md b/docs/libraries/Engines/GetServerName.md
index 3fed7c6af9..3736c00824 100644
--- a/docs/libraries/Engines/GetServerName.md
+++ b/docs/libraries/Engines/GetServerName.md
@@ -13,6 +13,7 @@ lua:
realm: shared
description: "Get the server name."
+ arguments:
returns:
- type: string
diff --git a/docs/libraries/Engines/GetSimulatedTicksThisFrame.md b/docs/libraries/Engines/GetSimulatedTicksThisFrame.md
index 8e11c89ee8..7a27f47cbd 100644
--- a/docs/libraries/Engines/GetSimulatedTicksThisFrame.md
+++ b/docs/libraries/Engines/GetSimulatedTicksThisFrame.md
@@ -13,6 +13,7 @@ lua:
realm: shared
description: "Get the number of simulated ticks this frame."
+ arguments:
returns:
- type: integer
diff --git a/docs/libraries/Engines/GetSimulationInterval.md b/docs/libraries/Engines/GetSimulationInterval.md
index 58e48721f2..ff46f40627 100644
--- a/docs/libraries/Engines/GetSimulationInterval.md
+++ b/docs/libraries/Engines/GetSimulationInterval.md
@@ -13,6 +13,7 @@ lua:
realm: server
description: "Get the simulation interval."
+ arguments:
returns:
- type: number
diff --git a/docs/libraries/Engines/GetSoundDuration.md b/docs/libraries/Engines/GetSoundDuration.md
index a92270e4fc..e580d23c6b 100644
--- a/docs/libraries/Engines/GetSoundDuration.md
+++ b/docs/libraries/Engines/GetSoundDuration.md
@@ -14,8 +14,9 @@ lua:
description: "Get the duration of a sound."
arguments:
- - name: "soundName"
- type: string
+ - position: 1
+ name: "soundName"
+ type: string
returns:
- type: number
description: "The duration of the sound."
diff --git a/docs/libraries/Engines/GetSystemTime.md b/docs/libraries/Engines/GetSystemTime.md
index 5643a243e0..91932a6825 100644
--- a/docs/libraries/Engines/GetSystemTime.md
+++ b/docs/libraries/Engines/GetSystemTime.md
@@ -13,6 +13,7 @@ lua:
realm: shared
description: "Get the system time."
+ arguments:
returns:
- type: number
diff --git a/docs/libraries/Engines/GetTickCount.md b/docs/libraries/Engines/GetTickCount.md
index 485d4ded3f..053511e22c 100644
--- a/docs/libraries/Engines/GetTickCount.md
+++ b/docs/libraries/Engines/GetTickCount.md
@@ -13,6 +13,7 @@ lua:
realm: shared
description: "Get the tick count."
+ arguments:
returns:
- type: integer
diff --git a/docs/libraries/Engines/GetUiLanguage.md b/docs/libraries/Engines/GetUiLanguage.md
index 21db5e15f3..77a0ab19fb 100644
--- a/docs/libraries/Engines/GetUiLanguage.md
+++ b/docs/libraries/Engines/GetUiLanguage.md
@@ -13,6 +13,7 @@ lua:
realm: client
description: "Get the UI language."
+ arguments:
returns:
- type: string
diff --git a/docs/libraries/Engines/GrabPreColorCorrectedFrame.md b/docs/libraries/Engines/GrabPreColorCorrectedFrame.md
index 08dd6380c0..ebbd62be0f 100644
--- a/docs/libraries/Engines/GrabPreColorCorrectedFrame.md
+++ b/docs/libraries/Engines/GrabPreColorCorrectedFrame.md
@@ -14,14 +14,18 @@ lua:
description: "Grab a pre-color corrected frame."
arguments:
- - name: "x"
- type: number
- - name: "y"
- type: number
- - name: "width"
- type: number
- - name: "height"
- type: number
+ - position: 1
+ name: "x"
+ type: number
+ - position: 2
+ name: "y"
+ type: number
+ - position: 3
+ name: "width"
+ type: number
+ - position: 4
+ name: "height"
+ type: number
returns:
---
diff --git a/docs/libraries/Engines/IndexOfEdict.md b/docs/libraries/Engines/IndexOfEdict.md
index 10babdd59f..b0ef0b4502 100644
--- a/docs/libraries/Engines/IndexOfEdict.md
+++ b/docs/libraries/Engines/IndexOfEdict.md
@@ -14,8 +14,9 @@ lua:
description: "Get the index of an edict."
arguments:
- - name: "entity"
- type: Entity
+ - position: 1
+ name: "entity"
+ type: Entity
returns:
- type: integer
description: "The index of the edict."
diff --git a/docs/libraries/Engines/InsertServerCommand.md b/docs/libraries/Engines/InsertServerCommand.md
index e79886323a..f9f6aeb358 100644
--- a/docs/libraries/Engines/InsertServerCommand.md
+++ b/docs/libraries/Engines/InsertServerCommand.md
@@ -14,8 +14,9 @@ lua:
description: "Insert a server command."
arguments:
- - name: "command"
- type: string
+ - position: 1
+ name: "command"
+ type: string
returns:
---
diff --git a/docs/libraries/Engines/IsBoxInViewCluster.md b/docs/libraries/Engines/IsBoxInViewCluster.md
index 07dd56222a..5caa80544e 100644
--- a/docs/libraries/Engines/IsBoxInViewCluster.md
+++ b/docs/libraries/Engines/IsBoxInViewCluster.md
@@ -14,10 +14,12 @@ lua:
description: "Check if a box is in a view cluster."
arguments:
- - name: "boxMin"
- type: Vector
- - name: "boxMax"
- type: Vector
+ - position: 1
+ name: "boxMin"
+ type: Vector
+ - position: 2
+ name: "boxMax"
+ type: Vector
returns:
- type: boolean
description: "True if the box is in the view cluster, false otherwise."
diff --git a/docs/libraries/Engines/IsBoxVisible.md b/docs/libraries/Engines/IsBoxVisible.md
index ce4f5f5677..18e50a4123 100644
--- a/docs/libraries/Engines/IsBoxVisible.md
+++ b/docs/libraries/Engines/IsBoxVisible.md
@@ -14,10 +14,12 @@ lua:
description: "Check if a box is visible."
arguments:
- - name: "boxMin"
- type: Vector
- - name: "boxMax"
- type: Vector
+ - position: 1
+ name: "boxMin"
+ type: Vector
+ - position: 2
+ name: "boxMax"
+ type: Vector
returns:
- type: boolean
description: "True if the box is visible, false otherwise."
diff --git a/docs/libraries/Engines/IsClient.md b/docs/libraries/Engines/IsClient.md
index 6fe87f6ee2..da1a8d914b 100644
--- a/docs/libraries/Engines/IsClient.md
+++ b/docs/libraries/Engines/IsClient.md
@@ -13,6 +13,7 @@ lua:
realm: shared
description: "Check if the game is running on the client."
+ arguments:
returns:
- type: boolean
diff --git a/docs/libraries/Engines/IsConnected.md b/docs/libraries/Engines/IsConnected.md
index 047c2677b1..35a6072099 100644
--- a/docs/libraries/Engines/IsConnected.md
+++ b/docs/libraries/Engines/IsConnected.md
@@ -13,6 +13,7 @@ lua:
realm: client
description: "Check if the client is connected."
+ arguments:
returns:
- type: boolean
diff --git a/docs/libraries/Engines/ConIsVisible.md b/docs/libraries/Engines/IsConsoleVisible.md
similarity index 73%
rename from docs/libraries/Engines/ConIsVisible.md
rename to docs/libraries/Engines/IsConsoleVisible.md
index 34c5ae4525..f9718e7321 100644
--- a/docs/libraries/Engines/ConIsVisible.md
+++ b/docs/libraries/Engines/IsConsoleVisible.md
@@ -1,6 +1,6 @@
---
template: lua-library-function.html
-title: ConIsVisible
+title: IsConsoleVisible
icon: lua-client
tags:
- lua
@@ -9,10 +9,11 @@ tags:
- needs-example
lua:
library: Engines
- function: ConIsVisible
+ function: IsConsoleVisible
realm: client
description: "Check if the console is visible."
+ arguments:
returns:
- type: boolean
@@ -20,5 +21,5 @@ lua:
---
-Engines.ConIsVisible – Check if the console is visible.
+Engines.IsConsoleVisible – Check if the console is visible.
diff --git a/docs/libraries/Engines/IsDecalPrecached.md b/docs/libraries/Engines/IsDecalPrecached.md
index d81c468eeb..d76c26be4a 100644
--- a/docs/libraries/Engines/IsDecalPrecached.md
+++ b/docs/libraries/Engines/IsDecalPrecached.md
@@ -14,8 +14,9 @@ lua:
description: "Check if a decal is precached."
arguments:
- - name: "decalName"
- type: string
+ - position: 1
+ name: "decalName"
+ type: string
returns:
- type: boolean
description: "True if the decal is precached, false otherwise."
diff --git a/docs/libraries/Engines/IsDedicatedServer.client.md b/docs/libraries/Engines/IsDedicatedServer.client.md
index abb04b60cc..ce24291160 100644
--- a/docs/libraries/Engines/IsDedicatedServer.client.md
+++ b/docs/libraries/Engines/IsDedicatedServer.client.md
@@ -13,6 +13,7 @@ lua:
realm: client
description: "Check if the server is dedicated. Internally this is getting this information from the server_spawn event."
+ arguments:
returns:
- type: boolean
diff --git a/docs/libraries/Engines/IsDedicatedServer.server.md b/docs/libraries/Engines/IsDedicatedServer.server.md
index be9e2bb8d5..53e19734f8 100644
--- a/docs/libraries/Engines/IsDedicatedServer.server.md
+++ b/docs/libraries/Engines/IsDedicatedServer.server.md
@@ -13,6 +13,7 @@ lua:
realm: server
description: "Check if the server is dedicated."
+ arguments:
returns:
- type: boolean
diff --git a/docs/libraries/Engines/IsDrawingLoadingImage.md b/docs/libraries/Engines/IsDrawingLoadingImage.md
index 9ce463ba06..ca813cafdd 100644
--- a/docs/libraries/Engines/IsDrawingLoadingImage.md
+++ b/docs/libraries/Engines/IsDrawingLoadingImage.md
@@ -13,6 +13,7 @@ lua:
realm: client
description: "Check if the client is drawing a loading image."
+ arguments:
returns:
- type: boolean
diff --git a/docs/libraries/Engines/IsGenericPrecached.md b/docs/libraries/Engines/IsGenericPrecached.md
index ec1a15403e..064a19fd4a 100644
--- a/docs/libraries/Engines/IsGenericPrecached.md
+++ b/docs/libraries/Engines/IsGenericPrecached.md
@@ -14,8 +14,9 @@ lua:
description: "Check if a generic is precached."
arguments:
- - name: "genericName"
- type: string
+ - position: 1
+ name: "genericName"
+ type: string
returns:
- type: boolean
description: "True if the generic is precached, false otherwise."
diff --git a/docs/libraries/Engines/IsHLTV.md b/docs/libraries/Engines/IsHLTV.md
index ff0e1029a1..f7b1a3d4c0 100644
--- a/docs/libraries/Engines/IsHLTV.md
+++ b/docs/libraries/Engines/IsHLTV.md
@@ -13,6 +13,7 @@ lua:
realm: client
description: "Check if the client is an HLTV."
+ arguments:
returns:
- type: boolean
diff --git a/docs/libraries/Engines/IsHammerRunning.md b/docs/libraries/Engines/IsHammerRunning.md
index b0c7de2b7f..03cb0dd59c 100644
--- a/docs/libraries/Engines/IsHammerRunning.md
+++ b/docs/libraries/Engines/IsHammerRunning.md
@@ -13,6 +13,7 @@ lua:
realm: client
description: "Check if Hammer is running."
+ arguments:
returns:
- type: boolean
diff --git a/docs/libraries/Engines/IsInCommentaryMode.md b/docs/libraries/Engines/IsInCommentaryMode.md
index afe24ec2ca..76f866857d 100644
--- a/docs/libraries/Engines/IsInCommentaryMode.md
+++ b/docs/libraries/Engines/IsInCommentaryMode.md
@@ -13,6 +13,7 @@ lua:
realm: server
description: "Check if the game is in commentary mode."
+ arguments:
returns:
- type: boolean
diff --git a/docs/libraries/Engines/IsInEditMode.md b/docs/libraries/Engines/IsInEditMode.md
index 9f98b32d2a..e378920bf6 100644
--- a/docs/libraries/Engines/IsInEditMode.md
+++ b/docs/libraries/Engines/IsInEditMode.md
@@ -13,6 +13,7 @@ lua:
realm: shared
description: "Check if the game is in edit mode."
+ arguments:
returns:
- type: boolean
diff --git a/docs/libraries/Engines/IsInGame.md b/docs/libraries/Engines/IsInGame.md
index 1b96ce9742..2ed1b6f105 100644
--- a/docs/libraries/Engines/IsInGame.md
+++ b/docs/libraries/Engines/IsInGame.md
@@ -13,6 +13,7 @@ lua:
realm: client
description: "Check if the client is in a game."
+ arguments:
returns:
- type: boolean
diff --git a/docs/libraries/Engines/IsInternalBuild.md b/docs/libraries/Engines/IsInternalBuild.md
index a0b8f01b2a..b47d9509e6 100644
--- a/docs/libraries/Engines/IsInternalBuild.md
+++ b/docs/libraries/Engines/IsInternalBuild.md
@@ -13,6 +13,7 @@ lua:
realm: server
description: "Check if the build is internal."
+ arguments:
returns:
- type: boolean
diff --git a/docs/libraries/Engines/IsKeyTrapping.md b/docs/libraries/Engines/IsKeyTrapping.md
index 0b1b77776c..0a84451139 100644
--- a/docs/libraries/Engines/IsKeyTrapping.md
+++ b/docs/libraries/Engines/IsKeyTrapping.md
@@ -13,6 +13,7 @@ lua:
realm: client
description: "Check if a key is being trapped."
+ arguments:
returns:
- type: boolean
diff --git a/docs/libraries/Engines/IsLevelMainMenuBackground.md b/docs/libraries/Engines/IsLevelMainMenuBackground.md
index 185323e199..2356b1dd7f 100644
--- a/docs/libraries/Engines/IsLevelMainMenuBackground.md
+++ b/docs/libraries/Engines/IsLevelMainMenuBackground.md
@@ -13,6 +13,7 @@ lua:
realm: client
description: "Check if the level is a main menu background."
+ arguments:
returns:
- type: boolean
diff --git a/docs/libraries/Engines/IsLowViolence.md b/docs/libraries/Engines/IsLowViolence.md
index 48c24c296d..b4edf19d55 100644
--- a/docs/libraries/Engines/IsLowViolence.md
+++ b/docs/libraries/Engines/IsLowViolence.md
@@ -13,6 +13,7 @@ lua:
realm: shared
description: "Check if the game is low violence."
+ arguments:
returns:
- type: boolean
diff --git a/docs/libraries/Engines/IsMapValid.md b/docs/libraries/Engines/IsMapValid.md
index 5fbceeb7b0..655e8d0afc 100644
--- a/docs/libraries/Engines/IsMapValid.md
+++ b/docs/libraries/Engines/IsMapValid.md
@@ -14,8 +14,9 @@ lua:
description: "Check if a map is valid."
arguments:
- - name: "mapName"
- type: string
+ - position: 1
+ name: "mapName"
+ type: string
returns:
- type: integer
description: "True if the map is valid, false otherwise."
diff --git a/docs/libraries/Engines/IsModelPrecached.md b/docs/libraries/Engines/IsModelPrecached.md
index 34a31eeb31..b28547cddf 100644
--- a/docs/libraries/Engines/IsModelPrecached.md
+++ b/docs/libraries/Engines/IsModelPrecached.md
@@ -14,8 +14,9 @@ lua:
description: "Check if a model is precached."
arguments:
- - name: "modelName"
- type: string
+ - position: 1
+ name: "modelName"
+ type: string
returns:
- type: boolean
description: "True if the model is precached, false otherwise."
diff --git a/docs/libraries/Engines/IsOccluded.md b/docs/libraries/Engines/IsOccluded.md
index 8eba9f736a..f4f9d30dce 100644
--- a/docs/libraries/Engines/IsOccluded.md
+++ b/docs/libraries/Engines/IsOccluded.md
@@ -14,10 +14,12 @@ lua:
description: "Check if a box is occluded."
arguments:
- - name: "boxMin"
- type: Vector
- - name: "boxMax"
- type: Vector
+ - position: 1
+ name: "boxMin"
+ type: Vector
+ - position: 2
+ name: "boxMax"
+ type: Vector
returns:
- type: boolean
description: "True if the box is occluded, false otherwise."
diff --git a/docs/libraries/Engines/IsPaused.md b/docs/libraries/Engines/IsPaused.md
index 9a8f179b51..8c6530921b 100644
--- a/docs/libraries/Engines/IsPaused.md
+++ b/docs/libraries/Engines/IsPaused.md
@@ -13,6 +13,7 @@ lua:
realm: shared
description: "Check if the game is paused."
+ arguments:
returns:
- type: boolean
diff --git a/docs/libraries/Engines/IsPlayingDemo.md b/docs/libraries/Engines/IsPlayingDemo.md
index d3d312ff42..e91ee7e2ce 100644
--- a/docs/libraries/Engines/IsPlayingDemo.md
+++ b/docs/libraries/Engines/IsPlayingDemo.md
@@ -13,6 +13,7 @@ lua:
realm: client
description: "Check if the client is playing a demo."
+ arguments:
returns:
- type: boolean
diff --git a/docs/libraries/Engines/IsPlayingTimeDemo.md b/docs/libraries/Engines/IsPlayingTimeDemo.md
index e80f8d79e0..9bb5e0947a 100644
--- a/docs/libraries/Engines/IsPlayingTimeDemo.md
+++ b/docs/libraries/Engines/IsPlayingTimeDemo.md
@@ -13,6 +13,7 @@ lua:
realm: client
description: "Check if the client is playing a time demo."
+ arguments:
returns:
- type: boolean
diff --git a/docs/libraries/Engines/IsRecordingDemo.md b/docs/libraries/Engines/IsRecordingDemo.md
index 90f2d85afe..37e5dc7b41 100644
--- a/docs/libraries/Engines/IsRecordingDemo.md
+++ b/docs/libraries/Engines/IsRecordingDemo.md
@@ -13,6 +13,7 @@ lua:
realm: client
description: "Check if the client is recording a demo."
+ arguments:
returns:
- type: boolean
diff --git a/docs/libraries/Engines/IsSaveInProgress.md b/docs/libraries/Engines/IsSaveInProgress.md
index 3612acd9db..2a81431b00 100644
--- a/docs/libraries/Engines/IsSaveInProgress.md
+++ b/docs/libraries/Engines/IsSaveInProgress.md
@@ -13,6 +13,7 @@ lua:
realm: client
description: "Check if a save is in progress."
+ arguments:
returns:
- type: boolean
diff --git a/docs/libraries/Engines/IsSkyboxVisibleFromPoint.md b/docs/libraries/Engines/IsSkyboxVisibleFromPoint.md
index b9c1adbca1..389be73831 100644
--- a/docs/libraries/Engines/IsSkyboxVisibleFromPoint.md
+++ b/docs/libraries/Engines/IsSkyboxVisibleFromPoint.md
@@ -14,8 +14,9 @@ lua:
description: "Check if the skybox is visible from a point."
arguments:
- - name: "point"
- type: Vector
+ - position: 1
+ name: "point"
+ type: Vector
returns:
- type: enumeration/SKYBOX_VISIBILITY
description: "The skybox visibility."
diff --git a/docs/libraries/Engines/IsTakingScreenshot.md b/docs/libraries/Engines/IsTakingScreenshot.md
index a66edef47a..cc0f708048 100644
--- a/docs/libraries/Engines/IsTakingScreenshot.md
+++ b/docs/libraries/Engines/IsTakingScreenshot.md
@@ -13,6 +13,7 @@ lua:
realm: client
description: "Check if a screenshot is being taken."
+ arguments:
returns:
- type: boolean
diff --git a/docs/libraries/Engines/LevelLeafCount.md b/docs/libraries/Engines/LevelLeafCount.md
index 4e02b1e35f..82d39acf76 100644
--- a/docs/libraries/Engines/LevelLeafCount.md
+++ b/docs/libraries/Engines/LevelLeafCount.md
@@ -13,6 +13,7 @@ lua:
realm: client
description: "Get the level leaf count."
+ arguments:
returns:
- type: integer
diff --git a/docs/libraries/Engines/LightStyle.md b/docs/libraries/Engines/LightStyle.md
index 6963b3d763..f7d640f1c7 100644
--- a/docs/libraries/Engines/LightStyle.md
+++ b/docs/libraries/Engines/LightStyle.md
@@ -14,10 +14,12 @@ lua:
description: "Set a light style."
arguments:
- - name: "styleIndex"
- type: number
- - name: "styleValue"
- type: string
+ - position: 1
+ name: "styleIndex"
+ type: number
+ - position: 2
+ name: "styleValue"
+ type: string
returns:
---
diff --git a/docs/libraries/Engines/LightStyleValue.md b/docs/libraries/Engines/LightStyleValue.md
index 8fee06fe37..86c5e15df7 100644
--- a/docs/libraries/Engines/LightStyleValue.md
+++ b/docs/libraries/Engines/LightStyleValue.md
@@ -13,6 +13,7 @@ lua:
realm: client
description: "Get the light style value."
+ arguments:
returns:
- type: number
diff --git a/docs/libraries/Engines/LinearToGamma.md b/docs/libraries/Engines/LinearToGamma.md
index ab0089261f..77bca61a7e 100644
--- a/docs/libraries/Engines/LinearToGamma.md
+++ b/docs/libraries/Engines/LinearToGamma.md
@@ -14,8 +14,9 @@ lua:
description: "Convert a linear value to a gamma value."
arguments:
- - name: "linear"
- type: number
+ - position: 1
+ name: "linear"
+ type: number
returns:
- type: number
description: "The gamma value."
diff --git a/docs/libraries/Engines/LoadAdjacentEnts.md b/docs/libraries/Engines/LoadAdjacentEnts.md
index b8f9913e1a..3c4dc54ee8 100644
--- a/docs/libraries/Engines/LoadAdjacentEnts.md
+++ b/docs/libraries/Engines/LoadAdjacentEnts.md
@@ -14,10 +14,12 @@ lua:
description: "Load adjacent entities."
arguments:
- - name: "mapName"
- type: string
- - name: "baseMapName"
- type: string
+ - position: 1
+ name: "mapName"
+ type: string
+ - position: 2
+ name: "baseMapName"
+ type: string
returns:
---
diff --git a/docs/libraries/Engines/LoadGameState.md b/docs/libraries/Engines/LoadGameState.md
index 0745e8e7aa..2024231403 100644
--- a/docs/libraries/Engines/LoadGameState.md
+++ b/docs/libraries/Engines/LoadGameState.md
@@ -14,11 +14,13 @@ lua:
description: "Load the game state."
arguments:
- - name: "fileName"
- type: string
- - name: "isDemo"
- type: boolean
- default: "false"
+ - position: 1
+ name: "fileName"
+ type: string
+ - position: 2
+ name: "isDemo"
+ type: boolean
+ default: "false"
returns:
- type: boolean
description: "True if the game state was loaded, false otherwise."
diff --git a/docs/libraries/Engines/LockNetworkStringTables.md b/docs/libraries/Engines/LockNetworkStringTables.md
index 2071756944..83587ef834 100644
--- a/docs/libraries/Engines/LockNetworkStringTables.md
+++ b/docs/libraries/Engines/LockNetworkStringTables.md
@@ -14,8 +14,9 @@ lua:
description: "Lock the network string tables."
arguments:
- - name: "lock"
- type: boolean
+ - position: 1
+ name: "lock"
+ type: boolean
returns:
- type: boolean
description: "True if the network string tables were locked, false otherwise."
diff --git a/docs/libraries/Engines/LogPrint.md b/docs/libraries/Engines/LogPrint.md
index 2bc129352b..1b4c13cbbf 100644
--- a/docs/libraries/Engines/LogPrint.md
+++ b/docs/libraries/Engines/LogPrint.md
@@ -14,8 +14,9 @@ lua:
description: "Print a message to the log."
arguments:
- - name: "message"
- type: string
+ - position: 1
+ name: "message"
+ type: string
returns:
---
diff --git a/docs/libraries/Engines/MapHasHdrLighting.md b/docs/libraries/Engines/MapHasHdrLighting.md
index 53fc96d4fd..6f84041fb7 100644
--- a/docs/libraries/Engines/MapHasHdrLighting.md
+++ b/docs/libraries/Engines/MapHasHdrLighting.md
@@ -13,6 +13,7 @@ lua:
realm: client
description: "Check if the map has HDR lighting."
+ arguments:
returns:
- type: boolean
diff --git a/docs/libraries/Engines/MapLoadFailed.md b/docs/libraries/Engines/MapLoadFailed.md
index 67ab84eb3c..ed6d26c240 100644
--- a/docs/libraries/Engines/MapLoadFailed.md
+++ b/docs/libraries/Engines/MapLoadFailed.md
@@ -13,6 +13,7 @@ lua:
realm: client
description: "Check if the map load failed."
+ arguments:
returns:
- type: boolean
diff --git a/docs/libraries/Engines/MultiplayerEndGame.md b/docs/libraries/Engines/MultiplayerEndGame.md
index e6f5ee15bd..cffeee30b4 100644
--- a/docs/libraries/Engines/MultiplayerEndGame.md
+++ b/docs/libraries/Engines/MultiplayerEndGame.md
@@ -13,6 +13,7 @@ lua:
realm: server
description: "End the multiplayer game."
+ arguments:
returns:
diff --git a/docs/libraries/Engines/NotifyEdictFlagsChange.md b/docs/libraries/Engines/NotifyEdictFlagsChange.md
index 0802e0741b..842369e22e 100644
--- a/docs/libraries/Engines/NotifyEdictFlagsChange.md
+++ b/docs/libraries/Engines/NotifyEdictFlagsChange.md
@@ -14,8 +14,9 @@ lua:
description: "Notify of an edict flags change."
arguments:
- - name: "flags"
- type: number
+ - position: 1
+ name: "flags"
+ type: number
returns:
---
diff --git a/docs/libraries/Engines/OnStorageDeviceDetached.md b/docs/libraries/Engines/OnStorageDeviceDetached.md
index 5a5188c751..2fbc54ad49 100644
--- a/docs/libraries/Engines/OnStorageDeviceDetached.md
+++ b/docs/libraries/Engines/OnStorageDeviceDetached.md
@@ -13,6 +13,7 @@ lua:
realm: client
description: "Handle a storage device detachment."
+ arguments:
returns:
diff --git a/docs/libraries/Engines/PrecacheDecal.md b/docs/libraries/Engines/PrecacheDecal.md
index 644df5ae97..3cce49c8da 100644
--- a/docs/libraries/Engines/PrecacheDecal.md
+++ b/docs/libraries/Engines/PrecacheDecal.md
@@ -14,11 +14,13 @@ lua:
description: "Precache a decal."
arguments:
- - name: "decalName"
- type: string
- - name: "preload"
- type: boolean
- default: "false"
+ - position: 1
+ name: "decalName"
+ type: string
+ - position: 2
+ name: "preload"
+ type: boolean
+ default: "false"
returns:
- type: integer
description: "The decal index."
diff --git a/docs/libraries/Engines/PrecacheGeneric.md b/docs/libraries/Engines/PrecacheGeneric.md
index a279d06d62..4d99b0a168 100644
--- a/docs/libraries/Engines/PrecacheGeneric.md
+++ b/docs/libraries/Engines/PrecacheGeneric.md
@@ -14,11 +14,13 @@ lua:
description: "Precache a generic."
arguments:
- - name: "genericName"
- type: string
- - name: "preload"
- type: boolean
- default: "false"
+ - position: 1
+ name: "genericName"
+ type: string
+ - position: 2
+ name: "preload"
+ type: boolean
+ default: "false"
returns:
- type: integer
description: "The generic index."
diff --git a/docs/libraries/Engines/PrecacheModel.md b/docs/libraries/Engines/PrecacheModel.md
index 0b5aea82a5..fdc1176d1b 100644
--- a/docs/libraries/Engines/PrecacheModel.md
+++ b/docs/libraries/Engines/PrecacheModel.md
@@ -14,11 +14,13 @@ lua:
description: "Precache a model."
arguments:
- - name: "modelName"
- type: string
- - name: "preload"
- type: boolean
- default: "false"
+ - position: 1
+ name: "modelName"
+ type: string
+ - position: 2
+ name: "preload"
+ type: boolean
+ default: "false"
returns:
- type: integer
description: "The model index."
diff --git a/docs/libraries/Engines/PrecacheSentenceFile.md b/docs/libraries/Engines/PrecacheSentenceFile.md
index 41ced1e1db..1b0234d9bc 100644
--- a/docs/libraries/Engines/PrecacheSentenceFile.md
+++ b/docs/libraries/Engines/PrecacheSentenceFile.md
@@ -14,11 +14,13 @@ lua:
description: "Precache a sentence file."
arguments:
- - name: "sentenceFileName"
- type: string
- - name: "preload"
- type: boolean
- default: "false"
+ - position: 1
+ name: "sentenceFileName"
+ type: string
+ - position: 2
+ name: "preload"
+ type: boolean
+ default: "false"
returns:
- type: integer
description: "The sentence file index."
diff --git a/docs/libraries/Engines/ResetDemoInterpolation.md b/docs/libraries/Engines/ResetDemoInterpolation.md
index 7d71f04899..b6a34984d3 100644
--- a/docs/libraries/Engines/ResetDemoInterpolation.md
+++ b/docs/libraries/Engines/ResetDemoInterpolation.md
@@ -13,6 +13,7 @@ lua:
realm: client
description: "Reset demo interpolation."
+ arguments:
returns:
diff --git a/docs/libraries/Engines/SentenceGroupIndexFromName.md b/docs/libraries/Engines/SentenceGroupIndexFromName.md
index 9ea2eeb0ac..067847afcb 100644
--- a/docs/libraries/Engines/SentenceGroupIndexFromName.md
+++ b/docs/libraries/Engines/SentenceGroupIndexFromName.md
@@ -14,8 +14,9 @@ lua:
description: "Get the sentence group index from a name."
arguments:
- - name: "groupName"
- type: string
+ - position: 1
+ name: "groupName"
+ type: string
returns:
- type: integer
description: "The sentence group index."
diff --git a/docs/libraries/Engines/SentenceGroupNameFromIndex.md b/docs/libraries/Engines/SentenceGroupNameFromIndex.md
index 62cb1ac457..aee0ba4f52 100644
--- a/docs/libraries/Engines/SentenceGroupNameFromIndex.md
+++ b/docs/libraries/Engines/SentenceGroupNameFromIndex.md
@@ -14,8 +14,9 @@ lua:
description: "Get the sentence group name from an index."
arguments:
- - name: "index"
- type: number
+ - position: 1
+ name: "index"
+ type: number
returns:
- type: string
description: "The sentence group name."
diff --git a/docs/libraries/Engines/SentenceIndexFromName.md b/docs/libraries/Engines/SentenceIndexFromName.md
index 1c867aa7ff..8e27e10b65 100644
--- a/docs/libraries/Engines/SentenceIndexFromName.md
+++ b/docs/libraries/Engines/SentenceIndexFromName.md
@@ -14,8 +14,9 @@ lua:
description: "Get the sentence index from a name."
arguments:
- - name: "sentenceName"
- type: string
+ - position: 1
+ name: "sentenceName"
+ type: string
returns:
- type: integer
description: "The sentence index."
diff --git a/docs/libraries/Engines/SentenceLength.md b/docs/libraries/Engines/SentenceLength.md
index 777e5f3816..d805a1dc27 100644
--- a/docs/libraries/Engines/SentenceLength.md
+++ b/docs/libraries/Engines/SentenceLength.md
@@ -14,8 +14,9 @@ lua:
description: "Get the sentence length."
arguments:
- - name: "index"
- type: number
+ - position: 1
+ name: "index"
+ type: number
returns:
- type: number
description: "The sentence length."
diff --git a/docs/libraries/Engines/SentenceNameFromIndex.md b/docs/libraries/Engines/SentenceNameFromIndex.md
index 0853f3020a..1560da34fe 100644
--- a/docs/libraries/Engines/SentenceNameFromIndex.md
+++ b/docs/libraries/Engines/SentenceNameFromIndex.md
@@ -14,8 +14,9 @@ lua:
description: "Get the sentence name from an index."
arguments:
- - name: "index"
- type: number
+ - position: 1
+ name: "index"
+ type: number
returns:
- type: string
description: "The sentence name."
diff --git a/docs/libraries/Engines/ServerCommand.client.md b/docs/libraries/Engines/ServerCommand.client.md
index bfdf3200a3..3395336e2c 100644
--- a/docs/libraries/Engines/ServerCommand.client.md
+++ b/docs/libraries/Engines/ServerCommand.client.md
@@ -14,11 +14,13 @@ lua:
description: "Send a command to the server."
arguments:
- - name: "command"
- type: string
- - name: "reliable"
- type: boolean
- default: "true"
+ - position: 1
+ name: "command"
+ type: string
+ - position: 2
+ name: "reliable"
+ type: boolean
+ default: "true"
returns:
---
diff --git a/docs/libraries/Engines/ServerCommand.server.md b/docs/libraries/Engines/ServerCommand.server.md
index 03b06348b5..f0104d3f40 100644
--- a/docs/libraries/Engines/ServerCommand.server.md
+++ b/docs/libraries/Engines/ServerCommand.server.md
@@ -14,8 +14,9 @@ lua:
description: "Run a server command."
arguments:
- - name: "command"
- type: string
+ - position: 1
+ name: "command"
+ type: string
returns:
---
diff --git a/docs/libraries/Engines/ServerExecute.md b/docs/libraries/Engines/ServerExecute.md
index 225423d55b..e544d373c7 100644
--- a/docs/libraries/Engines/ServerExecute.md
+++ b/docs/libraries/Engines/ServerExecute.md
@@ -13,6 +13,7 @@ lua:
realm: server
description: "Execute the server."
+ arguments:
returns:
diff --git a/docs/libraries/Engines/SetAreaPortalState.md b/docs/libraries/Engines/SetAreaPortalState.md
index 2ed2b63519..b78e8d2b47 100644
--- a/docs/libraries/Engines/SetAreaPortalState.md
+++ b/docs/libraries/Engines/SetAreaPortalState.md
@@ -14,10 +14,12 @@ lua:
description: "Set the area portal state."
arguments:
- - name: "portalIndex"
- type: number
- - name: "isOpen"
- type: number
+ - position: 1
+ name: "portalIndex"
+ type: number
+ - position: 2
+ name: "isOpen"
+ type: number
returns:
---
diff --git a/docs/libraries/Engines/SetDedicatedServerBenchmarkMode.md b/docs/libraries/Engines/SetDedicatedServerBenchmarkMode.md
index f3db4fc2b0..7a4bd0dc64 100644
--- a/docs/libraries/Engines/SetDedicatedServerBenchmarkMode.md
+++ b/docs/libraries/Engines/SetDedicatedServerBenchmarkMode.md
@@ -14,8 +14,9 @@ lua:
description: "Set the dedicated server benchmark mode."
arguments:
- - name: "enabled"
- type: boolean
+ - position: 1
+ name: "enabled"
+ type: boolean
returns:
---
diff --git a/docs/libraries/Engines/SetMapLoadFailed.md b/docs/libraries/Engines/SetMapLoadFailed.md
index 3675c2860c..f3cd3d20d9 100644
--- a/docs/libraries/Engines/SetMapLoadFailed.md
+++ b/docs/libraries/Engines/SetMapLoadFailed.md
@@ -14,8 +14,9 @@ lua:
description: "Set the map load failed state."
arguments:
- - name: "failed"
- type: boolean
+ - position: 1
+ name: "failed"
+ type: boolean
returns:
---
diff --git a/docs/libraries/Engines/SetRestrictClientCommands.md b/docs/libraries/Engines/SetRestrictClientCommands.md
index fc52eed254..dcf8c72c8b 100644
--- a/docs/libraries/Engines/SetRestrictClientCommands.md
+++ b/docs/libraries/Engines/SetRestrictClientCommands.md
@@ -14,8 +14,9 @@ lua:
description: "Set the restrict client commands state."
arguments:
- - name: "restrict"
- type: boolean
+ - position: 1
+ name: "restrict"
+ type: boolean
returns:
---
diff --git a/docs/libraries/Engines/SetRestrictServerCommands.md b/docs/libraries/Engines/SetRestrictServerCommands.md
index f74332d5e8..519a9a6a54 100644
--- a/docs/libraries/Engines/SetRestrictServerCommands.md
+++ b/docs/libraries/Engines/SetRestrictServerCommands.md
@@ -14,8 +14,9 @@ lua:
description: "Set the restrict server commands state."
arguments:
- - name: "restrict"
- type: boolean
+ - position: 1
+ name: "restrict"
+ type: boolean
returns:
---
diff --git a/docs/libraries/Engines/SoundExtraUpdate.md b/docs/libraries/Engines/SoundExtraUpdate.md
index 37dd452704..cfdcfa40f3 100644
--- a/docs/libraries/Engines/SoundExtraUpdate.md
+++ b/docs/libraries/Engines/SoundExtraUpdate.md
@@ -13,6 +13,7 @@ lua:
realm: client
description: "Update sound."
+ arguments:
returns:
diff --git a/docs/libraries/Engines/StartKeyTrapMode.md b/docs/libraries/Engines/StartKeyTrapMode.md
index 616e6ce03c..08e3f3f565 100644
--- a/docs/libraries/Engines/StartKeyTrapMode.md
+++ b/docs/libraries/Engines/StartKeyTrapMode.md
@@ -13,6 +13,7 @@ lua:
realm: client
description: "Start trapping a key."
+ arguments:
returns:
diff --git a/docs/libraries/Engines/SupportsHdr.md b/docs/libraries/Engines/SupportsHdr.md
index 13266fffa3..26aeb89499 100644
--- a/docs/libraries/Engines/SupportsHdr.md
+++ b/docs/libraries/Engines/SupportsHdr.md
@@ -13,6 +13,7 @@ lua:
realm: client
description: "Check if HDR is supported."
+ arguments:
returns:
- type: boolean
diff --git a/docs/libraries/Engines/Time.md b/docs/libraries/Engines/Time.md
index e5dfb04a4d..c5d3586b3c 100644
--- a/docs/libraries/Engines/Time.md
+++ b/docs/libraries/Engines/Time.md
@@ -13,6 +13,7 @@ lua:
realm: shared
description: "Get the current time."
+ arguments:
returns:
- type: number
diff --git a/docs/libraries/Entities/CanCreateEntityClass.md b/docs/libraries/Entities/CanCreateEntityClass.md
index 037b6bc2e4..1dc05c2bf7 100644
--- a/docs/libraries/Entities/CanCreateEntityClass.md
+++ b/docs/libraries/Entities/CanCreateEntityClass.md
@@ -14,8 +14,9 @@ lua:
description: "Checks if an entity class can be created"
arguments:
- - name: "className"
- type: string
+ - position: 1
+ name: "className"
+ type: string
returns:
- type: boolean
description: "True if the entity class can be created, false otherwise."
diff --git a/docs/libraries/Entities/CleanDeleteList.md b/docs/libraries/Entities/CleanDeleteList.md
index a9044fad2f..6197b9990c 100644
--- a/docs/libraries/Entities/CleanDeleteList.md
+++ b/docs/libraries/Entities/CleanDeleteList.md
@@ -13,6 +13,7 @@ lua:
realm: server
description: "Cleans up the delete list."
+ arguments:
returns:
diff --git a/docs/libraries/Entities/Clear.md b/docs/libraries/Entities/Clear.md
index 947e5cc8b1..221113d2ca 100644
--- a/docs/libraries/Entities/Clear.md
+++ b/docs/libraries/Entities/Clear.md
@@ -13,6 +13,7 @@ lua:
realm: server
description: "Clears the entity list."
+ arguments:
returns:
diff --git a/docs/libraries/Entities/CreateByName.md b/docs/libraries/Entities/CreateByName.md
index 181f8e3b90..c90b4db65c 100644
--- a/docs/libraries/Entities/CreateByName.md
+++ b/docs/libraries/Entities/CreateByName.md
@@ -14,8 +14,9 @@ lua:
description: "Creates an entity by the given class name"
arguments:
- - name: "className"
- type: string
+ - position: 1
+ name: "className"
+ type: string
returns:
- type: Entity
description: "The created entity"
diff --git a/docs/libraries/Entities/CreateClientEntity.md b/docs/libraries/Entities/CreateClientEntity.md
index aa3964b735..3a39faf5c5 100644
--- a/docs/libraries/Entities/CreateClientEntity.md
+++ b/docs/libraries/Entities/CreateClientEntity.md
@@ -14,11 +14,13 @@ lua:
description: "Create a clientside entity with the specified model."
arguments:
- - name: "model"
- type: string
- - name: "renderGroup"
- type: number
- default: "RENDER_GROUP_OTHER"
+ - position: 1
+ name: "model"
+ type: string
+ - position: 2
+ name: "renderGroup"
+ type: number
+ default: "RENDER_GROUP_OTHER"
returns:
- type: Entity
description: "Clientside model entity."
diff --git a/docs/libraries/Entities/DisableRemoveImmediate.md b/docs/libraries/Entities/DisableRemoveImmediate.md
index 477ceeddc0..204e9ba0b8 100644
--- a/docs/libraries/Entities/DisableRemoveImmediate.md
+++ b/docs/libraries/Entities/DisableRemoveImmediate.md
@@ -13,6 +13,7 @@ lua:
realm: server
description: "Disables immediate removal of entities"
+ arguments:
returns:
diff --git a/docs/libraries/Entities/EnableRemoveImmediate.md b/docs/libraries/Entities/EnableRemoveImmediate.md
index cdb7e2fde4..40ef7d87c2 100644
--- a/docs/libraries/Entities/EnableRemoveImmediate.md
+++ b/docs/libraries/Entities/EnableRemoveImmediate.md
@@ -13,6 +13,7 @@ lua:
realm: server
description: "Enables immediate removal of entities"
+ arguments:
returns:
diff --git a/docs/libraries/Entities/FNullEnt.md b/docs/libraries/Entities/FNullEnt.md
index 429fe5ef83..93ad557200 100644
--- a/docs/libraries/Entities/FNullEnt.md
+++ b/docs/libraries/Entities/FNullEnt.md
@@ -14,8 +14,9 @@ lua:
description: "Checks if an entity is NULL"
arguments:
- - name: "entity"
- type: Entity
+ - position: 1
+ name: "entity"
+ type: Entity
returns:
- type: boolean
description: "True if the entity is NULL, false otherwise."
diff --git a/docs/libraries/Entities/Find.md b/docs/libraries/Entities/Find.md
index 3dd6d390d3..b75eab55a1 100644
--- a/docs/libraries/Entities/Find.md
+++ b/docs/libraries/Entities/Find.md
@@ -14,8 +14,9 @@ lua:
description: "Finds the entity by its entity index"
arguments:
- - name: "entityIndex"
- type: number
+ - position: 1
+ name: "entityIndex"
+ type: number
returns:
- type: Entity
description: "The found entity or NULL entity"
diff --git a/docs/libraries/Entities/FindByClass.md b/docs/libraries/Entities/FindByClass.md
index 0786595370..cf1a761400 100644
--- a/docs/libraries/Entities/FindByClass.md
+++ b/docs/libraries/Entities/FindByClass.md
@@ -14,11 +14,13 @@ lua:
description: "Finds an entity by its class name"
arguments:
- - name: "className"
- type: string
- - name: "startEntity"
- type: Entity
- default: "NULL"
+ - position: 1
+ name: "className"
+ type: string
+ - position: 2
+ name: "startEntity"
+ type: Entity
+ default: "NULL"
returns:
- type: Entity
description: "The entity found, or NULL if not found."
diff --git a/docs/libraries/Entities/FindByClassNearest.md b/docs/libraries/Entities/FindByClassNearest.md
index e964ffa474..74d9f95bd0 100644
--- a/docs/libraries/Entities/FindByClassNearest.md
+++ b/docs/libraries/Entities/FindByClassNearest.md
@@ -14,12 +14,15 @@ lua:
description: "Finds the nearest entity by its class name"
arguments:
- - name: "className"
- type: string
- - name: "position"
- type: Vector
- - name: "maxDistance"
- type: number
+ - position: 1
+ name: "className"
+ type: string
+ - position: 2
+ name: "position"
+ type: Vector
+ - position: 3
+ name: "maxDistance"
+ type: number
returns:
- type: Entity
description: "The entity found, or NULL if not found."
diff --git a/docs/libraries/Entities/FindByClassWithin.md b/docs/libraries/Entities/FindByClassWithin.md
index bc8ee077ff..213b6d86db 100644
--- a/docs/libraries/Entities/FindByClassWithin.md
+++ b/docs/libraries/Entities/FindByClassWithin.md
@@ -14,15 +14,19 @@ lua:
description: "Finds an entity by its class name within a radius"
arguments:
- - name: "className"
- type: string
- - name: "position"
- type: Vector
- - name: "maxDistance"
- type: number
- - name: "startEntity"
- type: Entity
- default: "NULL"
+ - position: 1
+ name: "className"
+ type: string
+ - position: 2
+ name: "position"
+ type: Vector
+ - position: 3
+ name: "maxDistance"
+ type: number
+ - position: 4
+ name: "startEntity"
+ type: Entity
+ default: "NULL"
returns:
- type: Entity
description: "The entity found, or NULL if not found."
diff --git a/docs/libraries/Entities/FindByEdictNumber.md b/docs/libraries/Entities/FindByEdictNumber.md
index 730e26327e..03244beb59 100644
--- a/docs/libraries/Entities/FindByEdictNumber.md
+++ b/docs/libraries/Entities/FindByEdictNumber.md
@@ -14,8 +14,9 @@ lua:
description: "Gets an entity by its edict number"
arguments:
- - name: "edictNumber"
- type: number
+ - position: 1
+ name: "edictNumber"
+ type: number
returns:
- type: Entity
description: "The entity found, or NULL if not found."
diff --git a/docs/libraries/Entities/FindByIndex.md b/docs/libraries/Entities/FindByIndex.md
index dc2c59ecef..053464ce48 100644
--- a/docs/libraries/Entities/FindByIndex.md
+++ b/docs/libraries/Entities/FindByIndex.md
@@ -14,8 +14,9 @@ lua:
description: "Gets an entity by its index. Might be the same as FindByEdictNumber?"
arguments:
- - name: "index"
- type: number
+ - position: 1
+ name: "index"
+ type: number
returns:
- type: Entity
description: "The entity found, or NULL if not found."
diff --git a/docs/libraries/Entities/FindByModel.md b/docs/libraries/Entities/FindByModel.md
index e436ad467a..0e85ef2be4 100644
--- a/docs/libraries/Entities/FindByModel.md
+++ b/docs/libraries/Entities/FindByModel.md
@@ -14,11 +14,13 @@ lua:
description: "Finds an entity by its model name"
arguments:
- - name: "modelName"
- type: string
- - name: "startEntity"
- type: Entity
- default: "NULL"
+ - position: 1
+ name: "modelName"
+ type: string
+ - position: 2
+ name: "startEntity"
+ type: Entity
+ default: "NULL"
returns:
- type: Entity
description: "The entity found, or NULL if not found."
diff --git a/docs/libraries/Entities/FindByName.md b/docs/libraries/Entities/FindByName.md
index bbcefd8735..f406e1cf47 100644
--- a/docs/libraries/Entities/FindByName.md
+++ b/docs/libraries/Entities/FindByName.md
@@ -14,11 +14,13 @@ lua:
description: "Finds an entity by its name"
arguments:
- - name: "name"
- type: string
- - name: "startEntity"
- type: Entity
- default: "NULL"
+ - position: 1
+ name: "name"
+ type: string
+ - position: 2
+ name: "startEntity"
+ type: Entity
+ default: "NULL"
returns:
- type: Entity
description: "The entity found, or NULL if not found."
diff --git a/docs/libraries/Entities/FindByNameNearest.md b/docs/libraries/Entities/FindByNameNearest.md
index 7ea25b80c8..e0f2e8854b 100644
--- a/docs/libraries/Entities/FindByNameNearest.md
+++ b/docs/libraries/Entities/FindByNameNearest.md
@@ -14,12 +14,15 @@ lua:
description: "Finds the nearest entity by its name"
arguments:
- - name: "name"
- type: string
- - name: "position"
- type: Vector
- - name: "maxDistance"
- type: number
+ - position: 1
+ name: "name"
+ type: string
+ - position: 2
+ name: "position"
+ type: Vector
+ - position: 3
+ name: "maxDistance"
+ type: number
returns:
- type: Entity
description: "The entity found, or NULL if not found."
diff --git a/docs/libraries/Entities/FindByNameWithin.md b/docs/libraries/Entities/FindByNameWithin.md
index 8d973a7628..7a4f027832 100644
--- a/docs/libraries/Entities/FindByNameWithin.md
+++ b/docs/libraries/Entities/FindByNameWithin.md
@@ -14,15 +14,19 @@ lua:
description: "Finds an entity by its name within a radius"
arguments:
- - name: "name"
- type: string
- - name: "position"
- type: Vector
- - name: "maxDistance"
- type: number
- - name: "startEntity"
- type: Entity
- default: "NULL"
+ - position: 1
+ name: "name"
+ type: string
+ - position: 2
+ name: "position"
+ type: Vector
+ - position: 3
+ name: "maxDistance"
+ type: number
+ - position: 4
+ name: "startEntity"
+ type: Entity
+ default: "NULL"
returns:
- type: Entity
description: "The entity found, or NULL if not found."
diff --git a/docs/libraries/Entities/FindByTarget.md b/docs/libraries/Entities/FindByTarget.md
index a96cbbce24..e3eef1090a 100644
--- a/docs/libraries/Entities/FindByTarget.md
+++ b/docs/libraries/Entities/FindByTarget.md
@@ -14,11 +14,13 @@ lua:
description: "Finds an entity by its target name"
arguments:
- - name: "target"
- type: string
- - name: "startEntity"
- type: Entity
- default: "NULL"
+ - position: 1
+ name: "target"
+ type: string
+ - position: 2
+ name: "startEntity"
+ type: Entity
+ default: "NULL"
returns:
- type: Entity
description: "The entity found, or NULL if not found."
diff --git a/docs/libraries/Entities/FindClassNearestFacing.md b/docs/libraries/Entities/FindClassNearestFacing.md
index 88f34c3533..61951f1d33 100644
--- a/docs/libraries/Entities/FindClassNearestFacing.md
+++ b/docs/libraries/Entities/FindClassNearestFacing.md
@@ -14,14 +14,18 @@ lua:
description: "Finds the nearest entity of a class facing a direction"
arguments:
- - name: "position"
- type: Vector
- - name: "direction"
- type: Vector
- - name: "maxDistance"
- type: number
- - name: "className"
- type: string
+ - position: 1
+ name: "position"
+ type: Vector
+ - position: 2
+ name: "direction"
+ type: Vector
+ - position: 3
+ name: "maxDistance"
+ type: number
+ - position: 4
+ name: "className"
+ type: string
returns:
- type: Entity
description: "The entity found, or NULL if not found."
diff --git a/docs/libraries/Entities/FindClientInPvs.md b/docs/libraries/Entities/FindClientInPvs.md
index 190c3c237d..1a31bc2d3b 100644
--- a/docs/libraries/Entities/FindClientInPvs.md
+++ b/docs/libraries/Entities/FindClientInPvs.md
@@ -14,10 +14,12 @@ lua:
description: "Finds a client in the PVS"
arguments:
- - name: "minimumVector"
- type: Vector
- - name: "maximumVector"
- type: Vector
+ - position: 1
+ name: "minimumVector"
+ type: Vector
+ - position: 2
+ name: "maximumVector"
+ type: Vector
returns:
- type: Entity
description: "The entity found, or NULL if not found."
diff --git a/docs/libraries/Entities/FindGeneric.md b/docs/libraries/Entities/FindGeneric.md
index 678f2e4928..1f0970426e 100644
--- a/docs/libraries/Entities/FindGeneric.md
+++ b/docs/libraries/Entities/FindGeneric.md
@@ -14,11 +14,13 @@ lua:
description: "Finds an entity by its generic name"
arguments:
- - name: "generic"
- type: string
- - name: "startEntity"
- type: Entity
- default: "NULL"
+ - position: 1
+ name: "generic"
+ type: string
+ - position: 2
+ name: "startEntity"
+ type: Entity
+ default: "NULL"
returns:
- type: Entity
description: "The entity found, or NULL if not found."
diff --git a/docs/libraries/Entities/FindGenericNearest.md b/docs/libraries/Entities/FindGenericNearest.md
index 281d9ec326..8531fa1bda 100644
--- a/docs/libraries/Entities/FindGenericNearest.md
+++ b/docs/libraries/Entities/FindGenericNearest.md
@@ -14,12 +14,15 @@ lua:
description: "Finds the nearest entity by its generic name"
arguments:
- - name: "generic"
- type: string
- - name: "position"
- type: Vector
- - name: "maxDistance"
- type: number
+ - position: 1
+ name: "generic"
+ type: string
+ - position: 2
+ name: "position"
+ type: Vector
+ - position: 3
+ name: "maxDistance"
+ type: number
returns:
- type: Entity
description: "The entity found, or NULL if not found."
diff --git a/docs/libraries/Entities/FindGenericWithin.md b/docs/libraries/Entities/FindGenericWithin.md
index ae662e2d87..6ca8f00f9d 100644
--- a/docs/libraries/Entities/FindGenericWithin.md
+++ b/docs/libraries/Entities/FindGenericWithin.md
@@ -14,15 +14,19 @@ lua:
description: "Finds an entity by its generic name within a radius"
arguments:
- - name: "generic"
- type: string
- - name: "position"
- type: Vector
- - name: "maxDistance"
- type: number
- - name: "startEntity"
- type: Entity
- default: "NULL"
+ - position: 1
+ name: "generic"
+ type: string
+ - position: 2
+ name: "position"
+ type: Vector
+ - position: 3
+ name: "maxDistance"
+ type: number
+ - position: 4
+ name: "startEntity"
+ type: Entity
+ default: "NULL"
returns:
- type: Entity
description: "The entity found, or NULL if not found."
diff --git a/docs/libraries/Entities/FindInSphere.md b/docs/libraries/Entities/FindInSphere.md
index e1520904ed..e7279e7d8b 100644
--- a/docs/libraries/Entities/FindInSphere.md
+++ b/docs/libraries/Entities/FindInSphere.md
@@ -14,13 +14,16 @@ lua:
description: "Finds an entity within a radius"
arguments:
- - name: "position"
- type: Vector
- - name: "radius"
- type: number
- - name: "startEntity"
- type: Entity
- default: "NULL"
+ - position: 1
+ name: "position"
+ type: Vector
+ - position: 2
+ name: "radius"
+ type: number
+ - position: 3
+ name: "startEntity"
+ type: Entity
+ default: "NULL"
returns:
- type: Entity
description: "The entity found, or NULL if not found."
diff --git a/docs/libraries/Entities/FindNearestFacing.md b/docs/libraries/Entities/FindNearestFacing.md
index 607831eff7..e91c351363 100644
--- a/docs/libraries/Entities/FindNearestFacing.md
+++ b/docs/libraries/Entities/FindNearestFacing.md
@@ -14,12 +14,15 @@ lua:
description: "Finds the nearest entity facing a direction"
arguments:
- - name: "position"
- type: Vector
- - name: "direction"
- type: Vector
- - name: "maxDistance"
- type: number
+ - position: 1
+ name: "position"
+ type: Vector
+ - position: 2
+ name: "direction"
+ type: Vector
+ - position: 3
+ name: "maxDistance"
+ type: number
returns:
- type: Entity
description: "The entity found, or NULL if not found."
diff --git a/docs/libraries/Entities/FindProcedural.md b/docs/libraries/Entities/FindProcedural.md
index 0a4146a32b..ef3f10667b 100644
--- a/docs/libraries/Entities/FindProcedural.md
+++ b/docs/libraries/Entities/FindProcedural.md
@@ -14,11 +14,13 @@ lua:
description: "Finds an entity by its procedural name"
arguments:
- - name: "procedural"
- type: string
- - name: "startEntity"
- type: Entity
- default: "NULL"
+ - position: 1
+ name: "procedural"
+ type: string
+ - position: 2
+ name: "startEntity"
+ type: Entity
+ default: "NULL"
returns:
- type: Entity
description: "The entity found, or NULL if not found."
diff --git a/docs/libraries/Entities/FirstInList.md b/docs/libraries/Entities/FirstInList.md
index 07e4f668d6..fbf66c41b2 100644
--- a/docs/libraries/Entities/FirstInList.md
+++ b/docs/libraries/Entities/FirstInList.md
@@ -13,6 +13,7 @@ lua:
realm: shared
description: "Gets the first entity in the list"
+ arguments:
returns:
- type: Entity
diff --git a/docs/libraries/Entities/GetAll.md b/docs/libraries/Entities/GetAll.md
index c6b0f5612c..4578544ce7 100644
--- a/docs/libraries/Entities/GetAll.md
+++ b/docs/libraries/Entities/GetAll.md
@@ -13,6 +13,7 @@ lua:
realm: shared
description: "Gets all entities in the list"
+ arguments:
returns:
- type: table
diff --git a/docs/libraries/Entities/GetAlongRay.md b/docs/libraries/Entities/GetAlongRay.md
index b6a94425d2..85e29b0a5e 100644
--- a/docs/libraries/Entities/GetAlongRay.md
+++ b/docs/libraries/Entities/GetAlongRay.md
@@ -14,14 +14,18 @@ lua:
description: "Finds all entities along the given ray."
arguments:
- - name: "start"
- type: Vector
- - name: "end"
- type: Vector
- - name: "mins"
- type: Vector
- - name: "maxs"
- type: Vector
+ - position: 1
+ name: "start"
+ type: Vector
+ - position: 2
+ name: "end"
+ type: Vector
+ - position: 3
+ name: "mins"
+ type: Vector
+ - position: 4
+ name: "maxs"
+ type: Vector
returns:
- type: table
description: "A table of entities found."
diff --git a/docs/libraries/Entities/GetByClass.md b/docs/libraries/Entities/GetByClass.md
index 00bc4104b8..a9a3142de8 100644
--- a/docs/libraries/Entities/GetByClass.md
+++ b/docs/libraries/Entities/GetByClass.md
@@ -14,8 +14,9 @@ lua:
description: "Gets all entities in the list by their class name"
arguments:
- - name: "className"
- type: string
+ - position: 1
+ name: "className"
+ type: string
returns:
- type: table
description: "A table of all entities in the entity list with the given class name."
diff --git a/docs/libraries/Entities/GetClientPvsIsExpanded.md b/docs/libraries/Entities/GetClientPvsIsExpanded.md
index 91ec9aec32..fd6aa406d3 100644
--- a/docs/libraries/Entities/GetClientPvsIsExpanded.md
+++ b/docs/libraries/Entities/GetClientPvsIsExpanded.md
@@ -13,6 +13,7 @@ lua:
realm: server
description: "Checks if the client PVS is expanded"
+ arguments:
returns:
- type: boolean
diff --git a/docs/libraries/Entities/GetCount.md b/docs/libraries/Entities/GetCount.md
index 2e870c2ba0..d9cd55818d 100644
--- a/docs/libraries/Entities/GetCount.md
+++ b/docs/libraries/Entities/GetCount.md
@@ -13,6 +13,7 @@ lua:
realm: shared
description: "Gets the number of entities in the list"
+ arguments:
returns:
- type: integer
diff --git a/docs/libraries/Entities/GetEdictCount.md b/docs/libraries/Entities/GetEdictCount.md
index 5c6edae567..29d1086b76 100644
--- a/docs/libraries/Entities/GetEdictCount.md
+++ b/docs/libraries/Entities/GetEdictCount.md
@@ -13,6 +13,7 @@ lua:
realm: server
description: "Gets the number of edicts"
+ arguments:
returns:
- type: integer
diff --git a/docs/libraries/Entities/GetInBox.md b/docs/libraries/Entities/GetInBox.md
index 835fbc4011..37797f7cd6 100644
--- a/docs/libraries/Entities/GetInBox.md
+++ b/docs/libraries/Entities/GetInBox.md
@@ -14,16 +14,20 @@ lua:
description: "Finds all entities in the given box. Note that clientPartitionMask is only available on the client."
arguments:
- - name: "mins"
- type: Vector
- - name: "maxs"
- type: Vector
- - name: "flagMask"
- type: integer
- default: "PARTITION_CLIENT_NON_STATIC_EDICTS"
- - name: "clientPartitionMask"
- type: integer
- default: "PARTITION_CLIENT_NON_STATIC_EDICTS"
+ - position: 1
+ name: "mins"
+ type: Vector
+ - position: 2
+ name: "maxs"
+ type: Vector
+ - position: 3
+ name: "flagMask"
+ type: integer
+ default: "PARTITION_CLIENT_NON_STATIC_EDICTS"
+ - position: 4
+ name: "clientPartitionMask"
+ type: integer
+ default: "PARTITION_CLIENT_NON_STATIC_EDICTS"
returns:
- type: table
description: "A table of entities found."
diff --git a/docs/libraries/Entities/GetInPvs.md b/docs/libraries/Entities/GetInPvs.md
index c644ef90a7..d5cc75c5a7 100644
--- a/docs/libraries/Entities/GetInPvs.md
+++ b/docs/libraries/Entities/GetInPvs.md
@@ -14,8 +14,9 @@ lua:
description: "Goes through the entities and find the ones that are in the PVS of the provided vector."
arguments:
- - name: "viewOrigin"
- type: Vector
+ - position: 1
+ name: "viewOrigin"
+ type: Vector
returns:
- type: table
description: "A table of entities found."
diff --git a/docs/libraries/Entities/GetInSphere.md b/docs/libraries/Entities/GetInSphere.md
index abb8a830f7..a0359fa118 100644
--- a/docs/libraries/Entities/GetInSphere.md
+++ b/docs/libraries/Entities/GetInSphere.md
@@ -14,16 +14,20 @@ lua:
description: "Finds all entities in the given sphere. Note that clientPartitionMask is only available on the client."
arguments:
- - name: "position"
- type: Vector
- - name: "radius"
- type: number
- - name: "flagMask"
- type: integer
- default: "PARTITION_CLIENT_NON_STATIC_EDICTS"
- - name: "partitionMask"
- type: integer
- default: "PARTITION_CLIENT_NON_STATIC_EDICTS"
+ - position: 1
+ name: "position"
+ type: Vector
+ - position: 2
+ name: "radius"
+ type: number
+ - position: 3
+ name: "flagMask"
+ type: integer
+ default: "PARTITION_CLIENT_NON_STATIC_EDICTS"
+ - position: 4
+ name: "partitionMask"
+ type: integer
+ default: "PARTITION_CLIENT_NON_STATIC_EDICTS"
returns:
- type: table
description: "A table of entities found."
diff --git a/docs/libraries/Entities/IsClearing.md b/docs/libraries/Entities/IsClearing.md
index 0f95e3baf2..98d8d820fa 100644
--- a/docs/libraries/Entities/IsClearing.md
+++ b/docs/libraries/Entities/IsClearing.md
@@ -13,6 +13,7 @@ lua:
realm: server
description: "Checks if the entity list is being cleared"
+ arguments:
returns:
- type: boolean
diff --git a/docs/libraries/Entities/IsValidEdict.md b/docs/libraries/Entities/IsValidEdict.md
index 824a3db7e2..fe300d262c 100644
--- a/docs/libraries/Entities/IsValidEdict.md
+++ b/docs/libraries/Entities/IsValidEdict.md
@@ -14,8 +14,9 @@ lua:
description: "Checks if an entity is valid by checking if it's edict is valid and not free"
arguments:
- - name: "entity"
- type: Entity
+ - position: 1
+ name: "entity"
+ type: Entity
returns:
- type: boolean
description: "True if the entity is valid, false otherwise."
diff --git a/docs/libraries/Entities/NextInList.md b/docs/libraries/Entities/NextInList.md
index fcfa0bed30..973aa434c1 100644
--- a/docs/libraries/Entities/NextInList.md
+++ b/docs/libraries/Entities/NextInList.md
@@ -14,9 +14,10 @@ lua:
description: "Gets the next entity in the list"
arguments:
- - name: "startingEntity"
- type: Entity
- default: "NULL"
+ - position: 1
+ name: "startingEntity"
+ type: Entity
+ default: "NULL"
returns:
- type: Entity
description: "The next entity in the entity list."
diff --git a/docs/libraries/Entities/NotifyCreate.md b/docs/libraries/Entities/NotifyCreate.md
index a9442c8d2b..01579e86ad 100644
--- a/docs/libraries/Entities/NotifyCreate.md
+++ b/docs/libraries/Entities/NotifyCreate.md
@@ -14,8 +14,9 @@ lua:
description: "Notifies the entity list that an entity was created"
arguments:
- - name: "entity"
- type: Entity
+ - position: 1
+ name: "entity"
+ type: Entity
returns:
---
diff --git a/docs/libraries/Entities/NotifySpawn.md b/docs/libraries/Entities/NotifySpawn.md
index f1ec40f275..88b9b388f5 100644
--- a/docs/libraries/Entities/NotifySpawn.md
+++ b/docs/libraries/Entities/NotifySpawn.md
@@ -14,8 +14,9 @@ lua:
description: "Notifies the entity list that an entity was spawned"
arguments:
- - name: "entity"
- type: Entity
+ - position: 1
+ name: "entity"
+ type: Entity
returns:
---
diff --git a/docs/libraries/Entities/Remove.md b/docs/libraries/Entities/Remove.md
index 145c7e3701..cd0849c2a3 100644
--- a/docs/libraries/Entities/Remove.md
+++ b/docs/libraries/Entities/Remove.md
@@ -14,8 +14,9 @@ lua:
description: "Removes an entity"
arguments:
- - name: "entity"
- type: Entity
+ - position: 1
+ name: "entity"
+ type: Entity
returns:
---
diff --git a/docs/libraries/Entities/RemoveImmediate.md b/docs/libraries/Entities/RemoveImmediate.md
index a1fc5bebe5..97b6f94302 100644
--- a/docs/libraries/Entities/RemoveImmediate.md
+++ b/docs/libraries/Entities/RemoveImmediate.md
@@ -14,8 +14,9 @@ lua:
description: "Removes an entity immediately"
arguments:
- - name: "entity"
- type: Entity
+ - position: 1
+ name: "entity"
+ type: Entity
returns:
---
diff --git a/docs/libraries/Entities/ReportFlagsChanged.md b/docs/libraries/Entities/ReportFlagsChanged.md
index c4709e550e..b6b51cbb59 100644
--- a/docs/libraries/Entities/ReportFlagsChanged.md
+++ b/docs/libraries/Entities/ReportFlagsChanged.md
@@ -14,12 +14,15 @@ lua:
description: "Reports that an entity's flags have changed"
arguments:
- - name: "entity"
- type: Entity
- - name: "flagsOld"
- type: number
- - name: "flagsNow"
- type: number
+ - position: 1
+ name: "entity"
+ type: Entity
+ - position: 2
+ name: "flagsOld"
+ type: number
+ - position: 3
+ name: "flagsNow"
+ type: number
returns:
---
diff --git a/docs/libraries/Entities/ResetDeleteList.md b/docs/libraries/Entities/ResetDeleteList.md
index 5714746c7d..4c0b0cb7ae 100644
--- a/docs/libraries/Entities/ResetDeleteList.md
+++ b/docs/libraries/Entities/ResetDeleteList.md
@@ -13,6 +13,7 @@ lua:
realm: server
description: "Resets the delete list"
+ arguments:
returns:
- type: integer
diff --git a/docs/libraries/Files/AddPackFile.md b/docs/libraries/Files/AddPackFile.md
index f805206838..8e043125a2 100644
--- a/docs/libraries/Files/AddPackFile.md
+++ b/docs/libraries/Files/AddPackFile.md
@@ -14,10 +14,12 @@ lua:
description: "Add a pack file to the search path."
arguments:
- - name: "path"
- type: string
- - name: "pathId"
- type: string
+ - position: 1
+ name: "path"
+ type: string
+ - position: 2
+ name: "pathId"
+ type: string
returns:
- type: boolean
description: "true if the pack file was added, false otherwise."
diff --git a/docs/libraries/Files/AddSearchPath.md b/docs/libraries/Files/AddSearchPath.md
index c01464e797..cc5e3808d6 100644
--- a/docs/libraries/Files/AddSearchPath.md
+++ b/docs/libraries/Files/AddSearchPath.md
@@ -14,13 +14,16 @@ lua:
description: "Add a search path to the filesystem."
arguments:
- - name: "path"
- type: string
- - name: "pathId"
- type: string
- - name: "addType"
- type: enumeration/SEARCH_PATH_ADD_TO
- default: "PATH_ADD_TO_TAIL"
+ - position: 1
+ name: "path"
+ type: string
+ - position: 2
+ name: "pathId"
+ type: string
+ - position: 3
+ name: "addType"
+ type: enumeration/SEARCH_PATH_ADD_TO
+ default: "PATH_ADD_TO_TAIL"
returns:
---
diff --git a/docs/libraries/Files/BeginMapAccess.md b/docs/libraries/Files/BeginMapAccess.md
index af1d883e5a..d6e43b4fd1 100644
--- a/docs/libraries/Files/BeginMapAccess.md
+++ b/docs/libraries/Files/BeginMapAccess.md
@@ -13,6 +13,7 @@ lua:
realm: shared
description: "Begin map access."
+ arguments:
returns:
diff --git a/docs/libraries/Files/CancelWaitForResources.md b/docs/libraries/Files/CancelWaitForResources.md
index 86af889dd3..d190c99fc5 100644
--- a/docs/libraries/Files/CancelWaitForResources.md
+++ b/docs/libraries/Files/CancelWaitForResources.md
@@ -14,8 +14,9 @@ lua:
description: "Cancel waiting for resources."
arguments:
- - name: "id"
- type: number
+ - position: 1
+ name: "id"
+ type: number
returns:
---
diff --git a/docs/libraries/Files/Close.md b/docs/libraries/Files/Close.md
index a398c4c846..8b8d4d3acb 100644
--- a/docs/libraries/Files/Close.md
+++ b/docs/libraries/Files/Close.md
@@ -14,8 +14,9 @@ lua:
description: "Close a file."
arguments:
- - name: "file"
- type: FileHandle
+ - position: 1
+ name: "file"
+ type: FileHandle
returns:
---
diff --git a/docs/libraries/Files/CreateDirectoryHierarchy.md b/docs/libraries/Files/CreateDirectoryHierarchy.md
index a23793592e..6db77f64ca 100644
--- a/docs/libraries/Files/CreateDirectoryHierarchy.md
+++ b/docs/libraries/Files/CreateDirectoryHierarchy.md
@@ -14,11 +14,13 @@ lua:
description: "Create a directory hierarchy."
arguments:
- - name: "path"
- type: string
- - name: "pathId"
- type: string
- default: "0"
+ - position: 1
+ name: "path"
+ type: string
+ - position: 2
+ name: "pathId"
+ type: string
+ default: "0"
returns:
---
diff --git a/docs/libraries/Files/DiscardPreloadData.md b/docs/libraries/Files/DiscardPreloadData.md
index 7ca12f1eae..88208a0163 100644
--- a/docs/libraries/Files/DiscardPreloadData.md
+++ b/docs/libraries/Files/DiscardPreloadData.md
@@ -13,6 +13,7 @@ lua:
realm: shared
description: "Discard preload data."
+ arguments:
returns:
diff --git a/docs/libraries/Files/Disconnect.md b/docs/libraries/Files/Disconnect.md
index f0cfd015fc..5d8d314717 100644
--- a/docs/libraries/Files/Disconnect.md
+++ b/docs/libraries/Files/Disconnect.md
@@ -13,6 +13,7 @@ lua:
realm: shared
description: "Disconnect."
+ arguments:
returns:
diff --git a/docs/libraries/Files/EnableAllowListFileTracking.md b/docs/libraries/Files/EnableAllowListFileTracking.md
index eddcef812d..b5e19dc8fc 100644
--- a/docs/libraries/Files/EnableAllowListFileTracking.md
+++ b/docs/libraries/Files/EnableAllowListFileTracking.md
@@ -14,12 +14,15 @@ lua:
description: "Enable allowlist file tracking."
arguments:
- - name: "enable"
- type: boolean
- - name: "cacheAllVPKHashes"
- type: boolean
- - name: "recalculateAndCheckHashes"
- type: boolean
+ - position: 1
+ name: "enable"
+ type: boolean
+ - position: 2
+ name: "cacheAllVPKHashes"
+ type: boolean
+ - position: 3
+ name: "recalculateAndCheckHashes"
+ type: boolean
returns:
---
diff --git a/docs/libraries/Files/EndMapAccess.md b/docs/libraries/Files/EndMapAccess.md
index b836c0567b..12aa69bea1 100644
--- a/docs/libraries/Files/EndMapAccess.md
+++ b/docs/libraries/Files/EndMapAccess.md
@@ -13,6 +13,7 @@ lua:
realm: shared
description: "End map access."
+ arguments:
returns:
diff --git a/docs/libraries/Files/EndOfFile.md b/docs/libraries/Files/EndOfFile.md
index 9ec418d869..eefda8c786 100644
--- a/docs/libraries/Files/EndOfFile.md
+++ b/docs/libraries/Files/EndOfFile.md
@@ -14,8 +14,9 @@ lua:
description: "Check if the end of a file has been reached."
arguments:
- - name: "file"
- type: FileHandle
+ - position: 1
+ name: "file"
+ type: FileHandle
returns:
- type: boolean
description: "true if the end of the file has been reached, false otherwise."
diff --git a/docs/libraries/Files/FileExists.md b/docs/libraries/Files/FileExists.md
index da7ac65704..521403c795 100644
--- a/docs/libraries/Files/FileExists.md
+++ b/docs/libraries/Files/FileExists.md
@@ -14,11 +14,13 @@ lua:
description: "Check if the file or directory exists."
arguments:
- - name: "path"
- type: string
- - name: "pathId"
- type: string
- default: "0"
+ - position: 1
+ name: "path"
+ type: string
+ - position: 2
+ name: "pathId"
+ type: string
+ default: "0"
returns:
- type: boolean
description: "true if the file or directory exists, false otherwise."
diff --git a/docs/libraries/Files/Find.md b/docs/libraries/Files/Find.md
index c9a0b37f63..202dcaad63 100644
--- a/docs/libraries/Files/Find.md
+++ b/docs/libraries/Files/Find.md
@@ -14,11 +14,13 @@ lua:
description: "Find files."
arguments:
- - name: "path"
- type: string
- - name: "pathId"
- type: string
- default: "\"GAME\""
+ - position: 1
+ name: "path"
+ type: string
+ - position: 2
+ name: "pathId"
+ type: string
+ default: "\"GAME\""
returns:
- type: table
description: "The files and directories."
diff --git a/docs/libraries/Files/Flush.md b/docs/libraries/Files/Flush.md
index 714a252d3b..e6d5647276 100644
--- a/docs/libraries/Files/Flush.md
+++ b/docs/libraries/Files/Flush.md
@@ -14,8 +14,9 @@ lua:
description: "Flush a file."
arguments:
- - name: "file"
- type: FileHandle
+ - position: 1
+ name: "file"
+ type: FileHandle
returns:
---
diff --git a/docs/libraries/Files/GetDvdMode.md b/docs/libraries/Files/GetDvdMode.md
index 7fa5f3dc37..e17c0aa182 100644
--- a/docs/libraries/Files/GetDvdMode.md
+++ b/docs/libraries/Files/GetDvdMode.md
@@ -13,6 +13,7 @@ lua:
realm: shared
description: "Get the DVD mode."
+ arguments:
returns:
- type: integer
diff --git a/docs/libraries/Files/GetLocalCopy.md b/docs/libraries/Files/GetLocalCopy.md
index e045895b63..290a017a50 100644
--- a/docs/libraries/Files/GetLocalCopy.md
+++ b/docs/libraries/Files/GetLocalCopy.md
@@ -14,8 +14,9 @@ lua:
description: "Get a local copy of a file."
arguments:
- - name: "path"
- type: string
+ - position: 1
+ name: "path"
+ type: string
returns:
---
diff --git a/docs/libraries/Files/GetSearchPath.md b/docs/libraries/Files/GetSearchPath.md
index 81d092881f..a4ddf98e58 100644
--- a/docs/libraries/Files/GetSearchPath.md
+++ b/docs/libraries/Files/GetSearchPath.md
@@ -14,8 +14,13 @@ lua:
description: "Get the search path."
arguments:
- - name: "path"
- type: string
+ - position: 1
+ name: "path"
+ type: string
+ - position: 2
+ name: "bGetPackFiles"
+ type: boolean
+ default: "false"
returns:
- type: string
description: "The search path."
diff --git a/docs/libraries/Files/GetWhitelistSpewFlags.md b/docs/libraries/Files/GetWhitelistSpewFlags.md
index 49df7bb6a0..74181ee03e 100644
--- a/docs/libraries/Files/GetWhitelistSpewFlags.md
+++ b/docs/libraries/Files/GetWhitelistSpewFlags.md
@@ -13,6 +13,7 @@ lua:
realm: shared
description: "Get the whitelist spew flags."
+ arguments:
returns:
- type: integer
diff --git a/docs/libraries/Files/HintResourceNeed.md b/docs/libraries/Files/HintResourceNeed.md
index 816e922954..1c57437d16 100644
--- a/docs/libraries/Files/HintResourceNeed.md
+++ b/docs/libraries/Files/HintResourceNeed.md
@@ -14,10 +14,12 @@ lua:
description: "Hint that a resource is needed."
arguments:
- - name: "filename"
- type: string
- - name: "characterCount"
- type: number
+ - position: 1
+ name: "filename"
+ type: string
+ - position: 2
+ name: "characterCount"
+ type: number
returns:
- type: integer
description: "The hint resource need."
diff --git a/docs/libraries/Files/IsDirectory.md b/docs/libraries/Files/IsDirectory.md
index 41c6d4517e..8aa0cecef4 100644
--- a/docs/libraries/Files/IsDirectory.md
+++ b/docs/libraries/Files/IsDirectory.md
@@ -14,11 +14,13 @@ lua:
description: "Check if a path is a directory."
arguments:
- - name: "path"
- type: string
- - name: "pathId"
- type: string
- default: "0"
+ - position: 1
+ name: "path"
+ type: string
+ - position: 2
+ name: "pathId"
+ type: string
+ default: "0"
returns:
- type: boolean
description: "true if the path is a directory, false otherwise."
diff --git a/docs/libraries/Files/IsFileImmediatelyAvailable.md b/docs/libraries/Files/IsFileImmediatelyAvailable.md
index a6e3b11115..d33cedf292 100644
--- a/docs/libraries/Files/IsFileImmediatelyAvailable.md
+++ b/docs/libraries/Files/IsFileImmediatelyAvailable.md
@@ -14,8 +14,9 @@ lua:
description: "Check if a file is immediately available."
arguments:
- - name: "path"
- type: string
+ - position: 1
+ name: "path"
+ type: string
returns:
- type: boolean
description: "true if the file is immediately available, false otherwise."
diff --git a/docs/libraries/Files/IsFileWritable.md b/docs/libraries/Files/IsFileWritable.md
index e148eca3ff..e8aadbdb2e 100644
--- a/docs/libraries/Files/IsFileWritable.md
+++ b/docs/libraries/Files/IsFileWritable.md
@@ -14,11 +14,13 @@ lua:
description: "Check if a file is writable."
arguments:
- - name: "path"
- type: string
- - name: "pathId"
- type: string
- default: "0"
+ - position: 1
+ name: "path"
+ type: string
+ - position: 2
+ name: "pathId"
+ type: string
+ default: "0"
returns:
- type: boolean
description: "true if the file is writable, false otherwise."
diff --git a/docs/libraries/Files/IsOk.md b/docs/libraries/Files/IsOk.md
index c7edebadb1..09ab610ab4 100644
--- a/docs/libraries/Files/IsOk.md
+++ b/docs/libraries/Files/IsOk.md
@@ -14,8 +14,9 @@ lua:
description: "Check if a file handle is valid."
arguments:
- - name: "file"
- type: FileHandle
+ - position: 1
+ name: "file"
+ type: FileHandle
returns:
- type: boolean
description: "true if the file handle is valid, false otherwise."
diff --git a/docs/libraries/Files/IsSteam.md b/docs/libraries/Files/IsSteam.md
index 5aa404e626..5a902b3bd0 100644
--- a/docs/libraries/Files/IsSteam.md
+++ b/docs/libraries/Files/IsSteam.md
@@ -13,6 +13,7 @@ lua:
realm: shared
description: "Check if Steam is running."
+ arguments:
returns:
- type: boolean
diff --git a/docs/libraries/Files/LoadCompiledKeyValues.md b/docs/libraries/Files/LoadCompiledKeyValues.md
index a5b1c390d8..516bcec0c6 100644
--- a/docs/libraries/Files/LoadCompiledKeyValues.md
+++ b/docs/libraries/Files/LoadCompiledKeyValues.md
@@ -14,8 +14,12 @@ lua:
description: "Load compiled key values."
arguments:
- - name: "filename"
- type: string
+ - position: 1
+ name: "preloadType"
+ type: enumeration/KEY_VALUES_PRELOAD_TYPE
+ - position: 2
+ name: "filename"
+ type: string
returns:
---
diff --git a/docs/libraries/Files/MarkAllCrcsUnverified.md b/docs/libraries/Files/MarkAllCrcsUnverified.md
index 616333eca7..a7bb0a9e7a 100644
--- a/docs/libraries/Files/MarkAllCrcsUnverified.md
+++ b/docs/libraries/Files/MarkAllCrcsUnverified.md
@@ -13,6 +13,7 @@ lua:
realm: shared
description: "Mark all CRCs as unverified."
+ arguments:
returns:
diff --git a/docs/libraries/Files/MarkPathIdByRequestOnly.md b/docs/libraries/Files/MarkPathIdByRequestOnly.md
index 182f8d1e0c..d155abf16a 100644
--- a/docs/libraries/Files/MarkPathIdByRequestOnly.md
+++ b/docs/libraries/Files/MarkPathIdByRequestOnly.md
@@ -14,10 +14,12 @@ lua:
description: "Mark a path ID as request only."
arguments:
- - name: "pathId"
- type: string
- - name: "requestOnly"
- type: boolean
+ - position: 1
+ name: "pathId"
+ type: string
+ - position: 2
+ name: "requestOnly"
+ type: boolean
returns:
---
diff --git a/docs/libraries/Files/MountSteamContent.md b/docs/libraries/Files/MountSteamContent.md
index d94eab7eba..fb54aed117 100644
--- a/docs/libraries/Files/MountSteamContent.md
+++ b/docs/libraries/Files/MountSteamContent.md
@@ -14,9 +14,10 @@ lua:
description: "Mount Steam content."
arguments:
- - name: "appId"
- type: number
- default: "-1"
+ - position: 1
+ name: "appId"
+ type: number
+ default: "-1"
returns:
- type: integer
description: "The mount Steam content."
diff --git a/docs/libraries/Files/Open.md b/docs/libraries/Files/Open.md
index 90edb757a8..e50147b3d1 100644
--- a/docs/libraries/Files/Open.md
+++ b/docs/libraries/Files/Open.md
@@ -14,13 +14,16 @@ lua:
description: "Open a file."
arguments:
- - name: "filePath"
- type: string
- - name: "readMode"
- type: string
- - name: "pathId"
- type: string
- default: "\"DATA\""
+ - position: 1
+ name: "filePath"
+ type: string
+ - position: 2
+ name: "readMode"
+ type: string
+ - position: 3
+ name: "pathId"
+ type: string
+ default: "\"DATA\""
returns:
- type: FileHandle
description: "The file handle."
diff --git a/docs/libraries/Files/Precache.md b/docs/libraries/Files/Precache.md
index 0be03a348b..184c0f8773 100644
--- a/docs/libraries/Files/Precache.md
+++ b/docs/libraries/Files/Precache.md
@@ -14,11 +14,13 @@ lua:
description: "Precache a file."
arguments:
- - name: "path"
- type: string
- - name: "pathId"
- type: string
- default: "0"
+ - position: 1
+ name: "path"
+ type: string
+ - position: 2
+ name: "pathId"
+ type: string
+ default: "0"
returns:
- type: boolean
description: "true if the file was precached, false otherwise."
diff --git a/docs/libraries/Files/PrintOpenedFiles.md b/docs/libraries/Files/PrintOpenedFiles.md
index e736f3325b..8ed202e693 100644
--- a/docs/libraries/Files/PrintOpenedFiles.md
+++ b/docs/libraries/Files/PrintOpenedFiles.md
@@ -13,6 +13,7 @@ lua:
realm: shared
description: "Print opened files."
+ arguments:
returns:
diff --git a/docs/libraries/Files/PrintSearchPaths.md b/docs/libraries/Files/PrintSearchPaths.md
index 486266c7d6..0aec11aa4d 100644
--- a/docs/libraries/Files/PrintSearchPaths.md
+++ b/docs/libraries/Files/PrintSearchPaths.md
@@ -13,6 +13,7 @@ lua:
realm: shared
description: "Print search paths."
+ arguments:
returns:
diff --git a/docs/libraries/Files/Read.md b/docs/libraries/Files/Read.md
index ee5c702e57..5786bb9659 100644
--- a/docs/libraries/Files/Read.md
+++ b/docs/libraries/Files/Read.md
@@ -14,10 +14,12 @@ lua:
description: "Read from a file."
arguments:
- - name: "file"
- type: FileHandle
- - name: "size"
- type: number
+ - position: 1
+ name: "size"
+ type: number
+ - position: 2
+ name: "file"
+ type: FileHandle
returns:
- type: integer
description: "The number of bytes read."
diff --git a/docs/libraries/Files/RemoveAllSearchPaths.md b/docs/libraries/Files/RemoveAllSearchPaths.md
index 1d6fce3f2d..d40dc972f9 100644
--- a/docs/libraries/Files/RemoveAllSearchPaths.md
+++ b/docs/libraries/Files/RemoveAllSearchPaths.md
@@ -13,6 +13,7 @@ lua:
realm: shared
description: "Remove all search paths."
+ arguments:
returns:
diff --git a/docs/libraries/Files/RemoveFile.md b/docs/libraries/Files/RemoveFile.md
index 4b8898f40b..3d90e5909d 100644
--- a/docs/libraries/Files/RemoveFile.md
+++ b/docs/libraries/Files/RemoveFile.md
@@ -14,11 +14,13 @@ lua:
description: "Remove a file."
arguments:
- - name: "path"
- type: string
- - name: "pathId"
- type: string
- default: "0"
+ - position: 1
+ name: "path"
+ type: string
+ - position: 2
+ name: "pathId"
+ type: string
+ default: "0"
returns:
---
diff --git a/docs/libraries/Files/RemoveSearchPath.md b/docs/libraries/Files/RemoveSearchPath.md
index 26bc126d08..a0b39c15ed 100644
--- a/docs/libraries/Files/RemoveSearchPath.md
+++ b/docs/libraries/Files/RemoveSearchPath.md
@@ -14,11 +14,13 @@ lua:
description: "Remove a search path."
arguments:
- - name: "path"
- type: string
- - name: "pathId"
- type: string
- default: "0"
+ - position: 1
+ name: "path"
+ type: string
+ - position: 2
+ name: "pathId"
+ type: string
+ default: "0"
returns:
- type: boolean
description: "true if the search path was removed, false otherwise."
diff --git a/docs/libraries/Files/RemoveSearchPaths.md b/docs/libraries/Files/RemoveSearchPaths.md
index ffc70440ac..98fcd69625 100644
--- a/docs/libraries/Files/RemoveSearchPaths.md
+++ b/docs/libraries/Files/RemoveSearchPaths.md
@@ -14,8 +14,9 @@ lua:
description: "Remove search paths."
arguments:
- - name: "path"
- type: string
+ - position: 1
+ name: "path"
+ type: string
returns:
---
diff --git a/docs/libraries/Files/RenameFile.md b/docs/libraries/Files/RenameFile.md
index c9610f590a..31d97d88b5 100644
--- a/docs/libraries/Files/RenameFile.md
+++ b/docs/libraries/Files/RenameFile.md
@@ -14,13 +14,16 @@ lua:
description: "Rename a file."
arguments:
- - name: "oldPath"
- type: string
- - name: "newPath"
- type: string
- - name: "pathId"
- type: string
- default: "0"
+ - position: 1
+ name: "oldPath"
+ type: string
+ - position: 2
+ name: "newPath"
+ type: string
+ - position: 3
+ name: "pathId"
+ type: string
+ default: "0"
returns:
- type: boolean
description: "true if the file was renamed, false otherwise."
diff --git a/docs/libraries/Files/SetFileWritable.md b/docs/libraries/Files/SetFileWritable.md
index 982f1ef27b..4424abc0b4 100644
--- a/docs/libraries/Files/SetFileWritable.md
+++ b/docs/libraries/Files/SetFileWritable.md
@@ -14,13 +14,16 @@ lua:
description: "Set a file as writable."
arguments:
- - name: "path"
- type: string
- - name: "writable"
- type: boolean
- - name: "pathId"
- type: string
- default: "0"
+ - position: 1
+ name: "path"
+ type: string
+ - position: 2
+ name: "writable"
+ type: boolean
+ - position: 3
+ name: "pathId"
+ type: string
+ default: "0"
returns:
- type: boolean
description: "true if the file was set as writable, false otherwise."
diff --git a/docs/libraries/Files/SetWarningLevel.md b/docs/libraries/Files/SetWarningLevel.md
index c9f7c7e0ec..45090a97bd 100644
--- a/docs/libraries/Files/SetWarningLevel.md
+++ b/docs/libraries/Files/SetWarningLevel.md
@@ -14,8 +14,9 @@ lua:
description: "Set the warning level."
arguments:
- - name: "level"
- type: enumeration/FILE_WARNING_LEVEL
+ - position: 1
+ name: "level"
+ type: enumeration/FILE_WARNING_LEVEL
returns:
---
diff --git a/docs/libraries/Files/SetWhitelistSpewFlags.md b/docs/libraries/Files/SetWhitelistSpewFlags.md
index 16d322ac50..2ffbd53d66 100644
--- a/docs/libraries/Files/SetWhitelistSpewFlags.md
+++ b/docs/libraries/Files/SetWhitelistSpewFlags.md
@@ -14,8 +14,9 @@ lua:
description: "Set the whitelist spew flags."
arguments:
- - name: "flags"
- type: number
+ - position: 1
+ name: "flags"
+ type: number
returns:
---
diff --git a/docs/libraries/Files/SetupPreloadData.md b/docs/libraries/Files/SetupPreloadData.md
index 1b96104257..a95c772304 100644
--- a/docs/libraries/Files/SetupPreloadData.md
+++ b/docs/libraries/Files/SetupPreloadData.md
@@ -13,6 +13,7 @@ lua:
realm: shared
description: "Setup preload data."
+ arguments:
returns:
diff --git a/docs/libraries/Files/Shutdown.md b/docs/libraries/Files/Shutdown.md
index 7deef1de0c..d5db751748 100644
--- a/docs/libraries/Files/Shutdown.md
+++ b/docs/libraries/Files/Shutdown.md
@@ -13,6 +13,7 @@ lua:
realm: shared
description: "Shutdown the filesystem."
+ arguments:
returns:
diff --git a/docs/libraries/Files/Size.md b/docs/libraries/Files/Size.md
index 3c42a625ae..0ebc6587b3 100644
--- a/docs/libraries/Files/Size.md
+++ b/docs/libraries/Files/Size.md
@@ -13,13 +13,17 @@ lua:
realm: shared
description: "Get the size of a file."
- argumentSets:
- - arguments:
+ arguments:
+ - position: 1
+ types:
- name: "path"
type: string
- - arguments:
- name: "file"
type: FileHandle
+ - position: 2
+ name: "pathId"
+ type: string
+ default: "0"
returns:
- type: integer
description: "The size of the file."
diff --git a/docs/libraries/Files/UnzipFile.md b/docs/libraries/Files/UnzipFile.md
index eba31a391f..71c083775d 100644
--- a/docs/libraries/Files/UnzipFile.md
+++ b/docs/libraries/Files/UnzipFile.md
@@ -14,12 +14,15 @@ lua:
description: "Unzip a file."
arguments:
- - name: "source"
- type: string
- - name: "destination"
- type: string
- - name: "pathId"
- type: string
+ - position: 1
+ name: "source"
+ type: string
+ - position: 2
+ name: "destination"
+ type: string
+ - position: 3
+ name: "pathId"
+ type: string
returns:
- type: boolean
description: "true if the file was unzipped, false otherwise."
diff --git a/docs/libraries/Files/WaitForResources.md b/docs/libraries/Files/WaitForResources.md
index 8e4994fe21..7f1079ad45 100644
--- a/docs/libraries/Files/WaitForResources.md
+++ b/docs/libraries/Files/WaitForResources.md
@@ -14,8 +14,9 @@ lua:
description: "Wait for resources."
arguments:
- - name: "path"
- type: string
+ - position: 1
+ name: "path"
+ type: string
returns:
- type: integer
description: "The wait for resources."
diff --git a/docs/libraries/Files/Write.md b/docs/libraries/Files/Write.md
index 11479e2a7c..8d414cd243 100644
--- a/docs/libraries/Files/Write.md
+++ b/docs/libraries/Files/Write.md
@@ -14,10 +14,12 @@ lua:
description: "Write to a file."
arguments:
- - name: "input"
- type: string
- - name: "file"
- type: FileHandle
+ - position: 1
+ name: "input"
+ type: string
+ - position: 2
+ name: "file"
+ type: FileHandle
returns:
- type: integer
description: "The number of bytes written."
diff --git a/docs/libraries/GameEvents/Listen.md b/docs/libraries/GameEvents/Listen.md
index a034ff12e8..cbcb20506b 100644
--- a/docs/libraries/GameEvents/Listen.md
+++ b/docs/libraries/GameEvents/Listen.md
@@ -14,8 +14,9 @@ lua:
description: "Call a hook for this game event name, when the event occurs."
arguments:
- - name: "eventName"
- type: string
+ - position: 1
+ name: "eventName"
+ type: string
returns:
---
diff --git a/docs/libraries/Inputs/AimToVector.md b/docs/libraries/Inputs/AimToVector.md
index f7816145d1..c76ecfd891 100644
--- a/docs/libraries/Inputs/AimToVector.md
+++ b/docs/libraries/Inputs/AimToVector.md
@@ -14,18 +14,24 @@ lua:
description: "Convert aiming angles and screen coordinates to a vector."
arguments:
- - name: "angles"
- type: Angle
- - name: "fov"
- type: number
- - name: "x"
- type: number
- - name: "y"
- type: number
- - name: "screenWidth"
- type: number
- - name: "screenHeight"
- type: number
+ - position: 1
+ name: "angles"
+ type: Angle
+ - position: 2
+ name: "fov"
+ type: number
+ - position: 3
+ name: "x"
+ type: number
+ - position: 4
+ name: "y"
+ type: number
+ - position: 5
+ name: "screenWidth"
+ type: number
+ - position: 6
+ name: "screenHeight"
+ type: number
returns:
- type: Vector
description: "Aim vector in world coordinates."
diff --git a/docs/libraries/Inputs/GetAppModalSurface.md b/docs/libraries/Inputs/GetAppModalSurface.md
index 012f972cdc..f3e33187d6 100644
--- a/docs/libraries/Inputs/GetAppModalSurface.md
+++ b/docs/libraries/Inputs/GetAppModalSurface.md
@@ -13,6 +13,7 @@ lua:
realm: client
description: "Get the application modal surface panel."
+ arguments:
returns:
- type: PanelHandle
diff --git a/docs/libraries/Inputs/GetCandidateListCount.md b/docs/libraries/Inputs/GetCandidateListCount.md
index 386138b7fd..6f3b9449c5 100644
--- a/docs/libraries/Inputs/GetCandidateListCount.md
+++ b/docs/libraries/Inputs/GetCandidateListCount.md
@@ -13,6 +13,7 @@ lua:
realm: client
description: "Get the count of candidates in the candidate list."
+ arguments:
returns:
- type: integer
diff --git a/docs/libraries/Inputs/GetCandidateListPageSize.md b/docs/libraries/Inputs/GetCandidateListPageSize.md
index f9358ad382..50030ab8d2 100644
--- a/docs/libraries/Inputs/GetCandidateListPageSize.md
+++ b/docs/libraries/Inputs/GetCandidateListPageSize.md
@@ -13,6 +13,7 @@ lua:
realm: client
description: "Get the page size of the candidate list."
+ arguments:
returns:
- type: integer
diff --git a/docs/libraries/Inputs/GetCandidateListPageStart.md b/docs/libraries/Inputs/GetCandidateListPageStart.md
index 9e0d62ed76..ea21391ddc 100644
--- a/docs/libraries/Inputs/GetCandidateListPageStart.md
+++ b/docs/libraries/Inputs/GetCandidateListPageStart.md
@@ -13,6 +13,7 @@ lua:
realm: client
description: "Get the starting index of the current page in the candidate list."
+ arguments:
returns:
- type: integer
diff --git a/docs/libraries/Inputs/GetCandidateListSelectedItem.md b/docs/libraries/Inputs/GetCandidateListSelectedItem.md
index 9ee6f4c67f..5875b21090 100644
--- a/docs/libraries/Inputs/GetCandidateListSelectedItem.md
+++ b/docs/libraries/Inputs/GetCandidateListSelectedItem.md
@@ -13,6 +13,7 @@ lua:
realm: client
description: "Get the selected item's index in the candidate list."
+ arguments:
returns:
- type: integer
diff --git a/docs/libraries/Inputs/GetCurrentImeHandle.md b/docs/libraries/Inputs/GetCurrentImeHandle.md
index 3cd9d8084a..d2b11ebc57 100644
--- a/docs/libraries/Inputs/GetCurrentImeHandle.md
+++ b/docs/libraries/Inputs/GetCurrentImeHandle.md
@@ -13,6 +13,7 @@ lua:
realm: client
description: "Get the handle of the current Input Method Editor (IME)."
+ arguments:
returns:
- type: integer
diff --git a/docs/libraries/Inputs/GetCursorPosition.md b/docs/libraries/Inputs/GetCursorPosition.md
index 954b638b35..42c20d2d9e 100644
--- a/docs/libraries/Inputs/GetCursorPosition.md
+++ b/docs/libraries/Inputs/GetCursorPosition.md
@@ -13,6 +13,7 @@ lua:
realm: client
description: "Get the current cursor position."
+ arguments:
returns:
- type: integer, integer
diff --git a/docs/libraries/Inputs/GetCursorPositionVcrMode.md b/docs/libraries/Inputs/GetCursorPositionVcrMode.md
index fd97655a94..58ad9e538f 100644
--- a/docs/libraries/Inputs/GetCursorPositionVcrMode.md
+++ b/docs/libraries/Inputs/GetCursorPositionVcrMode.md
@@ -13,6 +13,7 @@ lua:
realm: client
description: "Get the cursor position using VCR mode."
+ arguments:
returns:
- type: integer, integer
diff --git a/docs/libraries/Inputs/GetEnglishImeHandle.md b/docs/libraries/Inputs/GetEnglishImeHandle.md
index a1392addea..ec87f33789 100644
--- a/docs/libraries/Inputs/GetEnglishImeHandle.md
+++ b/docs/libraries/Inputs/GetEnglishImeHandle.md
@@ -13,6 +13,7 @@ lua:
realm: client
description: "Get the handle of the English Input Method Editor (IME)."
+ arguments:
returns:
- type: integer
diff --git a/docs/libraries/Inputs/GetFocus.md b/docs/libraries/Inputs/GetFocus.md
index 264a95606b..835292a418 100644
--- a/docs/libraries/Inputs/GetFocus.md
+++ b/docs/libraries/Inputs/GetFocus.md
@@ -13,6 +13,7 @@ lua:
realm: client
description: "Get the panel that currently has focus."
+ arguments:
returns:
- type: PanelHandle
diff --git a/docs/libraries/Inputs/GetModalSubTree.md b/docs/libraries/Inputs/GetModalSubTree.md
index e3769f4e97..e932bb9dd7 100644
--- a/docs/libraries/Inputs/GetModalSubTree.md
+++ b/docs/libraries/Inputs/GetModalSubTree.md
@@ -13,6 +13,7 @@ lua:
realm: client
description: "Get the topmost modal sub-tree panel."
+ arguments:
returns:
- type: PanelHandle
diff --git a/docs/libraries/Inputs/GetMouseCapture.md b/docs/libraries/Inputs/GetMouseCapture.md
index b51f0acdbc..6b18b120a6 100644
--- a/docs/libraries/Inputs/GetMouseCapture.md
+++ b/docs/libraries/Inputs/GetMouseCapture.md
@@ -13,6 +13,7 @@ lua:
realm: client
description: "Get the panel that currently has mouse capture."
+ arguments:
returns:
- type: PanelHandle
diff --git a/docs/libraries/Inputs/GetMouseOver.md b/docs/libraries/Inputs/GetMouseOver.md
index 0bf23a4f9f..a2fe702584 100644
--- a/docs/libraries/Inputs/GetMouseOver.md
+++ b/docs/libraries/Inputs/GetMouseOver.md
@@ -13,6 +13,7 @@ lua:
realm: client
description: "Get the panel that currently is under the mouse cursor."
+ arguments:
returns:
- type: PanelHandle
diff --git a/docs/libraries/Inputs/GetShouldInvertCompositionString.md b/docs/libraries/Inputs/GetShouldInvertCompositionString.md
index 809782f297..640b5eeed2 100644
--- a/docs/libraries/Inputs/GetShouldInvertCompositionString.md
+++ b/docs/libraries/Inputs/GetShouldInvertCompositionString.md
@@ -13,6 +13,7 @@ lua:
realm: client
description: "Check if the composition string should be inverted."
+ arguments:
returns:
- type: boolean
diff --git a/docs/libraries/Inputs/IsCandidateListStartingAtOne.md b/docs/libraries/Inputs/IsCandidateListStartingAtOne.md
index b8d7678538..1db8bae41c 100644
--- a/docs/libraries/Inputs/IsCandidateListStartingAtOne.md
+++ b/docs/libraries/Inputs/IsCandidateListStartingAtOne.md
@@ -13,6 +13,7 @@ lua:
realm: client
description: "Check if the candidate list starts at index one."
+ arguments:
returns:
- type: boolean
diff --git a/docs/libraries/Inputs/IsKeyDown.md b/docs/libraries/Inputs/IsKeyDown.md
index 1a88b42a06..41380712c1 100644
--- a/docs/libraries/Inputs/IsKeyDown.md
+++ b/docs/libraries/Inputs/IsKeyDown.md
@@ -14,8 +14,9 @@ lua:
description: "Check if a specific key is down."
arguments:
- - name: "keyCode"
- type: enumeration/BUTTON
+ - position: 1
+ name: "keyCode"
+ type: enumeration/BUTTON
returns:
- type: boolean
description: "Whether the key is down."
diff --git a/docs/libraries/Inputs/IsMouseDown.md b/docs/libraries/Inputs/IsMouseDown.md
index dfd262651c..46a1d6bc1f 100644
--- a/docs/libraries/Inputs/IsMouseDown.md
+++ b/docs/libraries/Inputs/IsMouseDown.md
@@ -14,8 +14,9 @@ lua:
description: "Check if a specific mouse button is down."
arguments:
- - name: "mouseCode"
- type: enumeration/BUTTON
+ - position: 1
+ name: "mouseCode"
+ type: enumeration/BUTTON
returns:
- type: boolean
description: "Whether the mouse button is down."
diff --git a/docs/libraries/Inputs/LookupBinding.md b/docs/libraries/Inputs/LookupBinding.md
index 8954f14d06..4eb86361e7 100644
--- a/docs/libraries/Inputs/LookupBinding.md
+++ b/docs/libraries/Inputs/LookupBinding.md
@@ -14,10 +14,12 @@ lua:
description: "Look up a key binding."
arguments:
- - name: "keyName"
- type: string
- - name: "exactMatch"
- type: boolean
+ - position: 1
+ name: "keyName"
+ type: string
+ - position: 2
+ name: "exactMatch"
+ type: boolean
returns:
- type: string
description: "The key binding."
diff --git a/docs/libraries/Inputs/LookupKeyBinding.md b/docs/libraries/Inputs/LookupKeyBinding.md
index 966163b5a6..7f20649bbc 100644
--- a/docs/libraries/Inputs/LookupKeyBinding.md
+++ b/docs/libraries/Inputs/LookupKeyBinding.md
@@ -14,8 +14,9 @@ lua:
description: "Get the binding for a specific key code."
arguments:
- - name: "keyCode"
- type: enumeration/BUTTON
+ - position: 1
+ name: "keyCode"
+ type: enumeration/BUTTON
returns:
- type: string
description: "The key binding."
diff --git a/docs/libraries/Inputs/OnChangeIme.md b/docs/libraries/Inputs/OnChangeIme.md
index c8cf00d123..37f5229126 100644
--- a/docs/libraries/Inputs/OnChangeIme.md
+++ b/docs/libraries/Inputs/OnChangeIme.md
@@ -14,8 +14,9 @@ lua:
description: "Trigger a change in the IME state."
arguments:
- - name: "activate"
- type: boolean
+ - position: 1
+ name: "activate"
+ type: boolean
returns:
---
diff --git a/docs/libraries/Inputs/OnChangeImeByHandle.md b/docs/libraries/Inputs/OnChangeImeByHandle.md
index 803e895e65..8316485aba 100644
--- a/docs/libraries/Inputs/OnChangeImeByHandle.md
+++ b/docs/libraries/Inputs/OnChangeImeByHandle.md
@@ -14,8 +14,9 @@ lua:
description: "Change the IME by handle."
arguments:
- - name: "handle"
- type: number
+ - position: 1
+ name: "handle"
+ type: number
returns:
---
diff --git a/docs/libraries/Inputs/OnChangeImeConversionModeByHandle.md b/docs/libraries/Inputs/OnChangeImeConversionModeByHandle.md
index f2665f28c0..c98a3675c3 100644
--- a/docs/libraries/Inputs/OnChangeImeConversionModeByHandle.md
+++ b/docs/libraries/Inputs/OnChangeImeConversionModeByHandle.md
@@ -14,8 +14,9 @@ lua:
description: "Change the IME conversion mode by handle."
arguments:
- - name: "handle"
- type: number
+ - position: 1
+ name: "handle"
+ type: number
returns:
---
diff --git a/docs/libraries/Inputs/OnChangeImeSentenceModeByHandle.md b/docs/libraries/Inputs/OnChangeImeSentenceModeByHandle.md
index 27245d05af..6f695dd783 100644
--- a/docs/libraries/Inputs/OnChangeImeSentenceModeByHandle.md
+++ b/docs/libraries/Inputs/OnChangeImeSentenceModeByHandle.md
@@ -14,8 +14,9 @@ lua:
description: "Change the IME sentence mode by handle."
arguments:
- - name: "handle"
- type: number
+ - position: 1
+ name: "handle"
+ type: number
returns:
---
diff --git a/docs/libraries/Inputs/OnImeChangeCandidates.md b/docs/libraries/Inputs/OnImeChangeCandidates.md
index 476d08c278..837817bfe9 100644
--- a/docs/libraries/Inputs/OnImeChangeCandidates.md
+++ b/docs/libraries/Inputs/OnImeChangeCandidates.md
@@ -13,6 +13,7 @@ lua:
realm: client
description: "Notify a change in IME candidates."
+ arguments:
returns:
diff --git a/docs/libraries/Inputs/OnImeCloseCandidates.md b/docs/libraries/Inputs/OnImeCloseCandidates.md
index 04f44aa629..a48e815ec7 100644
--- a/docs/libraries/Inputs/OnImeCloseCandidates.md
+++ b/docs/libraries/Inputs/OnImeCloseCandidates.md
@@ -13,6 +13,7 @@ lua:
realm: client
description: "Close the IME candidates."
+ arguments:
returns:
diff --git a/docs/libraries/Inputs/OnImeComposition.md b/docs/libraries/Inputs/OnImeComposition.md
index 9050f0291a..89d9d91efa 100644
--- a/docs/libraries/Inputs/OnImeComposition.md
+++ b/docs/libraries/Inputs/OnImeComposition.md
@@ -14,8 +14,9 @@ lua:
description: "Handle IME composition."
arguments:
- - name: "composition"
- type: number
+ - position: 1
+ name: "composition"
+ type: number
returns:
---
diff --git a/docs/libraries/Inputs/OnImeEndComposition.md b/docs/libraries/Inputs/OnImeEndComposition.md
index a63e77dd5c..110ab32423 100644
--- a/docs/libraries/Inputs/OnImeEndComposition.md
+++ b/docs/libraries/Inputs/OnImeEndComposition.md
@@ -13,6 +13,7 @@ lua:
realm: client
description: "End the IME composition."
+ arguments:
returns:
diff --git a/docs/libraries/Inputs/OnImeRecomputeModes.md b/docs/libraries/Inputs/OnImeRecomputeModes.md
index 4fd032a350..afd50781e7 100644
--- a/docs/libraries/Inputs/OnImeRecomputeModes.md
+++ b/docs/libraries/Inputs/OnImeRecomputeModes.md
@@ -13,6 +13,7 @@ lua:
realm: client
description: "Recompute IME modes."
+ arguments:
returns:
diff --git a/docs/libraries/Inputs/OnImeShowCandidates.md b/docs/libraries/Inputs/OnImeShowCandidates.md
index 9ed350da2d..dc747e0c8d 100644
--- a/docs/libraries/Inputs/OnImeShowCandidates.md
+++ b/docs/libraries/Inputs/OnImeShowCandidates.md
@@ -13,6 +13,7 @@ lua:
realm: client
description: "Show IME candidates."
+ arguments:
returns:
diff --git a/docs/libraries/Inputs/OnImeStartComposition.md b/docs/libraries/Inputs/OnImeStartComposition.md
index 10f7f4ee3d..1c6a0327ee 100644
--- a/docs/libraries/Inputs/OnImeStartComposition.md
+++ b/docs/libraries/Inputs/OnImeStartComposition.md
@@ -13,6 +13,7 @@ lua:
realm: client
description: "Start the IME composition."
+ arguments:
returns:
diff --git a/docs/libraries/Inputs/OnInputLanguageChanged.md b/docs/libraries/Inputs/OnInputLanguageChanged.md
index 1d7239c80d..49eb5e3ae6 100644
--- a/docs/libraries/Inputs/OnInputLanguageChanged.md
+++ b/docs/libraries/Inputs/OnInputLanguageChanged.md
@@ -13,6 +13,7 @@ lua:
realm: client
description: "Handle input language change."
+ arguments:
returns:
diff --git a/docs/libraries/Inputs/OnKeyCodeUnhandled.md b/docs/libraries/Inputs/OnKeyCodeUnhandled.md
index 2a3e30af69..329cbff6f0 100644
--- a/docs/libraries/Inputs/OnKeyCodeUnhandled.md
+++ b/docs/libraries/Inputs/OnKeyCodeUnhandled.md
@@ -14,8 +14,9 @@ lua:
description: "Handle unhandled key codes."
arguments:
- - name: "keyCode"
- type: enumeration/BUTTON
+ - position: 1
+ name: "keyCode"
+ type: enumeration/BUTTON
returns:
---
diff --git a/docs/libraries/Inputs/RegisterKeyCodeUnhandledListener.md b/docs/libraries/Inputs/RegisterKeyCodeUnhandledListener.md
index b2c316603c..e529b50be4 100644
--- a/docs/libraries/Inputs/RegisterKeyCodeUnhandledListener.md
+++ b/docs/libraries/Inputs/RegisterKeyCodeUnhandledListener.md
@@ -14,8 +14,9 @@ lua:
description: "Register a listener for unhandled key codes."
arguments:
- - name: "panel"
- type: Panel
+ - position: 1
+ name: "panel"
+ type: Panel
returns:
---
diff --git a/docs/libraries/Inputs/ReleaseAppModalSurface.md b/docs/libraries/Inputs/ReleaseAppModalSurface.md
index 80b40c3d59..400984ce4b 100644
--- a/docs/libraries/Inputs/ReleaseAppModalSurface.md
+++ b/docs/libraries/Inputs/ReleaseAppModalSurface.md
@@ -13,6 +13,7 @@ lua:
realm: client
description: "Release the application modal surface."
+ arguments:
returns:
diff --git a/docs/libraries/Inputs/ReleaseModalSubTree.md b/docs/libraries/Inputs/ReleaseModalSubTree.md
index 740e86624a..a3def39f65 100644
--- a/docs/libraries/Inputs/ReleaseModalSubTree.md
+++ b/docs/libraries/Inputs/ReleaseModalSubTree.md
@@ -13,6 +13,7 @@ lua:
realm: client
description: "Release the modal sub-tree."
+ arguments:
returns:
diff --git a/docs/libraries/Inputs/ScreenToWorld.md b/docs/libraries/Inputs/ScreenToWorld.md
index ef91641840..b8a4b3ad27 100644
--- a/docs/libraries/Inputs/ScreenToWorld.md
+++ b/docs/libraries/Inputs/ScreenToWorld.md
@@ -14,10 +14,12 @@ lua:
description: "Convert screen coordinates to world coordinates."
arguments:
- - name: "x"
- type: number
- - name: "y"
- type: number
+ - position: 1
+ name: "x"
+ type: number
+ - position: 2
+ name: "y"
+ type: number
returns:
- type: Vector
description: "World coordinates vector."
diff --git a/docs/libraries/Inputs/SetAppModalSurface.md b/docs/libraries/Inputs/SetAppModalSurface.md
index 07cd4c5fa4..2c0ff69750 100644
--- a/docs/libraries/Inputs/SetAppModalSurface.md
+++ b/docs/libraries/Inputs/SetAppModalSurface.md
@@ -14,8 +14,9 @@ lua:
description: "Set the application modal surface."
arguments:
- - name: "panel"
- type: Panel
+ - position: 1
+ name: "panel"
+ type: Panel
returns:
---
diff --git a/docs/libraries/Inputs/SetCandidateListPageStart.md b/docs/libraries/Inputs/SetCandidateListPageStart.md
index 212e9a355a..7f10d25003 100644
--- a/docs/libraries/Inputs/SetCandidateListPageStart.md
+++ b/docs/libraries/Inputs/SetCandidateListPageStart.md
@@ -14,8 +14,9 @@ lua:
description: "Set the starting index of the current page in the candidate list."
arguments:
- - name: "index"
- type: number
+ - position: 1
+ name: "index"
+ type: number
returns:
---
diff --git a/docs/libraries/Inputs/SetCandidateWindowPos.md b/docs/libraries/Inputs/SetCandidateWindowPos.md
index d4bfc4ad58..577c99148a 100644
--- a/docs/libraries/Inputs/SetCandidateWindowPos.md
+++ b/docs/libraries/Inputs/SetCandidateWindowPos.md
@@ -14,10 +14,12 @@ lua:
description: "Set the position of the candidate window."
arguments:
- - name: "x"
- type: number
- - name: "y"
- type: number
+ - position: 1
+ name: "x"
+ type: number
+ - position: 2
+ name: "y"
+ type: number
returns:
---
diff --git a/docs/libraries/Inputs/SetCursorPosition.md b/docs/libraries/Inputs/SetCursorPosition.md
index 8bf67fdf9f..ff791bc00b 100644
--- a/docs/libraries/Inputs/SetCursorPosition.md
+++ b/docs/libraries/Inputs/SetCursorPosition.md
@@ -14,10 +14,12 @@ lua:
description: "Set the cursor position."
arguments:
- - name: "x"
- type: number
- - name: "y"
- type: number
+ - position: 1
+ name: "x"
+ type: number
+ - position: 2
+ name: "y"
+ type: number
returns:
---
diff --git a/docs/libraries/Inputs/SetModalSubTree.md b/docs/libraries/Inputs/SetModalSubTree.md
index 4159adcf3c..29e92467dc 100644
--- a/docs/libraries/Inputs/SetModalSubTree.md
+++ b/docs/libraries/Inputs/SetModalSubTree.md
@@ -14,13 +14,16 @@ lua:
description: "Set the modal sub-tree."
arguments:
- - name: "modalSubTree"
- type: Panel
- - name: "scopePanel"
- type: Panel
- - name: "receiveMessages"
- type: boolean
- default: "true"
+ - position: 1
+ name: "modalSubTree"
+ type: Panel
+ - position: 2
+ name: "scopePanel"
+ type: Panel
+ - position: 3
+ name: "receiveMessages"
+ type: boolean
+ default: "true"
returns:
---
diff --git a/docs/libraries/Inputs/SetModalSubTreeReceiveMessages.md b/docs/libraries/Inputs/SetModalSubTreeReceiveMessages.md
index 92c7b7c7d4..541adfd973 100644
--- a/docs/libraries/Inputs/SetModalSubTreeReceiveMessages.md
+++ b/docs/libraries/Inputs/SetModalSubTreeReceiveMessages.md
@@ -14,8 +14,9 @@ lua:
description: "Set the modal sub-tree to receive messages."
arguments:
- - name: "receive"
- type: boolean
+ - position: 1
+ name: "receive"
+ type: boolean
returns:
---
diff --git a/docs/libraries/Inputs/SetMouseCapture.md b/docs/libraries/Inputs/SetMouseCapture.md
index 3d8a98f1da..ae3fac5d38 100644
--- a/docs/libraries/Inputs/SetMouseCapture.md
+++ b/docs/libraries/Inputs/SetMouseCapture.md
@@ -14,9 +14,10 @@ lua:
description: "Set the panel that captures the mouse input."
arguments:
- - name: "panel"
- type: Panel
- default: "NULL"
+ - position: 1
+ name: "panel"
+ type: Panel
+ default: "NULL"
returns:
---
diff --git a/docs/libraries/Inputs/SetMouseCaptureExtended.md b/docs/libraries/Inputs/SetMouseCaptureExtended.md
index 396a24376d..65f83a460f 100644
--- a/docs/libraries/Inputs/SetMouseCaptureExtended.md
+++ b/docs/libraries/Inputs/SetMouseCaptureExtended.md
@@ -14,10 +14,12 @@ lua:
description: "Set the mouse capture with specific mouse code."
arguments:
- - name: "panel"
- type: Panel
- - name: "mouseCode"
- type: enumeration/BUTTON
+ - position: 1
+ name: "panel"
+ type: Panel
+ - position: 2
+ name: "mouseCode"
+ type: enumeration/BUTTON
returns:
---
diff --git a/docs/libraries/Inputs/SetMouseFocus.md b/docs/libraries/Inputs/SetMouseFocus.md
index 631c8ebb51..c50e467654 100644
--- a/docs/libraries/Inputs/SetMouseFocus.md
+++ b/docs/libraries/Inputs/SetMouseFocus.md
@@ -14,8 +14,9 @@ lua:
description: "Set the mouse focus to a panel."
arguments:
- - name: "panel"
- type: Panel
+ - position: 1
+ name: "panel"
+ type: Panel
returns:
---
diff --git a/docs/libraries/Inputs/ShouldModalSubTreeReceiveMessages.md b/docs/libraries/Inputs/ShouldModalSubTreeReceiveMessages.md
index d3a7e640c8..f4d46d86de 100644
--- a/docs/libraries/Inputs/ShouldModalSubTreeReceiveMessages.md
+++ b/docs/libraries/Inputs/ShouldModalSubTreeReceiveMessages.md
@@ -13,6 +13,7 @@ lua:
realm: client
description: "Check if the modal sub-tree should receive messages."
+ arguments:
returns:
- type: boolean
diff --git a/docs/libraries/Inputs/UnregisterKeyCodeUnhandledListener.md b/docs/libraries/Inputs/UnregisterKeyCodeUnhandledListener.md
index fbbb6ecc9a..2e0f6672a2 100644
--- a/docs/libraries/Inputs/UnregisterKeyCodeUnhandledListener.md
+++ b/docs/libraries/Inputs/UnregisterKeyCodeUnhandledListener.md
@@ -14,8 +14,9 @@ lua:
description: "Unregister a listener for unhandled key codes."
arguments:
- - name: "panel"
- type: Panel
+ - position: 1
+ name: "panel"
+ type: Panel
returns:
---
diff --git a/docs/libraries/Inputs/WasKeyPressed.md b/docs/libraries/Inputs/WasKeyPressed.md
index 9b2e9d1c7f..1465b7567e 100644
--- a/docs/libraries/Inputs/WasKeyPressed.md
+++ b/docs/libraries/Inputs/WasKeyPressed.md
@@ -14,8 +14,9 @@ lua:
description: "Check if a specific key was pressed."
arguments:
- - name: "keyCode"
- type: enumeration/BUTTON
+ - position: 1
+ name: "keyCode"
+ type: enumeration/BUTTON
returns:
- type: boolean
description: "Whether the key was pressed."
diff --git a/docs/libraries/Inputs/WasKeyReleased.md b/docs/libraries/Inputs/WasKeyReleased.md
index 5b23e0e5ad..23f97a3aae 100644
--- a/docs/libraries/Inputs/WasKeyReleased.md
+++ b/docs/libraries/Inputs/WasKeyReleased.md
@@ -14,8 +14,9 @@ lua:
description: "Check if a specific key was released."
arguments:
- - name: "keyCode"
- type: enumeration/BUTTON
+ - position: 1
+ name: "keyCode"
+ type: enumeration/BUTTON
returns:
- type: boolean
description: "Whether the key was released."
diff --git a/docs/libraries/Inputs/WasKeyTyped.md b/docs/libraries/Inputs/WasKeyTyped.md
index 76518a1468..91c5b8ecd9 100644
--- a/docs/libraries/Inputs/WasKeyTyped.md
+++ b/docs/libraries/Inputs/WasKeyTyped.md
@@ -14,8 +14,9 @@ lua:
description: "Check if a specific key was typed."
arguments:
- - name: "keyCode"
- type: enumeration/BUTTON
+ - position: 1
+ name: "keyCode"
+ type: enumeration/BUTTON
returns:
- type: boolean
description: "Whether the key was typed."
diff --git a/docs/libraries/Inputs/WasMouseDoublePressed.md b/docs/libraries/Inputs/WasMouseDoublePressed.md
index 1f9adb68fe..9588c00ff6 100644
--- a/docs/libraries/Inputs/WasMouseDoublePressed.md
+++ b/docs/libraries/Inputs/WasMouseDoublePressed.md
@@ -14,8 +14,9 @@ lua:
description: "Check if a specific mouse button was double pressed."
arguments:
- - name: "mouseCode"
- type: enumeration/BUTTON
+ - position: 1
+ name: "mouseCode"
+ type: enumeration/BUTTON
returns:
- type: boolean
description: "Whether the mouse button was double pressed."
diff --git a/docs/libraries/Inputs/WasMousePressed.md b/docs/libraries/Inputs/WasMousePressed.md
index 73e2e3928a..e2a2e7faf2 100644
--- a/docs/libraries/Inputs/WasMousePressed.md
+++ b/docs/libraries/Inputs/WasMousePressed.md
@@ -14,8 +14,9 @@ lua:
description: "Check if a specific mouse button was pressed."
arguments:
- - name: "mouseCode"
- type: enumeration/BUTTON
+ - position: 1
+ name: "mouseCode"
+ type: enumeration/BUTTON
returns:
- type: boolean
description: "Whether the mouse button was pressed."
diff --git a/docs/libraries/Inputs/WasMouseReleased.md b/docs/libraries/Inputs/WasMouseReleased.md
index 1877ed862a..9eee85e0ab 100644
--- a/docs/libraries/Inputs/WasMouseReleased.md
+++ b/docs/libraries/Inputs/WasMouseReleased.md
@@ -14,8 +14,9 @@ lua:
description: "Check if a specific mouse button was released."
arguments:
- - name: "mouseCode"
- type: enumeration/BUTTON
+ - position: 1
+ name: "mouseCode"
+ type: enumeration/BUTTON
returns:
- type: boolean
description: "Whether the mouse button was released."
diff --git a/docs/libraries/KeyValues/Create.md b/docs/libraries/KeyValues/Create.md
index 7634d42266..3f6a273a1a 100644
--- a/docs/libraries/KeyValues/Create.md
+++ b/docs/libraries/KeyValues/Create.md
@@ -13,40 +13,44 @@ lua:
realm: shared
description: "Create a new keyvalues object."
- argumentSets:
- - arguments:
- - name: "name"
- type: string
- - name: "firstKey"
- type: string
- nillable: true
+ arguments:
+ - position: 1
+ name: "name"
+ type: string
+ - position: 2
+ name: "firstKey"
+ type: string
+ nillable: true
+ - position: 3
+ types:
- name: "firstValue"
type: number
- nillable: true
- - arguments:
+ nillable: true
- name: "firstValue"
type: string
- nillable: true
- - arguments:
+ nillable: true
- name: "firstValue"
type: number
- nillable: true
- - name: "secondKey"
- type: string
- nillable: true
- - name: "secondValue"
- type: number
- nillable: true
- - arguments:
+ nillable: true
- name: "firstValue"
type: string
- nillable: true
+ nillable: true
+ - position: 4
+ types:
+ - name: "secondKey"
+ type: string
+ nillable: true
- name: "secondKey"
type: string
- nillable: true
+ nillable: true
+ - position: 5
+ types:
+ - name: "secondValue"
+ type: number
+ nillable: true
- name: "secondValue"
type: string
- nillable: true
+ nillable: true
returns:
- type: KeyValuesHandle
description: "The new keyvalues object."
diff --git a/docs/libraries/KeyValues/CreateFromTable.md b/docs/libraries/KeyValues/CreateFromTable.md
new file mode 100644
index 0000000000..9d3ac1df2e
--- /dev/null
+++ b/docs/libraries/KeyValues/CreateFromTable.md
@@ -0,0 +1,30 @@
+---
+template: lua-library-function.html
+title: CreateFromTable
+icon: lua-shared
+tags:
+ - lua
+ - shared
+ - needs-verification
+ - needs-example
+lua:
+ library: KeyValues
+ function: CreateFromTable
+ realm: shared
+ description: "Create a new keyvalues object from a table."
+
+ arguments:
+ - position: 1
+ name: "name"
+ type: string
+ - position: 2
+ name: "table"
+ type: table
+ returns:
+ - type: KeyValuesHandle
+ description: "The new keyvalues object."
+---
+
+
+KeyValues.CreateFromTable – Create a new keyvalues object from a table.
+
diff --git a/docs/libraries/Localizations/AddString.md b/docs/libraries/Localizations/AddString.md
index 5a11910b04..cab982c2c3 100644
--- a/docs/libraries/Localizations/AddString.md
+++ b/docs/libraries/Localizations/AddString.md
@@ -14,10 +14,12 @@ lua:
description: "Adds a localized string."
arguments:
- - name: "string"
- type: string
- - name: "string"
- type: string
+ - position: 1
+ name: "string"
+ type: string
+ - position: 2
+ name: "string"
+ type: string
returns:
---
diff --git a/docs/libraries/Localizations/Find.md b/docs/libraries/Localizations/Find.md
index 399811ee09..70a7ef7b92 100644
--- a/docs/libraries/Localizations/Find.md
+++ b/docs/libraries/Localizations/Find.md
@@ -14,8 +14,9 @@ lua:
description: "Finds a localized string."
arguments:
- - name: "string"
- type: string
+ - position: 1
+ name: "string"
+ type: string
returns:
- type: string
description: "Returns the localized string."
diff --git a/docs/libraries/Materials/Create.md b/docs/libraries/Materials/Create.md
index eb96af3c30..d32c622880 100644
--- a/docs/libraries/Materials/Create.md
+++ b/docs/libraries/Materials/Create.md
@@ -14,13 +14,16 @@ lua:
description: "Creates a material"
arguments:
- - name: "name"
- type: string
- - name: "shaderName"
- type: string
- - name: "materialData"
- type: table
- nillable: true
+ - position: 1
+ name: "name"
+ type: string
+ - position: 2
+ name: "shaderName"
+ type: string
+ - position: 3
+ name: "materialData"
+ type: table
+ nillable: true
returns:
- type: Material
description: "The material (or nil if it could not be created)"
diff --git a/docs/libraries/Materials/Exists.md b/docs/libraries/Materials/Exists.md
index 320c06c69e..a19eb71a34 100644
--- a/docs/libraries/Materials/Exists.md
+++ b/docs/libraries/Materials/Exists.md
@@ -14,8 +14,9 @@ lua:
description: "Checks if a material exists. TODO: This is likely not working correctly"
arguments:
- - name: "name"
- type: string
+ - position: 1
+ name: "name"
+ type: string
returns:
- type: boolean
description: "True if the material exists, false otherwise."
diff --git a/docs/libraries/Materials/Find.md b/docs/libraries/Materials/Find.md
index 909fb5ef20..b12b2ff2f6 100644
--- a/docs/libraries/Materials/Find.md
+++ b/docs/libraries/Materials/Find.md
@@ -14,11 +14,13 @@ lua:
description: "Finds a material"
arguments:
- - name: "name"
- type: string
- - name: "parameters"
- type: string
- default: "\"\""
+ - position: 1
+ name: "name"
+ type: string
+ - position: 2
+ name: "parameters"
+ type: string
+ default: "\"\""
returns:
- type: Material
description: "The material"
diff --git a/docs/libraries/Matrixes/CalculateAabbFromProjectionMatrix.md b/docs/libraries/Matrixes/CalculateAabbFromProjectionMatrix.md
new file mode 100644
index 0000000000..0ebf84e7d4
--- /dev/null
+++ b/docs/libraries/Matrixes/CalculateAabbFromProjectionMatrix.md
@@ -0,0 +1,29 @@
+---
+template: lua-library-function.html
+title: CalculateAabbFromProjectionMatrix
+icon: lua-shared
+tags:
+ - lua
+ - shared
+ - needs-verification
+ - needs-example
+lua:
+ library: Matrixes
+ function: CalculateAabbFromProjectionMatrix
+ realm: shared
+ description: "Calculates an AABB from a projection matrix."
+
+ arguments:
+ - position: 1
+ name: "Matrix"
+ type: Matrix
+ returns:
+ - type: Vector
+ description: "The minimum vector."
+ - type: Vector
+ description: "The maximum vector."
+---
+
+
+Matrixes.CalculateAabbFromProjectionMatrix – Calculates an AABB from a projection matrix.
+
diff --git a/docs/libraries/Matrixes/CalculateSphereFromProjectionMatrix.md b/docs/libraries/Matrixes/CalculateSphereFromProjectionMatrix.md
new file mode 100644
index 0000000000..3a5cc66bca
--- /dev/null
+++ b/docs/libraries/Matrixes/CalculateSphereFromProjectionMatrix.md
@@ -0,0 +1,29 @@
+---
+template: lua-library-function.html
+title: CalculateSphereFromProjectionMatrix
+icon: lua-shared
+tags:
+ - lua
+ - shared
+ - needs-verification
+ - needs-example
+lua:
+ library: Matrixes
+ function: CalculateSphereFromProjectionMatrix
+ realm: shared
+ description: "Calculates a sphere from a projection matrix."
+
+ arguments:
+ - position: 1
+ name: "Matrix"
+ type: Matrix
+ returns:
+ - type: Vector
+ description: "The center vector."
+ - type: number
+ description: "The radius."
+---
+
+
+Matrixes.CalculateSphereFromProjectionMatrix – Calculates a sphere from a projection matrix.
+
diff --git a/docs/libraries/Matrixes/Create.md b/docs/libraries/Matrixes/Create.md
new file mode 100644
index 0000000000..f4ea0147f2
--- /dev/null
+++ b/docs/libraries/Matrixes/Create.md
@@ -0,0 +1,87 @@
+---
+template: lua-library-function.html
+title: Create
+icon: lua-shared
+tags:
+ - lua
+ - shared
+ - needs-verification
+ - needs-example
+lua:
+ library: Matrixes
+ function: Create
+ realm: shared
+ description: "Creates a new matrix."
+
+ arguments:
+ - position: 1
+ types:
+ - name: "m11"
+ type: number
+ - name: "Matrix3x4"
+ type: Matrix3x4
+ nillable: true
+ - name: "xAxis"
+ type: Vector
+ nillable: true
+ - position: 2
+ types:
+ - name: "m12"
+ type: number
+ - name: "yAxis"
+ type: Vector
+ nillable: true
+ - position: 3
+ types:
+ - name: "m13"
+ type: number
+ - name: "zAxis"
+ type: Vector
+ nillable: true
+ - position: 4
+ name: "m14"
+ type: number
+ - position: 5
+ name: "m21"
+ type: number
+ - position: 6
+ name: "m22"
+ type: number
+ - position: 7
+ name: "m23"
+ type: number
+ - position: 8
+ name: "m24"
+ type: number
+ - position: 9
+ name: "m31"
+ type: number
+ - position: 10
+ name: "m32"
+ type: number
+ - position: 11
+ name: "m33"
+ type: number
+ - position: 12
+ name: "m34"
+ type: number
+ - position: 13
+ name: "m41"
+ type: number
+ - position: 14
+ name: "m42"
+ type: number
+ - position: 15
+ name: "m43"
+ type: number
+ - position: 16
+ name: "m44"
+ type: number
+ returns:
+ - type: Matrix
+ description: "The created matrix."
+---
+
+
+Matrixes.Create – Creates a new matrix.
+
diff --git a/docs/libraries/Matrixes/Create3x4.md b/docs/libraries/Matrixes/Create3x4.md
new file mode 100644
index 0000000000..71f1caa38a
--- /dev/null
+++ b/docs/libraries/Matrixes/Create3x4.md
@@ -0,0 +1,76 @@
+---
+template: lua-library-function.html
+title: Create3x4
+icon: lua-shared
+tags:
+ - lua
+ - shared
+ - needs-verification
+ - needs-example
+lua:
+ library: Matrixes
+ function: Create3x4
+ realm: shared
+ description: "Creates a new 3x4 matrix."
+
+ arguments:
+ - position: 1
+ types:
+ - name: "m11"
+ type: number
+ - name: "xAxis"
+ type: Vector
+ nillable: true
+ - position: 2
+ types:
+ - name: "m12"
+ type: number
+ - name: "yAxis"
+ type: Vector
+ nillable: true
+ - position: 3
+ types:
+ - name: "m13"
+ type: number
+ - name: "zAxis"
+ type: Vector
+ nillable: true
+ - position: 4
+ types:
+ - name: "m14"
+ type: number
+ - name: "origin"
+ type: Vector
+ nillable: true
+ - position: 5
+ name: "m21"
+ type: number
+ - position: 6
+ name: "m22"
+ type: number
+ - position: 7
+ name: "m23"
+ type: number
+ - position: 8
+ name: "m24"
+ type: number
+ - position: 9
+ name: "m31"
+ type: number
+ - position: 10
+ name: "m32"
+ type: number
+ - position: 11
+ name: "m33"
+ type: number
+ - position: 12
+ name: "m34"
+ type: number
+ returns:
+ - type: Matrix3x4
+ description: "The created 3x4 matrix."
+---
+
+
+Matrixes.Create3x4 – Creates a new 3x4 matrix.
+
diff --git a/docs/libraries/Matrixes/CreateIdentityMatrix.md b/docs/libraries/Matrixes/CreateIdentityMatrix.md
new file mode 100644
index 0000000000..18000ff4eb
--- /dev/null
+++ b/docs/libraries/Matrixes/CreateIdentityMatrix.md
@@ -0,0 +1,25 @@
+---
+template: lua-library-function.html
+title: CreateIdentityMatrix
+icon: lua-shared
+tags:
+ - lua
+ - shared
+ - needs-verification
+ - needs-example
+lua:
+ library: Matrixes
+ function: CreateIdentityMatrix
+ realm: shared
+ description: "Sets the matrix to the identity matrix."
+
+ arguments:
+
+ returns:
+ - type: Matrix
+ description: "The created identity matrix."
+---
+
+
+Matrixes.CreateIdentityMatrix – Sets the matrix to the identity matrix.
+
diff --git a/docs/libraries/Matrixes/CreateMatrixWithAngles.md b/docs/libraries/Matrixes/CreateMatrixWithAngles.md
new file mode 100644
index 0000000000..76c29c4377
--- /dev/null
+++ b/docs/libraries/Matrixes/CreateMatrixWithAngles.md
@@ -0,0 +1,27 @@
+---
+template: lua-library-function.html
+title: CreateMatrixWithAngles
+icon: lua-shared
+tags:
+ - lua
+ - shared
+ - needs-verification
+ - needs-example
+lua:
+ library: Matrixes
+ function: CreateMatrixWithAngles
+ realm: shared
+ description: "Sets the matrix to a rotation matrix."
+
+ arguments:
+ - position: 1
+ name: "angle"
+ type: Angle
+ returns:
+ - type: Matrix
+ description: "The rotation matrix."
+---
+
+
+Matrixes.CreateMatrixWithAngles – Sets the matrix to a rotation matrix.
+
diff --git a/docs/libraries/Matrixes/CreateMatrixWithAxisAndRotation.md b/docs/libraries/Matrixes/CreateMatrixWithAxisAndRotation.md
new file mode 100644
index 0000000000..e77142d5e9
--- /dev/null
+++ b/docs/libraries/Matrixes/CreateMatrixWithAxisAndRotation.md
@@ -0,0 +1,30 @@
+---
+template: lua-library-function.html
+title: CreateMatrixWithAxisAndRotation
+icon: lua-shared
+tags:
+ - lua
+ - shared
+ - needs-verification
+ - needs-example
+lua:
+ library: Matrixes
+ function: CreateMatrixWithAxisAndRotation
+ realm: shared
+ description: "Sets the matrix to a rotation matrix."
+
+ arguments:
+ - position: 1
+ name: "vector"
+ type: Vector
+ - position: 2
+ name: "number"
+ type: number
+ returns:
+ - type: Matrix
+ description: "The rotation matrix."
+---
+
+
+Matrixes.CreateMatrixWithAxisAndRotation – Sets the matrix to a rotation matrix.
+
diff --git a/docs/libraries/Matrixes/CreateMatrixWithOriginAndAngles.md b/docs/libraries/Matrixes/CreateMatrixWithOriginAndAngles.md
new file mode 100644
index 0000000000..a572d636db
--- /dev/null
+++ b/docs/libraries/Matrixes/CreateMatrixWithOriginAndAngles.md
@@ -0,0 +1,30 @@
+---
+template: lua-library-function.html
+title: CreateMatrixWithOriginAndAngles
+icon: lua-shared
+tags:
+ - lua
+ - shared
+ - needs-verification
+ - needs-example
+lua:
+ library: Matrixes
+ function: CreateMatrixWithOriginAndAngles
+ realm: shared
+ description: "Sets the matrix to a matrix with the given origin and angles."
+
+ arguments:
+ - position: 1
+ name: "vector"
+ type: Vector
+ - position: 2
+ name: "angle"
+ type: Angle
+ returns:
+ - type: Matrix
+ description: "The matrix."
+---
+
+
+Matrixes.CreateMatrixWithOriginAndAngles – Sets the matrix to a matrix with the given origin and angles.
+
diff --git a/docs/libraries/Matrixes/CreateScaleMatrix.md b/docs/libraries/Matrixes/CreateScaleMatrix.md
new file mode 100644
index 0000000000..0fbc28fc8a
--- /dev/null
+++ b/docs/libraries/Matrixes/CreateScaleMatrix.md
@@ -0,0 +1,27 @@
+---
+template: lua-library-function.html
+title: CreateScaleMatrix
+icon: lua-shared
+tags:
+ - lua
+ - shared
+ - needs-verification
+ - needs-example
+lua:
+ library: Matrixes
+ function: CreateScaleMatrix
+ realm: shared
+ description: "Sets the matrix to a scale matrix."
+
+ arguments:
+ - position: 1
+ name: "vector"
+ type: Vector
+ returns:
+ - type: Matrix
+ description: "The created scaled matrix."
+---
+
+
+Matrixes.CreateScaleMatrix – Sets the matrix to a scale matrix.
+
diff --git a/docs/libraries/Matrixes/CreateTranslationMatrix.md b/docs/libraries/Matrixes/CreateTranslationMatrix.md
new file mode 100644
index 0000000000..22ca4120f2
--- /dev/null
+++ b/docs/libraries/Matrixes/CreateTranslationMatrix.md
@@ -0,0 +1,27 @@
+---
+template: lua-library-function.html
+title: CreateTranslationMatrix
+icon: lua-shared
+tags:
+ - lua
+ - shared
+ - needs-verification
+ - needs-example
+lua:
+ library: Matrixes
+ function: CreateTranslationMatrix
+ realm: shared
+ description: "Sets the matrix to a translation matrix."
+
+ arguments:
+ - position: 1
+ name: "vector"
+ type: Vector
+ returns:
+ - type: Matrix
+ description: "The translation matrix."
+---
+
+
+Matrixes.CreateTranslationMatrix – Sets the matrix to a translation matrix.
+
diff --git a/docs/libraries/Matrixes/MatrixBuildPerspective.md b/docs/libraries/Matrixes/MatrixBuildPerspective.md
new file mode 100644
index 0000000000..05fe39f29b
--- /dev/null
+++ b/docs/libraries/Matrixes/MatrixBuildPerspective.md
@@ -0,0 +1,38 @@
+---
+template: lua-library-function.html
+title: MatrixBuildPerspective
+icon: lua-shared
+tags:
+ - lua
+ - shared
+ - needs-verification
+ - needs-example
+lua:
+ library: Matrixes
+ function: MatrixBuildPerspective
+ realm: shared
+ description: "Builds a perspective matrix."
+
+ arguments:
+ - position: 1
+ name: "Matrix"
+ type: Matrix
+ - position: 2
+ name: "fovX"
+ type: number
+ - position: 3
+ name: "fovY"
+ type: number
+ - position: 4
+ name: "zNear"
+ type: number
+ - position: 5
+ name: "zFar"
+ type: number
+ returns:
+
+---
+
+
+Matrixes.MatrixBuildPerspective – Builds a perspective matrix.
+
diff --git a/docs/libraries/Matrixes/MatrixBuildRotateZ.md b/docs/libraries/Matrixes/MatrixBuildRotateZ.md
new file mode 100644
index 0000000000..5d92c5f7f6
--- /dev/null
+++ b/docs/libraries/Matrixes/MatrixBuildRotateZ.md
@@ -0,0 +1,29 @@
+---
+template: lua-library-function.html
+title: MatrixBuildRotateZ
+icon: lua-shared
+tags:
+ - lua
+ - shared
+ - needs-verification
+ - needs-example
+lua:
+ library: Matrixes
+ function: MatrixBuildRotateZ
+ realm: shared
+ description: "Builds a rotation matrix."
+
+ arguments:
+ - position: 1
+ name: "Matrix"
+ type: Matrix
+ - position: 2
+ name: "degrees"
+ type: number
+ returns:
+
+---
+
+
+Matrixes.MatrixBuildRotateZ – Builds a rotation matrix.
+
diff --git a/docs/libraries/Matrixes/MatrixBuildRotation.md b/docs/libraries/Matrixes/MatrixBuildRotation.md
new file mode 100644
index 0000000000..bdc5685446
--- /dev/null
+++ b/docs/libraries/Matrixes/MatrixBuildRotation.md
@@ -0,0 +1,32 @@
+---
+template: lua-library-function.html
+title: MatrixBuildRotation
+icon: lua-shared
+tags:
+ - lua
+ - shared
+ - needs-verification
+ - needs-example
+lua:
+ library: Matrixes
+ function: MatrixBuildRotation
+ realm: shared
+ description: "Builds a rotation matrix."
+
+ arguments:
+ - position: 1
+ name: "Matrix"
+ type: Matrix
+ - position: 2
+ name: "vector"
+ type: Vector
+ - position: 3
+ name: "vector"
+ type: Vector
+ returns:
+
+---
+
+
+Matrixes.MatrixBuildRotation – Builds a rotation matrix.
+
diff --git a/docs/libraries/Matrixes/MatrixBuildRotationAboutAxis.md b/docs/libraries/Matrixes/MatrixBuildRotationAboutAxis.md
new file mode 100644
index 0000000000..413114ab59
--- /dev/null
+++ b/docs/libraries/Matrixes/MatrixBuildRotationAboutAxis.md
@@ -0,0 +1,32 @@
+---
+template: lua-library-function.html
+title: MatrixBuildRotationAboutAxis
+icon: lua-shared
+tags:
+ - lua
+ - shared
+ - needs-verification
+ - needs-example
+lua:
+ library: Matrixes
+ function: MatrixBuildRotationAboutAxis
+ realm: shared
+ description: "Builds a rotation matrix."
+
+ arguments:
+ - position: 1
+ name: "Matrix"
+ type: Matrix
+ - position: 2
+ name: "axisOfRotation"
+ type: Vector
+ - position: 3
+ name: "degrees"
+ type: number
+ returns:
+
+---
+
+
+Matrixes.MatrixBuildRotationAboutAxis – Builds a rotation matrix.
+
diff --git a/docs/libraries/Matrixes/MatrixBuildScale.md b/docs/libraries/Matrixes/MatrixBuildScale.md
new file mode 100644
index 0000000000..1b5d15b326
--- /dev/null
+++ b/docs/libraries/Matrixes/MatrixBuildScale.md
@@ -0,0 +1,38 @@
+---
+template: lua-library-function.html
+title: MatrixBuildScale
+icon: lua-shared
+tags:
+ - lua
+ - shared
+ - needs-verification
+ - needs-example
+lua:
+ library: Matrixes
+ function: MatrixBuildScale
+ realm: shared
+ description: "Builds a scale matrix."
+
+ arguments:
+ - position: 1
+ name: "Matrix"
+ type: Matrix
+ - position: 2
+ types:
+ - name: "x"
+ type: number
+ - name: "scale"
+ type: Vector
+ - position: 3
+ name: "y"
+ type: number
+ - position: 4
+ name: "z"
+ type: number
+ returns:
+
+---
+
+
+Matrixes.MatrixBuildScale – Builds a scale matrix.
+
diff --git a/docs/libraries/Matrixes/MatrixBuildTranslation.md b/docs/libraries/Matrixes/MatrixBuildTranslation.md
new file mode 100644
index 0000000000..ec0a8a3ce5
--- /dev/null
+++ b/docs/libraries/Matrixes/MatrixBuildTranslation.md
@@ -0,0 +1,38 @@
+---
+template: lua-library-function.html
+title: MatrixBuildTranslation
+icon: lua-shared
+tags:
+ - lua
+ - shared
+ - needs-verification
+ - needs-example
+lua:
+ library: Matrixes
+ function: MatrixBuildTranslation
+ realm: shared
+ description: "Builds a translation matrix."
+
+ arguments:
+ - position: 1
+ name: "Matrix"
+ type: Matrix
+ - position: 2
+ types:
+ - name: "x"
+ type: number
+ - name: "translation"
+ type: Vector
+ - position: 3
+ name: "y"
+ type: number
+ - position: 4
+ name: "z"
+ type: number
+ returns:
+
+---
+
+
+Matrixes.MatrixBuildTranslation – Builds a translation matrix.
+
diff --git a/docs/libraries/Matrixes/MatrixCopy.md b/docs/libraries/Matrixes/MatrixCopy.md
new file mode 100644
index 0000000000..185124d9dc
--- /dev/null
+++ b/docs/libraries/Matrixes/MatrixCopy.md
@@ -0,0 +1,27 @@
+---
+template: lua-library-function.html
+title: MatrixCopy
+icon: lua-shared
+tags:
+ - lua
+ - shared
+ - needs-verification
+ - needs-example
+lua:
+ library: Matrixes
+ function: MatrixCopy
+ realm: shared
+ description: "Copies the matrix."
+
+ arguments:
+ - position: 1
+ name: "Matrix"
+ type: Matrix
+ returns:
+ - type: Matrix
+ description: "The copied matrix."
+---
+
+
+Matrixes.MatrixCopy – Copies the matrix.
+
diff --git a/docs/libraries/Matrixes/MatrixFromAngles.md b/docs/libraries/Matrixes/MatrixFromAngles.md
new file mode 100644
index 0000000000..e00a860395
--- /dev/null
+++ b/docs/libraries/Matrixes/MatrixFromAngles.md
@@ -0,0 +1,29 @@
+---
+template: lua-library-function.html
+title: MatrixFromAngles
+icon: lua-shared
+tags:
+ - lua
+ - shared
+ - needs-verification
+ - needs-example
+lua:
+ library: Matrixes
+ function: MatrixFromAngles
+ realm: shared
+ description: "Sets the matrix to a rotation matrix."
+
+ arguments:
+ - position: 1
+ name: "angle"
+ type: Angle
+ - position: 2
+ name: "Matrix"
+ type: Matrix
+ returns:
+
+---
+
+
+Matrixes.MatrixFromAngles – Sets the matrix to a rotation matrix.
+
diff --git a/docs/libraries/Matrixes/MatrixGetColumn.md b/docs/libraries/Matrixes/MatrixGetColumn.md
new file mode 100644
index 0000000000..3aabb95463
--- /dev/null
+++ b/docs/libraries/Matrixes/MatrixGetColumn.md
@@ -0,0 +1,30 @@
+---
+template: lua-library-function.html
+title: MatrixGetColumn
+icon: lua-shared
+tags:
+ - lua
+ - shared
+ - needs-verification
+ - needs-example
+lua:
+ library: Matrixes
+ function: MatrixGetColumn
+ realm: shared
+ description: "Gets a column of the matrix."
+
+ arguments:
+ - position: 1
+ name: "Matrix"
+ type: Matrix
+ - position: 2
+ name: "column"
+ type: number
+ returns:
+ - type: Vector
+ description: "The column vector."
+---
+
+
+Matrixes.MatrixGetColumn – Gets a column of the matrix.
+
diff --git a/docs/libraries/Matrixes/MatrixGetRow.md b/docs/libraries/Matrixes/MatrixGetRow.md
new file mode 100644
index 0000000000..f10c84a6b0
--- /dev/null
+++ b/docs/libraries/Matrixes/MatrixGetRow.md
@@ -0,0 +1,30 @@
+---
+template: lua-library-function.html
+title: MatrixGetRow
+icon: lua-shared
+tags:
+ - lua
+ - shared
+ - needs-verification
+ - needs-example
+lua:
+ library: Matrixes
+ function: MatrixGetRow
+ realm: shared
+ description: "Gets a row of the matrix."
+
+ arguments:
+ - position: 1
+ name: "Matrix"
+ type: Matrix
+ - position: 2
+ name: "row"
+ type: number
+ returns:
+ - type: Vector
+ description: "The row vector."
+---
+
+
+Matrixes.MatrixGetRow – Gets a row of the matrix.
+
diff --git a/docs/libraries/Matrixes/MatrixInverseGeneral.md b/docs/libraries/Matrixes/MatrixInverseGeneral.md
new file mode 100644
index 0000000000..a0084da30b
--- /dev/null
+++ b/docs/libraries/Matrixes/MatrixInverseGeneral.md
@@ -0,0 +1,29 @@
+---
+template: lua-library-function.html
+title: MatrixInverseGeneral
+icon: lua-shared
+tags:
+ - lua
+ - shared
+ - needs-verification
+ - needs-example
+lua:
+ library: Matrixes
+ function: MatrixInverseGeneral
+ realm: shared
+ description: "Inverts the matrix."
+
+ arguments:
+ - position: 1
+ name: "Matrix"
+ type: Matrix
+ - position: 2
+ name: "Matrix"
+ type: Matrix
+ returns:
+
+---
+
+
+Matrixes.MatrixInverseGeneral – Inverts the matrix.
+
diff --git a/docs/libraries/Matrixes/MatrixInverseTranslation.md b/docs/libraries/Matrixes/MatrixInverseTranslation.md
new file mode 100644
index 0000000000..036b204421
--- /dev/null
+++ b/docs/libraries/Matrixes/MatrixInverseTranslation.md
@@ -0,0 +1,29 @@
+---
+template: lua-library-function.html
+title: MatrixInverseTranslation
+icon: lua-shared
+tags:
+ - lua
+ - shared
+ - needs-verification
+ - needs-example
+lua:
+ library: Matrixes
+ function: MatrixInverseTranslation
+ realm: shared
+ description: "Inverts the matrix."
+
+ arguments:
+ - position: 1
+ name: "Matrix"
+ type: Matrix
+ - position: 2
+ name: "Matrix"
+ type: Matrix
+ returns:
+
+---
+
+
+Matrixes.MatrixInverseTranslation – Inverts the matrix.
+
diff --git a/docs/libraries/Matrixes/MatrixInverseTranspose.md b/docs/libraries/Matrixes/MatrixInverseTranspose.md
new file mode 100644
index 0000000000..9c9d224754
--- /dev/null
+++ b/docs/libraries/Matrixes/MatrixInverseTranspose.md
@@ -0,0 +1,29 @@
+---
+template: lua-library-function.html
+title: MatrixInverseTranspose
+icon: lua-shared
+tags:
+ - lua
+ - shared
+ - needs-verification
+ - needs-example
+lua:
+ library: Matrixes
+ function: MatrixInverseTranspose
+ realm: shared
+ description: "Inverts the matrix."
+
+ arguments:
+ - position: 1
+ name: "Matrix"
+ type: Matrix
+ - position: 2
+ name: "Matrix"
+ type: Matrix
+ returns:
+
+---
+
+
+Matrixes.MatrixInverseTranspose – Inverts the matrix.
+
diff --git a/docs/libraries/Matrixes/MatrixRotate.md b/docs/libraries/Matrixes/MatrixRotate.md
new file mode 100644
index 0000000000..2a7711abf3
--- /dev/null
+++ b/docs/libraries/Matrixes/MatrixRotate.md
@@ -0,0 +1,32 @@
+---
+template: lua-library-function.html
+title: MatrixRotate
+icon: lua-shared
+tags:
+ - lua
+ - shared
+ - needs-verification
+ - needs-example
+lua:
+ library: Matrixes
+ function: MatrixRotate
+ realm: shared
+ description: "Rotates the matrix."
+
+ arguments:
+ - position: 1
+ name: "Matrix"
+ type: Matrix
+ - position: 2
+ name: "axisOfRotation"
+ type: Vector
+ - position: 3
+ name: "degrees"
+ type: number
+ returns:
+
+---
+
+
+Matrixes.MatrixRotate – Rotates the matrix.
+
diff --git a/docs/libraries/Matrixes/MatrixSetColumn.md b/docs/libraries/Matrixes/MatrixSetColumn.md
new file mode 100644
index 0000000000..6195d6f414
--- /dev/null
+++ b/docs/libraries/Matrixes/MatrixSetColumn.md
@@ -0,0 +1,32 @@
+---
+template: lua-library-function.html
+title: MatrixSetColumn
+icon: lua-shared
+tags:
+ - lua
+ - shared
+ - needs-verification
+ - needs-example
+lua:
+ library: Matrixes
+ function: MatrixSetColumn
+ realm: shared
+ description: "Sets a column of the matrix."
+
+ arguments:
+ - position: 1
+ name: "Matrix"
+ type: Matrix
+ - position: 2
+ name: "column"
+ type: number
+ - position: 3
+ name: "vector"
+ type: Vector
+ returns:
+
+---
+
+
+Matrixes.MatrixSetColumn – Sets a column of the matrix.
+
diff --git a/docs/libraries/Matrixes/MatrixSetIdentity.md b/docs/libraries/Matrixes/MatrixSetIdentity.md
new file mode 100644
index 0000000000..358646190a
--- /dev/null
+++ b/docs/libraries/Matrixes/MatrixSetIdentity.md
@@ -0,0 +1,26 @@
+---
+template: lua-library-function.html
+title: MatrixSetIdentity
+icon: lua-shared
+tags:
+ - lua
+ - shared
+ - needs-verification
+ - needs-example
+lua:
+ library: Matrixes
+ function: MatrixSetIdentity
+ realm: shared
+ description: "Sets the matrix to the identity matrix."
+
+ arguments:
+ - position: 1
+ name: "Matrix"
+ type: Matrix
+ returns:
+
+---
+
+
+Matrixes.MatrixSetIdentity – Sets the matrix to the identity matrix.
+
diff --git a/docs/libraries/Matrixes/MatrixSetRow.md b/docs/libraries/Matrixes/MatrixSetRow.md
new file mode 100644
index 0000000000..492c41ca07
--- /dev/null
+++ b/docs/libraries/Matrixes/MatrixSetRow.md
@@ -0,0 +1,32 @@
+---
+template: lua-library-function.html
+title: MatrixSetRow
+icon: lua-shared
+tags:
+ - lua
+ - shared
+ - needs-verification
+ - needs-example
+lua:
+ library: Matrixes
+ function: MatrixSetRow
+ realm: shared
+ description: "Sets a row of the matrix."
+
+ arguments:
+ - position: 1
+ name: "Matrix"
+ type: Matrix
+ - position: 2
+ name: "row"
+ type: number
+ - position: 3
+ name: "vector"
+ type: Vector
+ returns:
+
+---
+
+
+Matrixes.MatrixSetRow – Sets a row of the matrix.
+
diff --git a/docs/libraries/Matrixes/MatrixToAngles.md b/docs/libraries/Matrixes/MatrixToAngles.md
new file mode 100644
index 0000000000..873a8a4075
--- /dev/null
+++ b/docs/libraries/Matrixes/MatrixToAngles.md
@@ -0,0 +1,29 @@
+---
+template: lua-library-function.html
+title: MatrixToAngles
+icon: lua-shared
+tags:
+ - lua
+ - shared
+ - needs-verification
+ - needs-example
+lua:
+ library: Matrixes
+ function: MatrixToAngles
+ realm: shared
+ description: "Sets the matrix to a rotation matrix."
+
+ arguments:
+ - position: 1
+ name: "Matrix"
+ type: Matrix
+ - position: 2
+ name: "angle"
+ type: Angle
+ returns:
+
+---
+
+
+Matrixes.MatrixToAngles – Sets the matrix to a rotation matrix.
+
diff --git a/docs/libraries/Matrixes/MatrixTranslate.md b/docs/libraries/Matrixes/MatrixTranslate.md
new file mode 100644
index 0000000000..84efaa5f0d
--- /dev/null
+++ b/docs/libraries/Matrixes/MatrixTranslate.md
@@ -0,0 +1,29 @@
+---
+template: lua-library-function.html
+title: MatrixTranslate
+icon: lua-shared
+tags:
+ - lua
+ - shared
+ - needs-verification
+ - needs-example
+lua:
+ library: Matrixes
+ function: MatrixTranslate
+ realm: shared
+ description: "Translates the matrix."
+
+ arguments:
+ - position: 1
+ name: "Matrix"
+ type: Matrix
+ - position: 2
+ name: "vector"
+ type: Vector
+ returns:
+
+---
+
+
+Matrixes.MatrixTranslate – Translates the matrix.
+
diff --git a/docs/libraries/Matrixes/Vector3dMultiply.md b/docs/libraries/Matrixes/Vector3dMultiply.md
new file mode 100644
index 0000000000..6800f55ec7
--- /dev/null
+++ b/docs/libraries/Matrixes/Vector3dMultiply.md
@@ -0,0 +1,30 @@
+---
+template: lua-library-function.html
+title: Vector3dMultiply
+icon: lua-shared
+tags:
+ - lua
+ - shared
+ - needs-verification
+ - needs-example
+lua:
+ library: Matrixes
+ function: Vector3dMultiply
+ realm: shared
+ description: "Multiplies a vector by the matrix."
+
+ arguments:
+ - position: 1
+ name: "Matrix"
+ type: Matrix
+ - position: 2
+ name: "vector"
+ type: Vector
+ returns:
+ - type: Vector
+ description: "The multiplied vector."
+---
+
+
+Matrixes.Vector3dMultiply – Multiplies a vector by the matrix.
+
diff --git a/docs/libraries/Matrixes/Vector3dMultiplyPositionProjective.md b/docs/libraries/Matrixes/Vector3dMultiplyPositionProjective.md
new file mode 100644
index 0000000000..ea6279aa91
--- /dev/null
+++ b/docs/libraries/Matrixes/Vector3dMultiplyPositionProjective.md
@@ -0,0 +1,30 @@
+---
+template: lua-library-function.html
+title: Vector3dMultiplyPositionProjective
+icon: lua-shared
+tags:
+ - lua
+ - shared
+ - needs-verification
+ - needs-example
+lua:
+ library: Matrixes
+ function: Vector3dMultiplyPositionProjective
+ realm: shared
+ description: "Multiplies a vector by the matrix."
+
+ arguments:
+ - position: 1
+ name: "Matrix"
+ type: Matrix
+ - position: 2
+ name: "vector"
+ type: Vector
+ returns:
+ - type: Vector
+ description: "The multiplied vector."
+---
+
+
+Matrixes.Vector3dMultiplyPositionProjective – Multiplies a vector by the matrix.
+
diff --git a/docs/libraries/Matrixes/Vector3dMultiplyProjective.md b/docs/libraries/Matrixes/Vector3dMultiplyProjective.md
new file mode 100644
index 0000000000..4168e61169
--- /dev/null
+++ b/docs/libraries/Matrixes/Vector3dMultiplyProjective.md
@@ -0,0 +1,30 @@
+---
+template: lua-library-function.html
+title: Vector3dMultiplyProjective
+icon: lua-shared
+tags:
+ - lua
+ - shared
+ - needs-verification
+ - needs-example
+lua:
+ library: Matrixes
+ function: Vector3dMultiplyProjective
+ realm: shared
+ description: "Multiplies a vector by the matrix."
+
+ arguments:
+ - position: 1
+ name: "Matrix"
+ type: Matrix
+ - position: 2
+ name: "vector"
+ type: Vector
+ returns:
+ - type: Vector
+ description: "The multiplied vector."
+---
+
+
+Matrixes.Vector3dMultiplyProjective – Multiplies a vector by the matrix.
+
diff --git a/docs/libraries/Matrixes/Vector3dMultiplyTranspose.md b/docs/libraries/Matrixes/Vector3dMultiplyTranspose.md
new file mode 100644
index 0000000000..100c6e188a
--- /dev/null
+++ b/docs/libraries/Matrixes/Vector3dMultiplyTranspose.md
@@ -0,0 +1,30 @@
+---
+template: lua-library-function.html
+title: Vector3dMultiplyTranspose
+icon: lua-shared
+tags:
+ - lua
+ - shared
+ - needs-verification
+ - needs-example
+lua:
+ library: Matrixes
+ function: Vector3dMultiplyTranspose
+ realm: shared
+ description: "Multiplies a vector by the matrix."
+
+ arguments:
+ - position: 1
+ name: "Matrix"
+ type: Matrix
+ - position: 2
+ name: "vector"
+ type: Vector
+ returns:
+ - type: Vector
+ description: "The multiplied vector."
+---
+
+
+Matrixes.Vector3dMultiplyTranspose – Multiplies a vector by the matrix.
+
diff --git a/docs/libraries/Matrixes/index.md b/docs/libraries/Matrixes/index.md
new file mode 100644
index 0000000000..b3248a3d59
--- /dev/null
+++ b/docs/libraries/Matrixes/index.md
@@ -0,0 +1,10 @@
+---
+template: lua-index.html
+childrenTitle: Functions
+include:
+ startsWith: libraries/Matrixes/
+exclude:
+ isIndex: true
+---
+
+# Matrixes
diff --git a/docs/libraries/MessageWriters/Create.md b/docs/libraries/MessageWriters/Create.md
new file mode 100644
index 0000000000..af9afc6d6a
--- /dev/null
+++ b/docs/libraries/MessageWriters/Create.md
@@ -0,0 +1,25 @@
+---
+template: lua-library-function.html
+title: Create
+icon: lua-shared
+tags:
+ - lua
+ - shared
+ - needs-verification
+ - needs-example
+lua:
+ library: MessageWriters
+ function: Create
+ realm: shared
+ description: "Creates a new MessageWriter for writing network messages"
+
+ arguments:
+
+ returns:
+ - type: MessageWriter
+ description: "The new MessageWriter"
+---
+
+
+MessageWriters.Create – Creates a new MessageWriter for writing network messages
+
diff --git a/docs/libraries/MessageWriters/index.md b/docs/libraries/MessageWriters/index.md
new file mode 100644
index 0000000000..3bd13ad0e3
--- /dev/null
+++ b/docs/libraries/MessageWriters/index.md
@@ -0,0 +1,10 @@
+---
+template: lua-index.html
+childrenTitle: Functions
+include:
+ startsWith: libraries/MessageWriters/
+exclude:
+ isIndex: true
+---
+
+# MessageWriters
diff --git a/docs/libraries/MoveHelpers/Create.md b/docs/libraries/MoveHelpers/Create.md
index 110edc1df1..2b729de17f 100644
--- a/docs/libraries/MoveHelpers/Create.md
+++ b/docs/libraries/MoveHelpers/Create.md
@@ -13,6 +13,7 @@ lua:
realm: shared
description: "Creates a new MoveHelper object"
+ arguments:
returns:
- type: MoveHelper
diff --git a/docs/libraries/NetworkStringTables/Create.md b/docs/libraries/NetworkStringTables/Create.md
deleted file mode 100644
index f735503090..0000000000
--- a/docs/libraries/NetworkStringTables/Create.md
+++ /dev/null
@@ -1,34 +0,0 @@
----
-template: lua-library-function.html
-title: Create
-icon: lua-shared
-tags:
- - lua
- - shared
- - needs-verification
- - needs-example
-lua:
- library: NetworkStringTables
- function: Create
- realm: shared
- description: "Create a new string table."
-
- arguments:
- - name: "name"
- type: string
- - name: "maxEntries"
- type: number
- - name: "userDataFixedSize"
- type: number
- default: "0"
- - name: "userDataNetworkBits"
- type: number
- default: "0"
- returns:
- - type: NetworkStringTable
- description: "The created string table."
----
-
-
-NetworkStringTables.Create – Create a new string table.
-
diff --git a/docs/libraries/NetworkStringTables/CreateExtended.md b/docs/libraries/NetworkStringTables/CreateExtended.md
deleted file mode 100644
index ec4745e357..0000000000
--- a/docs/libraries/NetworkStringTables/CreateExtended.md
+++ /dev/null
@@ -1,37 +0,0 @@
----
-template: lua-library-function.html
-title: CreateExtended
-icon: lua-shared
-tags:
- - lua
- - shared
- - needs-verification
- - needs-example
-lua:
- library: NetworkStringTables
- function: CreateExtended
- realm: shared
- description: "Create a new string table."
-
- arguments:
- - name: "name"
- type: string
- - name: "maxEntries"
- type: number
- - name: "userDataFixedSize"
- type: number
- default: "0"
- - name: "userDataNetworkBits"
- type: number
- default: "0"
- - name: "isFilenames"
- type: boolean
- default: "false"
- returns:
- - type: NetworkStringTable
- description: "The created string table."
----
-
-
-NetworkStringTables.CreateExtended – Create a new string table.
-
diff --git a/docs/libraries/NetworkStringTables/FindTable.md b/docs/libraries/NetworkStringTables/FindTable.md
index d10e332e26..eaf2ed94a7 100644
--- a/docs/libraries/NetworkStringTables/FindTable.md
+++ b/docs/libraries/NetworkStringTables/FindTable.md
@@ -14,8 +14,9 @@ lua:
description: "Find a string table by name."
arguments:
- - name: "name"
- type: string
+ - position: 1
+ name: "name"
+ type: string
returns:
- type: NetworkStringTable
description: "The found string table."
diff --git a/docs/libraries/NetworkStringTables/GetTable.md b/docs/libraries/NetworkStringTables/GetTable.md
index 3b04f6b200..a115e8cbcb 100644
--- a/docs/libraries/NetworkStringTables/GetTable.md
+++ b/docs/libraries/NetworkStringTables/GetTable.md
@@ -14,8 +14,9 @@ lua:
description: "Get a string table by index."
arguments:
- - name: "index"
- type: number
+ - position: 1
+ name: "index"
+ type: number
returns:
- type: NetworkStringTable
description: "The gotten string table."
diff --git a/docs/libraries/NetworkStringTables/GetTablesAmount.md b/docs/libraries/NetworkStringTables/GetTablesAmount.md
index 4226dd4712..ffa15b530d 100644
--- a/docs/libraries/NetworkStringTables/GetTablesAmount.md
+++ b/docs/libraries/NetworkStringTables/GetTablesAmount.md
@@ -13,6 +13,7 @@ lua:
realm: shared
description: "Get the number of string tables."
+ arguments:
returns:
- type: integer
diff --git a/docs/libraries/NetworkStringTables/RemoveAllTables.md b/docs/libraries/NetworkStringTables/RemoveAllTables.md
index c1bb9c70a4..0e48b4be17 100644
--- a/docs/libraries/NetworkStringTables/RemoveAllTables.md
+++ b/docs/libraries/NetworkStringTables/RemoveAllTables.md
@@ -13,6 +13,7 @@ lua:
realm: shared
description: "Remove all string tables."
+ arguments:
returns:
diff --git a/docs/libraries/NetworkStringTables/SetAllowClientSideAddString.md b/docs/libraries/NetworkStringTables/SetAllowClientSideAddString.md
index 16632d55e6..d4182fe5b7 100644
--- a/docs/libraries/NetworkStringTables/SetAllowClientSideAddString.md
+++ b/docs/libraries/NetworkStringTables/SetAllowClientSideAddString.md
@@ -14,10 +14,12 @@ lua:
description: "Set whether clients can add strings to a table."
arguments:
- - name: "networkStringTable"
- type: NetworkStringTable
- - name: "allow"
- type: boolean
+ - position: 1
+ name: "networkStringTable"
+ type: NetworkStringTable
+ - position: 2
+ name: "allow"
+ type: boolean
returns:
---
diff --git a/docs/libraries/Networks/InternalSendToClients.md b/docs/libraries/Networks/InternalSendToClients.md
new file mode 100644
index 0000000000..151e10c5c0
--- /dev/null
+++ b/docs/libraries/Networks/InternalSendToClients.md
@@ -0,0 +1,37 @@
+---
+template: lua-library-function.html
+title: InternalSendToClients
+icon: lua-server
+tags:
+ - lua
+ - server
+ - needs-verification
+ - needs-example
+lua:
+ library: Networks
+ function: InternalSendToClients
+ realm: server
+ description: "Send a message to the specified clients, or all"
+
+ arguments:
+ - position: 1
+ name: "messageTypeId"
+ type: number
+ - position: 2
+ name: "messageWriter"
+ type: MessageWriter
+ - position: 3
+ types:
+ - name: "clientOrClients"
+ type: table
+ nillable: true
+ - name: "clientOrClients"
+ type: Player
+ nillable: true
+ returns:
+
+---
+
+
+Networks.InternalSendToClients – Send a message to the specified clients, or all
+
diff --git a/docs/libraries/Networks/InternalSendToServer.md b/docs/libraries/Networks/InternalSendToServer.md
new file mode 100644
index 0000000000..6c794a1098
--- /dev/null
+++ b/docs/libraries/Networks/InternalSendToServer.md
@@ -0,0 +1,29 @@
+---
+template: lua-library-function.html
+title: InternalSendToServer
+icon: lua-client
+tags:
+ - lua
+ - client
+ - needs-verification
+ - needs-example
+lua:
+ library: Networks
+ function: InternalSendToServer
+ realm: client
+ description: "Send a message to the server"
+
+ arguments:
+ - position: 1
+ name: "messageTypeId"
+ type: number
+ - position: 2
+ name: "messageWriter"
+ type: MessageWriter
+ returns:
+
+---
+
+
+Networks.InternalSendToServer – Send a message to the server
+
diff --git a/docs/libraries/Panels/Button.md b/docs/libraries/Panels/Button.md
index 7ced809424..06241e449d 100644
--- a/docs/libraries/Panels/Button.md
+++ b/docs/libraries/Panels/Button.md
@@ -14,21 +14,26 @@ lua:
description: "Creates a new button"
arguments:
- - name: "parent"
- type: Panel
- default: "VGui_GetClientLuaRootPanel()"
- - name: "name"
- type: string
- default: "\"Button\""
- - name: "text"
- type: string
- default: "\"\""
- - name: "actionSignalTarget"
- type: Panel
- default: "0"
- - name: "cmd"
- type: string
- default: "0"
+ - position: 1
+ name: "parent"
+ type: Panel
+ default: "VGui_GetClientLuaRootPanel()"
+ - position: 2
+ name: "name"
+ type: string
+ default: "\"Button\""
+ - position: 3
+ name: "text"
+ type: string
+ default: "\"\""
+ - position: 4
+ name: "actionSignalTarget"
+ type: Panel
+ default: "0"
+ - position: 5
+ name: "cmd"
+ type: string
+ default: "0"
returns:
- type: Button
description: "The new button"
diff --git a/docs/libraries/Panels/CheckButton.md b/docs/libraries/Panels/CheckButton.md
index ba50ec744c..c508e388c9 100644
--- a/docs/libraries/Panels/CheckButton.md
+++ b/docs/libraries/Panels/CheckButton.md
@@ -14,15 +14,18 @@ lua:
description: "Creates a new CheckButton panel"
arguments:
- - name: "parent"
- type: Panel
- default: "VGui_GetClientLuaRootPanel()"
- - name: "name"
- type: string
- default: "\"CheckButton\""
- - name: "text"
- type: string
- default: "\"\""
+ - position: 1
+ name: "parent"
+ type: Panel
+ default: "VGui_GetClientLuaRootPanel()"
+ - position: 2
+ name: "name"
+ type: string
+ default: "\"CheckButton\""
+ - position: 3
+ name: "text"
+ type: string
+ default: "\"\""
returns:
- type: CheckButton
description: "The new CheckButton Panel"
diff --git a/docs/libraries/Panels/EditablePanel.md b/docs/libraries/Panels/EditablePanel.md
index cb296780ea..035af43852 100644
--- a/docs/libraries/Panels/EditablePanel.md
+++ b/docs/libraries/Panels/EditablePanel.md
@@ -14,12 +14,14 @@ lua:
description: "Creates a new editable panel"
arguments:
- - name: "parent"
- type: Panel
- default: "VGui_GetClientLuaRootPanel()"
- - name: "name"
- type: string
- default: "\"EditablePanel\""
+ - position: 1
+ name: "parent"
+ type: Panel
+ default: "VGui_GetClientLuaRootPanel()"
+ - position: 2
+ name: "name"
+ type: string
+ default: "\"EditablePanel\""
returns:
- type: EditablePanel
description: "The new editable panel"
diff --git a/docs/libraries/Panels/Frame.md b/docs/libraries/Panels/Frame.md
index 7d1db41c9b..cf67bbb80f 100644
--- a/docs/libraries/Panels/Frame.md
+++ b/docs/libraries/Panels/Frame.md
@@ -14,12 +14,14 @@ lua:
description: "Creates a new Frame panel"
arguments:
- - name: "parent"
- type: Panel
- default: "VGui_GetClientLuaRootPanel()"
- - name: "name"
- type: string
- default: "\"Frame\""
+ - position: 1
+ name: "parent"
+ type: Panel
+ default: "VGui_GetClientLuaRootPanel()"
+ - position: 2
+ name: "name"
+ type: string
+ default: "\"Frame\""
returns:
- type: Frame
description: "The new Frame Panel"
diff --git a/docs/libraries/Panels/GetClientLuaRootHudPanel.md b/docs/libraries/Panels/GetClientLuaRootHudPanel.md
new file mode 100644
index 0000000000..a94d1a25cb
--- /dev/null
+++ b/docs/libraries/Panels/GetClientLuaRootHudPanel.md
@@ -0,0 +1,24 @@
+---
+template: lua-library-function.html
+title: GetClientLuaRootHudPanel
+icon: lua-client
+tags:
+ - lua
+ - client
+ - needs-verification
+ - needs-example
+lua:
+ library: Panels
+ function: GetClientLuaRootHudPanel
+ realm: client
+ description: "Gets the client Lua root panel for the HUD"
+
+ arguments:
+
+ returns:
+
+---
+
+
+Panels.GetClientLuaRootHudPanel – Gets the client Lua root panel for the HUD
+
diff --git a/docs/libraries/Panels/GetClientLuaRootPanel.md b/docs/libraries/Panels/GetClientLuaRootPanel.md
index 1bcf7d74fa..8ac7532152 100644
--- a/docs/libraries/Panels/GetClientLuaRootPanel.md
+++ b/docs/libraries/Panels/GetClientLuaRootPanel.md
@@ -13,6 +13,7 @@ lua:
realm: client
description: "Gets the client Lua root panel"
+ arguments:
returns:
diff --git a/docs/libraries/Panels/GetGameUiPanel.md b/docs/libraries/Panels/GetGameUiPanel.md
index 293f53d5aa..5c1f36487d 100644
--- a/docs/libraries/Panels/GetGameUiPanel.md
+++ b/docs/libraries/Panels/GetGameUiPanel.md
@@ -13,6 +13,7 @@ lua:
realm: client
description: "Gets the game UI panel"
+ arguments:
returns:
diff --git a/docs/libraries/Panels/Html.md b/docs/libraries/Panels/Html.md
index e76fd181dc..861841fe08 100644
--- a/docs/libraries/Panels/Html.md
+++ b/docs/libraries/Panels/Html.md
@@ -14,18 +14,22 @@ lua:
description: "Creates a new HTML panel"
arguments:
- - name: "parent"
- type: Panel
- default: "VGui_GetClientLuaRootPanel()"
- - name: "name"
- type: string
- default: "\"Html\""
- - name: "shouldAllowJavaScript"
- type: boolean
- default: "false"
- - name: "popupWindow"
- type: boolean
- default: "false"
+ - position: 1
+ name: "parent"
+ type: Panel
+ default: "VGui_GetClientLuaRootPanel()"
+ - position: 2
+ name: "name"
+ type: string
+ default: "\"Html\""
+ - position: 3
+ name: "shouldAllowJavaScript"
+ type: boolean
+ default: "false"
+ - position: 4
+ name: "popupWindow"
+ type: boolean
+ default: "false"
returns:
- type: Html
description: "The new HTML Panel"
diff --git a/docs/libraries/Panels/Label.md b/docs/libraries/Panels/Label.md
index a7c3df78ee..bc77326b61 100644
--- a/docs/libraries/Panels/Label.md
+++ b/docs/libraries/Panels/Label.md
@@ -14,15 +14,18 @@ lua:
description: "Creates a new label"
arguments:
- - name: "parent"
- type: Panel
- default: "VGui_GetClientLuaRootPanel()"
- - name: "text"
- type: string
- default: "\"\""
- - name: "name"
- type: string
- default: "\"Label\""
+ - position: 1
+ name: "parent"
+ type: Panel
+ default: "VGui_GetClientLuaRootPanel()"
+ - position: 2
+ name: "text"
+ type: string
+ default: "\"\""
+ - position: 3
+ name: "name"
+ type: string
+ default: "\"Label\""
returns:
- type: Label
description: "The new label"
diff --git a/docs/libraries/Panels/ModelImagePanel.md b/docs/libraries/Panels/ModelImagePanel.md
index a44e29c0fe..c6c924fafa 100644
--- a/docs/libraries/Panels/ModelImagePanel.md
+++ b/docs/libraries/Panels/ModelImagePanel.md
@@ -14,12 +14,14 @@ lua:
description: "Creates a new model image panel"
arguments:
- - name: "parent"
- type: Panel
- default: "VGui_GetClientLuaRootPanel()"
- - name: "name"
- type: string
- default: "\"ModelImagePanel\""
+ - position: 1
+ name: "parent"
+ type: Panel
+ default: "VGui_GetClientLuaRootPanel()"
+ - position: 2
+ name: "name"
+ type: string
+ default: "\"ModelImagePanel\""
returns:
- type: ModelImagePanel
description: "The new model image panel"
diff --git a/docs/libraries/Panels/Panel.md b/docs/libraries/Panels/Panel.md
index 84af595745..4a8b14e65f 100644
--- a/docs/libraries/Panels/Panel.md
+++ b/docs/libraries/Panels/Panel.md
@@ -14,12 +14,14 @@ lua:
description: "Creates a new Panel object"
arguments:
- - name: "parent"
- type: Panel
- default: "VGui_GetClientLuaRootPanel()"
- - name: "name"
- type: string
- default: "\"Panel\""
+ - position: 1
+ name: "parent"
+ type: Panel
+ default: "VGui_GetClientLuaRootPanel()"
+ - position: 2
+ name: "name"
+ type: string
+ default: "\"Panel\""
returns:
---
diff --git a/docs/libraries/Panels/TextEntry.md b/docs/libraries/Panels/TextEntry.md
index 95c4dc8a98..88a97fa372 100644
--- a/docs/libraries/Panels/TextEntry.md
+++ b/docs/libraries/Panels/TextEntry.md
@@ -14,12 +14,14 @@ lua:
description: "Creates a new TextEntry panel"
arguments:
- - name: "parent"
- type: Panel
- default: "VGui_GetClientLuaRootPanel()"
- - name: "name"
- type: string
- default: "\"TextEntry\""
+ - position: 1
+ name: "parent"
+ type: Panel
+ default: "VGui_GetClientLuaRootPanel()"
+ - position: 2
+ name: "name"
+ type: string
+ default: "\"TextEntry\""
returns:
- type: TextEntry
description: "The new TextEntry Panel"
diff --git a/docs/libraries/ParticleSystems/Precache.md b/docs/libraries/ParticleSystems/Precache.md
index 1f1cd65e69..f688a4e50c 100644
--- a/docs/libraries/ParticleSystems/Precache.md
+++ b/docs/libraries/ParticleSystems/Precache.md
@@ -14,8 +14,9 @@ lua:
description: "Precache a particle system."
arguments:
- - name: "systemName"
- type: string
+ - position: 1
+ name: "systemName"
+ type: string
returns:
---
diff --git a/docs/libraries/ParticleSystems/ReadConfigFile.md b/docs/libraries/ParticleSystems/ReadConfigFile.md
index 294165a738..139112a31b 100644
--- a/docs/libraries/ParticleSystems/ReadConfigFile.md
+++ b/docs/libraries/ParticleSystems/ReadConfigFile.md
@@ -14,8 +14,9 @@ lua:
description: "Read a particle system config file, add it to the list of particle configs."
arguments:
- - name: "filePath"
- type: string
+ - position: 1
+ name: "filePath"
+ type: string
returns:
---
diff --git a/docs/libraries/PhysicsEnvironments/CleanupDeleteList.md b/docs/libraries/PhysicsEnvironments/CleanupDeleteList.md
index 96018c0b94..7d77dc5f45 100644
--- a/docs/libraries/PhysicsEnvironments/CleanupDeleteList.md
+++ b/docs/libraries/PhysicsEnvironments/CleanupDeleteList.md
@@ -13,6 +13,7 @@ lua:
realm: shared
description: "Cleanup delete list."
+ arguments:
returns:
diff --git a/docs/libraries/PhysicsEnvironments/ClearStats.md b/docs/libraries/PhysicsEnvironments/ClearStats.md
index ee9504c3a0..f474ea60f2 100644
--- a/docs/libraries/PhysicsEnvironments/ClearStats.md
+++ b/docs/libraries/PhysicsEnvironments/ClearStats.md
@@ -13,6 +13,7 @@ lua:
realm: shared
description: "Clears the physics stats."
+ arguments:
returns:
diff --git a/docs/libraries/PhysicsEnvironments/DebugCheckContacts.md b/docs/libraries/PhysicsEnvironments/DebugCheckContacts.md
index ec663bf5b8..0a28943cb5 100644
--- a/docs/libraries/PhysicsEnvironments/DebugCheckContacts.md
+++ b/docs/libraries/PhysicsEnvironments/DebugCheckContacts.md
@@ -13,6 +13,7 @@ lua:
realm: shared
description: "Debug check contacts."
+ arguments:
returns:
diff --git a/docs/libraries/PhysicsEnvironments/GetActiveObjectCount.md b/docs/libraries/PhysicsEnvironments/GetActiveObjectCount.md
index 54c7cac48f..d0c2c2cca8 100644
--- a/docs/libraries/PhysicsEnvironments/GetActiveObjectCount.md
+++ b/docs/libraries/PhysicsEnvironments/GetActiveObjectCount.md
@@ -13,6 +13,7 @@ lua:
realm: shared
description: "Get active object count."
+ arguments:
returns:
- type: integer
diff --git a/docs/libraries/PhysicsEnvironments/GetAirDensity.md b/docs/libraries/PhysicsEnvironments/GetAirDensity.md
index fac022812c..3000a6a788 100644
--- a/docs/libraries/PhysicsEnvironments/GetAirDensity.md
+++ b/docs/libraries/PhysicsEnvironments/GetAirDensity.md
@@ -13,6 +13,7 @@ lua:
realm: shared
description: "Get air density."
+ arguments:
returns:
- type: number
diff --git a/docs/libraries/PhysicsEnvironments/GetGravity.md b/docs/libraries/PhysicsEnvironments/GetGravity.md
index 451790b401..b9d44f5bf2 100644
--- a/docs/libraries/PhysicsEnvironments/GetGravity.md
+++ b/docs/libraries/PhysicsEnvironments/GetGravity.md
@@ -13,6 +13,7 @@ lua:
realm: shared
description: "Get gravity vector."
+ arguments:
returns:
- type: Vector
diff --git a/docs/libraries/PhysicsEnvironments/GetNextFrameTime.md b/docs/libraries/PhysicsEnvironments/GetNextFrameTime.md
index b31625082f..3fa886d1c4 100644
--- a/docs/libraries/PhysicsEnvironments/GetNextFrameTime.md
+++ b/docs/libraries/PhysicsEnvironments/GetNextFrameTime.md
@@ -13,6 +13,7 @@ lua:
realm: shared
description: "Get next frame time."
+ arguments:
returns:
- type: number
diff --git a/docs/libraries/PhysicsEnvironments/GetPerformanceSettings.md b/docs/libraries/PhysicsEnvironments/GetPerformanceSettings.md
index 16c77b0934..e498497bcd 100644
--- a/docs/libraries/PhysicsEnvironments/GetPerformanceSettings.md
+++ b/docs/libraries/PhysicsEnvironments/GetPerformanceSettings.md
@@ -13,6 +13,7 @@ lua:
realm: shared
description: "Get performance settings."
+ arguments:
returns:
- type: physics_performanceparams_t
diff --git a/docs/libraries/PhysicsEnvironments/GetSimulationTime.md b/docs/libraries/PhysicsEnvironments/GetSimulationTime.md
index c881c8fddf..4a9e7bb795 100644
--- a/docs/libraries/PhysicsEnvironments/GetSimulationTime.md
+++ b/docs/libraries/PhysicsEnvironments/GetSimulationTime.md
@@ -13,6 +13,7 @@ lua:
realm: shared
description: "Get simulation time."
+ arguments:
returns:
- type: number
diff --git a/docs/libraries/PhysicsEnvironments/GetSimulationTimestep.md b/docs/libraries/PhysicsEnvironments/GetSimulationTimestep.md
index c3b686c164..286bf876b5 100644
--- a/docs/libraries/PhysicsEnvironments/GetSimulationTimestep.md
+++ b/docs/libraries/PhysicsEnvironments/GetSimulationTimestep.md
@@ -13,6 +13,7 @@ lua:
realm: shared
description: "Get simulation timestep."
+ arguments:
returns:
- type: number
diff --git a/docs/libraries/PhysicsEnvironments/IsInSimulation.md b/docs/libraries/PhysicsEnvironments/IsInSimulation.md
index 6257122c56..51120f8377 100644
--- a/docs/libraries/PhysicsEnvironments/IsInSimulation.md
+++ b/docs/libraries/PhysicsEnvironments/IsInSimulation.md
@@ -13,6 +13,7 @@ lua:
realm: shared
description: "Check if in simulation."
+ arguments:
returns:
- type: boolean
diff --git a/docs/libraries/PhysicsEnvironments/PostRestore.md b/docs/libraries/PhysicsEnvironments/PostRestore.md
index 2639ca0ba1..c3a4b53554 100644
--- a/docs/libraries/PhysicsEnvironments/PostRestore.md
+++ b/docs/libraries/PhysicsEnvironments/PostRestore.md
@@ -13,6 +13,7 @@ lua:
realm: shared
description: "Post restore operations."
+ arguments:
returns:
diff --git a/docs/libraries/PhysicsEnvironments/ResetSimulationClock.md b/docs/libraries/PhysicsEnvironments/ResetSimulationClock.md
index 34f6d8703b..b058e358b6 100644
--- a/docs/libraries/PhysicsEnvironments/ResetSimulationClock.md
+++ b/docs/libraries/PhysicsEnvironments/ResetSimulationClock.md
@@ -13,6 +13,7 @@ lua:
realm: shared
description: "Reset the simulation clock."
+ arguments:
returns:
diff --git a/docs/libraries/PhysicsEnvironments/SetAirDensity.md b/docs/libraries/PhysicsEnvironments/SetAirDensity.md
index 21364ce59f..151f602435 100644
--- a/docs/libraries/PhysicsEnvironments/SetAirDensity.md
+++ b/docs/libraries/PhysicsEnvironments/SetAirDensity.md
@@ -14,8 +14,9 @@ lua:
description: "Set air density."
arguments:
- - name: "density"
- type: number
+ - position: 1
+ name: "density"
+ type: number
returns:
---
diff --git a/docs/libraries/PhysicsEnvironments/SetGravity.md b/docs/libraries/PhysicsEnvironments/SetGravity.md
index 738743e22e..75656d6457 100644
--- a/docs/libraries/PhysicsEnvironments/SetGravity.md
+++ b/docs/libraries/PhysicsEnvironments/SetGravity.md
@@ -14,8 +14,9 @@ lua:
description: "Set gravity."
arguments:
- - name: "gravity"
- type: Vector
+ - position: 1
+ name: "gravity"
+ type: Vector
returns:
---
diff --git a/docs/libraries/PhysicsEnvironments/SetPerformanceSettings.md b/docs/libraries/PhysicsEnvironments/SetPerformanceSettings.md
index 61f616c09a..806baa6b48 100644
--- a/docs/libraries/PhysicsEnvironments/SetPerformanceSettings.md
+++ b/docs/libraries/PhysicsEnvironments/SetPerformanceSettings.md
@@ -14,8 +14,9 @@ lua:
description: "Set performance settings."
arguments:
- - name: "params"
- type: PerformanceParameters
+ - position: 1
+ name: "params"
+ type: PerformanceParameters
returns:
---
diff --git a/docs/libraries/PhysicsEnvironments/SetQuickDelete.md b/docs/libraries/PhysicsEnvironments/SetQuickDelete.md
index 37a752d258..4a313c7e01 100644
--- a/docs/libraries/PhysicsEnvironments/SetQuickDelete.md
+++ b/docs/libraries/PhysicsEnvironments/SetQuickDelete.md
@@ -14,8 +14,9 @@ lua:
description: "Set quick delete."
arguments:
- - name: "quickDelete"
- type: boolean
+ - position: 1
+ name: "quickDelete"
+ type: boolean
returns:
---
diff --git a/docs/libraries/PhysicsEnvironments/SetSimulationTimestep.md b/docs/libraries/PhysicsEnvironments/SetSimulationTimestep.md
index bf9050e185..29429c12a2 100644
--- a/docs/libraries/PhysicsEnvironments/SetSimulationTimestep.md
+++ b/docs/libraries/PhysicsEnvironments/SetSimulationTimestep.md
@@ -14,8 +14,9 @@ lua:
description: "Set simulation timestep."
arguments:
- - name: "timestep"
- type: number
+ - position: 1
+ name: "timestep"
+ type: number
returns:
---
diff --git a/docs/libraries/PhysicsEnvironments/Simulate.md b/docs/libraries/PhysicsEnvironments/Simulate.md
index e1831b5b7d..87f3a4baae 100644
--- a/docs/libraries/PhysicsEnvironments/Simulate.md
+++ b/docs/libraries/PhysicsEnvironments/Simulate.md
@@ -14,8 +14,9 @@ lua:
description: "Simulate for specified time."
arguments:
- - name: "time"
- type: number
+ - position: 1
+ name: "time"
+ type: number
returns:
---
diff --git a/docs/libraries/PhysicsSurfaceProperties/GetGlobal.md b/docs/libraries/PhysicsSurfaceProperties/GetGlobal.md
index 139d970f0f..7e8094b7c1 100644
--- a/docs/libraries/PhysicsSurfaceProperties/GetGlobal.md
+++ b/docs/libraries/PhysicsSurfaceProperties/GetGlobal.md
@@ -13,6 +13,7 @@ lua:
realm: shared
description: "Gets the global surface properties"
+ arguments:
returns:
- type: PhysicsSurfacePropertiesHandle
diff --git a/docs/libraries/Player/SayText.md b/docs/libraries/Player/SayText.md
index d7d2ebef6f..8ffdb399f8 100644
--- a/docs/libraries/Player/SayText.md
+++ b/docs/libraries/Player/SayText.md
@@ -14,10 +14,12 @@ lua:
description: "Say text to a player."
arguments:
- - name: "text"
- type: string
- - name: "player"
- type: Player
+ - position: 1
+ name: "player"
+ type: Player
+ - position: 2
+ name: "text"
+ type: string
returns:
---
diff --git a/docs/libraries/Players/ClientPrint.md b/docs/libraries/Players/ClientPrint.md
index 5e1a0f386b..8ccbc1c108 100644
--- a/docs/libraries/Players/ClientPrint.md
+++ b/docs/libraries/Players/ClientPrint.md
@@ -14,24 +14,31 @@ lua:
description: "Print message to client"
arguments:
- - name: "player"
- type: Player
- - name: "msgDest"
- type: number
- - name: "message"
- type: string
- - name: "param1"
- type: string
- default: "0"
- - name: "param2"
- type: string
- default: "0"
- - name: "param3"
- type: string
- default: "0"
- - name: "param4"
- type: string
- default: "0"
+ - position: 1
+ name: "player"
+ type: Player
+ - position: 2
+ name: "msgDest"
+ type: number
+ - position: 3
+ name: "message"
+ type: string
+ - position: 4
+ name: "param1"
+ type: string
+ default: "0"
+ - position: 5
+ name: "param2"
+ type: string
+ default: "0"
+ - position: 6
+ name: "param3"
+ type: string
+ default: "0"
+ - position: 7
+ name: "param4"
+ type: string
+ default: "0"
returns:
---
diff --git a/docs/libraries/Players/ClientPrintToAll.md b/docs/libraries/Players/ClientPrintToAll.md
index 6221bc3cf2..b8641cd834 100644
--- a/docs/libraries/Players/ClientPrintToAll.md
+++ b/docs/libraries/Players/ClientPrintToAll.md
@@ -14,22 +14,28 @@ lua:
description: "Print text to all clients, optionally substituting 4 strings. The type decides where to show it: HUD_PRINTCENTER (1), HUD_PRINTNOTIFY (2), HUD_PRINTTALK (3), HUD_PRINTCONSOLE (4) - Enums don't exist yet"
arguments:
- - name: "messageType"
- type: number
- - name: "message"
- type: string
- - name: "subsitution1"
- type: string
- default: "NULL"
- - name: "subsitution2"
- type: string
- default: "NULL"
- - name: "subsitution3"
- type: string
- default: "NULL"
- - name: "subsitution4"
- type: string
- default: "NULL"
+ - position: 1
+ name: "messageType"
+ type: number
+ - position: 2
+ name: "message"
+ type: string
+ - position: 3
+ name: "subsitution1"
+ type: string
+ default: "NULL"
+ - position: 4
+ name: "subsitution2"
+ type: string
+ default: "NULL"
+ - position: 5
+ name: "subsitution3"
+ type: string
+ default: "NULL"
+ - position: 6
+ name: "subsitution4"
+ type: string
+ default: "NULL"
returns:
---
diff --git a/docs/libraries/Players/FindByIndex.md b/docs/libraries/Players/FindByIndex.md
index a545a751d0..0ae8751b54 100644
--- a/docs/libraries/Players/FindByIndex.md
+++ b/docs/libraries/Players/FindByIndex.md
@@ -14,8 +14,9 @@ lua:
description: "Get a player by index."
arguments:
- - name: "index"
- type: number
+ - position: 1
+ name: "index"
+ type: number
returns:
- type: Player
description: "The player."
diff --git a/docs/libraries/Players/FindByName.md b/docs/libraries/Players/FindByName.md
index ca61d2460f..129242a15a 100644
--- a/docs/libraries/Players/FindByName.md
+++ b/docs/libraries/Players/FindByName.md
@@ -14,8 +14,9 @@ lua:
description: "Get a player by name."
arguments:
- - name: "name"
- type: string
+ - position: 1
+ name: "name"
+ type: string
returns:
- type: Player
description: "The player."
diff --git a/docs/libraries/Players/FindBySteamId.md b/docs/libraries/Players/FindBySteamId.md
index c47273ecb8..55874c8440 100644
--- a/docs/libraries/Players/FindBySteamId.md
+++ b/docs/libraries/Players/FindBySteamId.md
@@ -14,8 +14,9 @@ lua:
description: "Get a player by Steam ID."
arguments:
- - name: "Steam ID"
- type: string
+ - position: 1
+ name: "Steam ID"
+ type: string
returns:
- type: Player
description: "The player."
diff --git a/docs/libraries/Players/FindBySteamId64.md b/docs/libraries/Players/FindBySteamId64.md
index fc6254c7a1..d6d044cead 100644
--- a/docs/libraries/Players/FindBySteamId64.md
+++ b/docs/libraries/Players/FindBySteamId64.md
@@ -14,8 +14,9 @@ lua:
description: "Get a player by Steam ID 64."
arguments:
- - name: "Steam ID 64"
- type: string
+ - position: 1
+ name: "Steam ID 64"
+ type: string
returns:
- type: Player
description: "The player."
diff --git a/docs/libraries/Players/FindByUniqueID.md b/docs/libraries/Players/FindByUniqueID.md
index 6737235a09..47fffd1c9b 100644
--- a/docs/libraries/Players/FindByUniqueID.md
+++ b/docs/libraries/Players/FindByUniqueID.md
@@ -14,8 +14,9 @@ lua:
description: "Get a player by unique ID."
arguments:
- - name: "unique ID"
- type: string
+ - position: 1
+ name: "unique ID"
+ type: string
returns:
- type: Player
description: "The player."
diff --git a/docs/libraries/Players/FindByUserId.md b/docs/libraries/Players/FindByUserId.md
index 483cfe0634..d6ede846a2 100644
--- a/docs/libraries/Players/FindByUserId.md
+++ b/docs/libraries/Players/FindByUserId.md
@@ -14,8 +14,9 @@ lua:
description: "Get a player by user ID."
arguments:
- - name: "user ID"
- type: number
+ - position: 1
+ name: "user ID"
+ type: number
returns:
- type: Player
description: "The player."
diff --git a/docs/libraries/Players/GetAll.md b/docs/libraries/Players/GetAll.md
index d1e5398104..60eab83cb7 100644
--- a/docs/libraries/Players/GetAll.md
+++ b/docs/libraries/Players/GetAll.md
@@ -13,6 +13,7 @@ lua:
realm: shared
description: "Get all players."
+ arguments:
returns:
- type: table
diff --git a/docs/libraries/Players/GetAllBots.md b/docs/libraries/Players/GetAllBots.md
index d7ef8b3052..c91855cc30 100644
--- a/docs/libraries/Players/GetAllBots.md
+++ b/docs/libraries/Players/GetAllBots.md
@@ -13,6 +13,7 @@ lua:
realm: shared
description: "Get all bots."
+ arguments:
returns:
- type: table
diff --git a/docs/libraries/Players/GetAllHumans.md b/docs/libraries/Players/GetAllHumans.md
index 15deadc09f..6880fcc402 100644
--- a/docs/libraries/Players/GetAllHumans.md
+++ b/docs/libraries/Players/GetAllHumans.md
@@ -13,6 +13,7 @@ lua:
realm: shared
description: "Get all humans."
+ arguments:
returns:
- type: table
diff --git a/docs/libraries/Players/GetCount.md b/docs/libraries/Players/GetCount.md
new file mode 100644
index 0000000000..997e7fd00e
--- /dev/null
+++ b/docs/libraries/Players/GetCount.md
@@ -0,0 +1,25 @@
+---
+template: lua-library-function.html
+title: GetCount
+icon: lua-shared
+tags:
+ - lua
+ - shared
+ - needs-verification
+ - needs-example
+lua:
+ library: Players
+ function: GetCount
+ realm: shared
+ description: "Get the number of players."
+
+ arguments:
+
+ returns:
+ - type: integer
+ description: "The number of players."
+---
+
+
+Players.GetCount – Get the number of players.
+
diff --git a/docs/libraries/Players/GetLocalPlayer.md b/docs/libraries/Players/GetLocalPlayer.md
index 625b071f4b..40d6712753 100644
--- a/docs/libraries/Players/GetLocalPlayer.md
+++ b/docs/libraries/Players/GetLocalPlayer.md
@@ -13,6 +13,7 @@ lua:
realm: client
description: "Get the local player."
+ arguments:
returns:
- type: Player
diff --git a/docs/libraries/Players/GetLocalPlayerIndex.md b/docs/libraries/Players/GetLocalPlayerIndex.md
index b4229bbdbe..e1a0390067 100644
--- a/docs/libraries/Players/GetLocalPlayerIndex.md
+++ b/docs/libraries/Players/GetLocalPlayerIndex.md
@@ -1,18 +1,19 @@
---
template: lua-library-function.html
title: GetLocalPlayerIndex
-icon: lua-shared
+icon: lua-client
tags:
- lua
- - shared
+ - client
- needs-verification
- needs-example
lua:
library: Players
function: GetLocalPlayerIndex
- realm: shared
+ realm: client
description: "Get local player index"
+ arguments:
returns:
- type: integer
diff --git a/docs/libraries/Players/GetLocalPlayerTeam.md b/docs/libraries/Players/GetLocalPlayerTeam.md
index a3ff73e156..4ef8b248fe 100644
--- a/docs/libraries/Players/GetLocalPlayerTeam.md
+++ b/docs/libraries/Players/GetLocalPlayerTeam.md
@@ -1,18 +1,19 @@
---
template: lua-library-function.html
title: GetLocalPlayerTeam
-icon: lua-shared
+icon: lua-client
tags:
- lua
- - shared
+ - client
- needs-verification
- needs-example
lua:
library: Players
function: GetLocalPlayerTeam
- realm: shared
+ realm: client
description: "Get the team of the local player"
+ arguments:
returns:
- type: integer
diff --git a/docs/libraries/Players/GetPlayerConnectionInfo.md b/docs/libraries/Players/GetPlayerConnectionInfo.md
index 9f4b9511e0..2b2a2ff5e7 100644
--- a/docs/libraries/Players/GetPlayerConnectionInfo.md
+++ b/docs/libraries/Players/GetPlayerConnectionInfo.md
@@ -14,8 +14,9 @@ lua:
description: "Get the connection info of a player."
arguments:
- - name: "index"
- type: number
+ - position: 1
+ name: "index"
+ type: number
returns:
- type: integer
description: "The player's ping."
diff --git a/docs/libraries/Players/GetSpectatorMode.md b/docs/libraries/Players/GetSpectatorMode.md
index 1aa0ec2d8d..e30c82fa4a 100644
--- a/docs/libraries/Players/GetSpectatorMode.md
+++ b/docs/libraries/Players/GetSpectatorMode.md
@@ -1,18 +1,19 @@
---
template: lua-library-function.html
title: GetSpectatorMode
-icon: lua-shared
+icon: lua-client
tags:
- lua
- - shared
+ - client
- needs-verification
- needs-example
lua:
library: Players
function: GetSpectatorMode
- realm: shared
+ realm: client
description: "Get spectator mode of the local player"
+ arguments:
returns:
- type: integer
diff --git a/docs/libraries/Players/GetSpectatorTarget.md b/docs/libraries/Players/GetSpectatorTarget.md
index c8eb586354..683cc25b91 100644
--- a/docs/libraries/Players/GetSpectatorTarget.md
+++ b/docs/libraries/Players/GetSpectatorTarget.md
@@ -1,18 +1,19 @@
---
template: lua-library-function.html
title: GetSpectatorTarget
-icon: lua-shared
+icon: lua-client
tags:
- lua
- - shared
+ - client
- needs-verification
- needs-example
lua:
library: Players
function: GetSpectatorTarget
- realm: shared
+ realm: client
description: "Get the spectator target of the local player"
+ arguments:
returns:
- type: integer
diff --git a/docs/libraries/Players/IsLocalPlayerSpectator.md b/docs/libraries/Players/IsLocalPlayerSpectator.md
index 61ca19a54d..47ba542793 100644
--- a/docs/libraries/Players/IsLocalPlayerSpectator.md
+++ b/docs/libraries/Players/IsLocalPlayerSpectator.md
@@ -1,18 +1,19 @@
---
template: lua-library-function.html
title: IsLocalPlayerSpectator
-icon: lua-shared
+icon: lua-client
tags:
- lua
- - shared
+ - client
- needs-verification
- needs-example
lua:
library: Players
function: IsLocalPlayerSpectator
- realm: shared
+ realm: client
description: "Check if local player is a spectator"
+ arguments:
returns:
- type: boolean
diff --git a/docs/libraries/Players/IsPlayerIndex.md b/docs/libraries/Players/IsPlayerIndex.md
index 617680a642..102b040f09 100644
--- a/docs/libraries/Players/IsPlayerIndex.md
+++ b/docs/libraries/Players/IsPlayerIndex.md
@@ -1,21 +1,22 @@
---
template: lua-library-function.html
title: IsPlayerIndex
-icon: lua-shared
+icon: lua-client
tags:
- lua
- - shared
+ - client
- needs-verification
- needs-example
lua:
library: Players
function: IsPlayerIndex
- realm: shared
+ realm: client
description: "Check if index is a player index"
arguments:
- - name: "index"
- type: number
+ - position: 1
+ name: "index"
+ type: number
returns:
- type: boolean
description: "True if player index, false otherwise."
diff --git a/docs/libraries/Players/IsTeamEqual.md b/docs/libraries/Players/IsTeamEqual.md
index ea22823790..6f533a058e 100644
--- a/docs/libraries/Players/IsTeamEqual.md
+++ b/docs/libraries/Players/IsTeamEqual.md
@@ -14,10 +14,12 @@ lua:
description: "Check if two teams are equal."
arguments:
- - name: "team 1"
- type: string
- - name: "team 2"
- type: string
+ - position: 1
+ name: "team 1"
+ type: string
+ - position: 2
+ name: "team 2"
+ type: string
returns:
- type: boolean
description: "Whether the teams are equal."
diff --git a/docs/libraries/Players/SayTextToAll.md b/docs/libraries/Players/SayTextToAll.md
index dd6e267270..a5589485cd 100644
--- a/docs/libraries/Players/SayTextToAll.md
+++ b/docs/libraries/Players/SayTextToAll.md
@@ -14,14 +14,17 @@ lua:
description: "Say text to all players."
arguments:
- - name: "text"
- type: string
- - name: "speakingPlayer"
- type: Player
- default: "0"
- - name: "withoutStringLookup"
- type: boolean
- default: "true"
+ - position: 1
+ name: "text"
+ type: string
+ - position: 2
+ name: "speakingPlayer"
+ type: Player
+ default: "0"
+ - position: 3
+ name: "withoutStringLookup"
+ type: boolean
+ default: "true"
returns:
---
diff --git a/docs/libraries/Players/ShowMessageToAll.md b/docs/libraries/Players/ShowMessageToAll.md
index 5c47472ad4..98f5ae6361 100644
--- a/docs/libraries/Players/ShowMessageToAll.md
+++ b/docs/libraries/Players/ShowMessageToAll.md
@@ -14,8 +14,9 @@ lua:
description: "Show a message to all players."
arguments:
- - name: "message"
- type: string
+ - position: 1
+ name: "message"
+ type: string
returns:
---
diff --git a/docs/libraries/Players/ViewPunchAll.md b/docs/libraries/Players/ViewPunchAll.md
index 1b5ff339c9..ffb9681040 100644
--- a/docs/libraries/Players/ViewPunchAll.md
+++ b/docs/libraries/Players/ViewPunchAll.md
@@ -14,15 +14,19 @@ lua:
description: "Punches the view of all clients within radius. If radius is 0, punches all clients.."
arguments:
- - name: "origin"
- type: Vector
- - name: "angle"
- type: Angle
- - name: "radius"
- type: number
- - name: "shouldPunchPlayersInAir"
- type: boolean
- default: "false"
+ - position: 1
+ name: "origin"
+ type: Vector
+ - position: 2
+ name: "angle"
+ type: Angle
+ - position: 3
+ name: "radius"
+ type: number
+ - position: 4
+ name: "shouldPunchPlayersInAir"
+ type: boolean
+ default: "false"
returns:
---
diff --git a/docs/libraries/PredictionSystems/SuppressEvents.md b/docs/libraries/PredictionSystems/SuppressEvents.md
index a4580b358b..832e8df9be 100644
--- a/docs/libraries/PredictionSystems/SuppressEvents.md
+++ b/docs/libraries/PredictionSystems/SuppressEvents.md
@@ -14,8 +14,9 @@ lua:
description: "Suppresses events."
arguments:
- - name: "shouldSuppress"
- type: boolean
+ - position: 1
+ name: "shouldSuppress"
+ type: boolean
returns:
---
diff --git a/docs/libraries/PredictionSystems/SuppressHostEvents.md b/docs/libraries/PredictionSystems/SuppressHostEvents.md
index ba86e0ccf0..2f80440f7f 100644
--- a/docs/libraries/PredictionSystems/SuppressHostEvents.md
+++ b/docs/libraries/PredictionSystems/SuppressHostEvents.md
@@ -14,8 +14,9 @@ lua:
description: "Suppresses host events."
arguments:
- - name: "host"
- type: Entity
+ - position: 1
+ name: "host"
+ type: Entity
returns:
---
diff --git a/docs/libraries/Predictions/GetIdealPitch.md b/docs/libraries/Predictions/GetIdealPitch.md
index 4002cdc787..ff380398b6 100644
--- a/docs/libraries/Predictions/GetIdealPitch.md
+++ b/docs/libraries/Predictions/GetIdealPitch.md
@@ -13,6 +13,7 @@ lua:
realm: client
description: "Get the ideal pitch."
+ arguments:
returns:
- type: number
diff --git a/docs/libraries/Predictions/GetIncomingPacketNumber.md b/docs/libraries/Predictions/GetIncomingPacketNumber.md
index ee2632a05a..2d1b6e3a42 100644
--- a/docs/libraries/Predictions/GetIncomingPacketNumber.md
+++ b/docs/libraries/Predictions/GetIncomingPacketNumber.md
@@ -13,6 +13,7 @@ lua:
realm: client
description: "Get the incoming packet number."
+ arguments:
returns:
- type: integer
diff --git a/docs/libraries/Predictions/GetLocalViewAngles.md b/docs/libraries/Predictions/GetLocalViewAngles.md
index 87574103e4..485b47b009 100644
--- a/docs/libraries/Predictions/GetLocalViewAngles.md
+++ b/docs/libraries/Predictions/GetLocalViewAngles.md
@@ -13,6 +13,7 @@ lua:
realm: client
description: "Get the local view angles."
+ arguments:
returns:
- type: Angle
diff --git a/docs/libraries/Predictions/GetPredictionPlayer.md b/docs/libraries/Predictions/GetPredictionPlayer.md
index 096852c1a4..631d60ce74 100644
--- a/docs/libraries/Predictions/GetPredictionPlayer.md
+++ b/docs/libraries/Predictions/GetPredictionPlayer.md
@@ -13,9 +13,10 @@ lua:
realm: shared
description: "Get prediction player."
+ arguments:
returns:
- - type: Entity
+ - type: Player
description: "The prediction player."
---
diff --git a/docs/libraries/Predictions/GetPredictionRandomSeed.md b/docs/libraries/Predictions/GetPredictionRandomSeed.md
index 5624fb72ba..b929c6f889 100644
--- a/docs/libraries/Predictions/GetPredictionRandomSeed.md
+++ b/docs/libraries/Predictions/GetPredictionRandomSeed.md
@@ -13,6 +13,7 @@ lua:
realm: shared
description: "Get prediction random seed."
+ arguments:
returns:
- type: integer
diff --git a/docs/libraries/Predictions/GetViewAngles.md b/docs/libraries/Predictions/GetViewAngles.md
index 187a62ad32..cb2eb17dd5 100644
--- a/docs/libraries/Predictions/GetViewAngles.md
+++ b/docs/libraries/Predictions/GetViewAngles.md
@@ -13,6 +13,7 @@ lua:
realm: client
description: "Get the view angles."
+ arguments:
returns:
- type: Angle
diff --git a/docs/libraries/Predictions/GetViewOrigin.md b/docs/libraries/Predictions/GetViewOrigin.md
index e311942634..6df33d4d3f 100644
--- a/docs/libraries/Predictions/GetViewOrigin.md
+++ b/docs/libraries/Predictions/GetViewOrigin.md
@@ -13,6 +13,7 @@ lua:
realm: client
description: "Get the view origin."
+ arguments:
returns:
- type: Vector
diff --git a/docs/libraries/Predictions/InPrediction.md b/docs/libraries/Predictions/InPrediction.md
index ce7e3cc70b..09b5e738a5 100644
--- a/docs/libraries/Predictions/InPrediction.md
+++ b/docs/libraries/Predictions/InPrediction.md
@@ -13,6 +13,7 @@ lua:
realm: client
description: "Check if the game is in prediction."
+ arguments:
returns:
- type: boolean
diff --git a/docs/libraries/Predictions/IsFirstTimePredicted.client.md b/docs/libraries/Predictions/IsFirstTimePredicted.client.md
index e1fc6d4e4e..a44129f7f9 100644
--- a/docs/libraries/Predictions/IsFirstTimePredicted.client.md
+++ b/docs/libraries/Predictions/IsFirstTimePredicted.client.md
@@ -13,6 +13,7 @@ lua:
realm: client
description: "Check if the game is in the first time predicted."
+ arguments:
returns:
- type: boolean
diff --git a/docs/libraries/Predictions/IsFirstTimePredicted.server.md b/docs/libraries/Predictions/IsFirstTimePredicted.server.md
index f2d98aa05e..becdfcf443 100644
--- a/docs/libraries/Predictions/IsFirstTimePredicted.server.md
+++ b/docs/libraries/Predictions/IsFirstTimePredicted.server.md
@@ -13,6 +13,7 @@ lua:
realm: server
description: "Always returns true on the server. TODO: what should it do?"
+ arguments:
returns:
- type: boolean
diff --git a/docs/libraries/Predictions/OnReceivedUncompressedPacket.md b/docs/libraries/Predictions/OnReceivedUncompressedPacket.md
index 5c97029b89..8e24c600da 100644
--- a/docs/libraries/Predictions/OnReceivedUncompressedPacket.md
+++ b/docs/libraries/Predictions/OnReceivedUncompressedPacket.md
@@ -13,6 +13,7 @@ lua:
realm: client
description: "Call when the game receives an uncompressed packet."
+ arguments:
returns:
diff --git a/docs/libraries/Predictions/PostEntityPacketReceived.md b/docs/libraries/Predictions/PostEntityPacketReceived.md
index ce38ef340b..311c68ef01 100644
--- a/docs/libraries/Predictions/PostEntityPacketReceived.md
+++ b/docs/libraries/Predictions/PostEntityPacketReceived.md
@@ -13,6 +13,7 @@ lua:
realm: client
description: "Call after the game receives an entity packet."
+ arguments:
returns:
diff --git a/docs/libraries/Predictions/PostNetworkDataReceived.md b/docs/libraries/Predictions/PostNetworkDataReceived.md
index 63340a0f3a..e700cba7ef 100644
--- a/docs/libraries/Predictions/PostNetworkDataReceived.md
+++ b/docs/libraries/Predictions/PostNetworkDataReceived.md
@@ -14,8 +14,9 @@ lua:
description: "Call after the game receives network data."
arguments:
- - name: "commandsAcknowledged"
- type: number
+ - position: 1
+ name: "commandsAcknowledged"
+ type: number
returns:
---
diff --git a/docs/libraries/Predictions/PreEntityPacketReceived.md b/docs/libraries/Predictions/PreEntityPacketReceived.md
index 5e760bddf1..41b1c919a3 100644
--- a/docs/libraries/Predictions/PreEntityPacketReceived.md
+++ b/docs/libraries/Predictions/PreEntityPacketReceived.md
@@ -14,10 +14,12 @@ lua:
description: "Call before the game receives an entity packet."
arguments:
- - name: "commandsAcknowledged"
- type: number
- - name: "currentWorldUpdate"
- type: number
+ - position: 1
+ name: "commandsAcknowledged"
+ type: number
+ - position: 2
+ name: "currentWorldUpdate"
+ type: number
returns:
---
diff --git a/docs/libraries/Predictions/SetLocalViewAngles.md b/docs/libraries/Predictions/SetLocalViewAngles.md
index 76309ba37c..b9198885e3 100644
--- a/docs/libraries/Predictions/SetLocalViewAngles.md
+++ b/docs/libraries/Predictions/SetLocalViewAngles.md
@@ -14,8 +14,9 @@ lua:
description: "Set the local view angles."
arguments:
- - name: "angles"
- type: Angle
+ - position: 1
+ name: "angles"
+ type: Angle
returns:
---
diff --git a/docs/libraries/Predictions/SetViewAngles.md b/docs/libraries/Predictions/SetViewAngles.md
index f63664cdf3..00d0657492 100644
--- a/docs/libraries/Predictions/SetViewAngles.md
+++ b/docs/libraries/Predictions/SetViewAngles.md
@@ -14,8 +14,9 @@ lua:
description: "Set the view angles."
arguments:
- - name: "angles"
- type: Angle
+ - position: 1
+ name: "angles"
+ type: Angle
returns:
---
diff --git a/docs/libraries/Predictions/SetViewOrigin.md b/docs/libraries/Predictions/SetViewOrigin.md
index 018fca5bb8..f89b54314a 100644
--- a/docs/libraries/Predictions/SetViewOrigin.md
+++ b/docs/libraries/Predictions/SetViewOrigin.md
@@ -14,8 +14,9 @@ lua:
description: "Set the view origin."
arguments:
- - name: "origin"
- type: Vector
+ - position: 1
+ name: "origin"
+ type: Vector
returns:
---
diff --git a/docs/libraries/Predictions/Update.md b/docs/libraries/Predictions/Update.md
index a7047a66fb..2e0e08f649 100644
--- a/docs/libraries/Predictions/Update.md
+++ b/docs/libraries/Predictions/Update.md
@@ -14,14 +14,18 @@ lua:
description: "Update the prediction."
arguments:
- - name: "startFrame"
- type: number
- - name: "validFrame"
- type: boolean
- - name: "incomingAcknowledged"
- type: number
- - name: "outgoingCommand"
- type: number
+ - position: 1
+ name: "startFrame"
+ type: number
+ - position: 2
+ name: "validFrame"
+ type: boolean
+ - position: 3
+ name: "incomingAcknowledged"
+ type: number
+ - position: 4
+ name: "outgoingCommand"
+ type: number
returns:
---
diff --git a/docs/libraries/ProjectedTextures/Create.md b/docs/libraries/ProjectedTextures/Create.md
index 1530b43287..60d0ebc5cf 100644
--- a/docs/libraries/ProjectedTextures/Create.md
+++ b/docs/libraries/ProjectedTextures/Create.md
@@ -13,6 +13,7 @@ lua:
realm: client
description: "Creates a new projected texture."
+ arguments:
returns:
- type: ProjectedTexture
diff --git a/docs/libraries/Randoms/RandomBloodVector.md b/docs/libraries/Randoms/RandomBloodVector.md
index b0a63982a8..3aa160b187 100644
--- a/docs/libraries/Randoms/RandomBloodVector.md
+++ b/docs/libraries/Randoms/RandomBloodVector.md
@@ -13,6 +13,7 @@ lua:
realm: server
description: "Generate a random blood vector."
+ arguments:
returns:
- type: Vector
diff --git a/docs/libraries/Randoms/RandomFloat.md b/docs/libraries/Randoms/RandomFloat.md
index ff21e16909..7dceb7f205 100644
--- a/docs/libraries/Randoms/RandomFloat.md
+++ b/docs/libraries/Randoms/RandomFloat.md
@@ -14,12 +14,14 @@ lua:
description: "Generate a random float."
arguments:
- - name: "min"
- type: number
- default: "0.0f"
- - name: "max"
- type: number
- default: "0.0f"
+ - position: 1
+ name: "min"
+ type: number
+ default: "0.0f"
+ - position: 2
+ name: "max"
+ type: number
+ default: "0.0f"
returns:
- type: number
description: "The generated random float."
diff --git a/docs/libraries/Randoms/RandomFloatExponential.md b/docs/libraries/Randoms/RandomFloatExponential.md
index a4442a261b..8875b880a4 100644
--- a/docs/libraries/Randoms/RandomFloatExponential.md
+++ b/docs/libraries/Randoms/RandomFloatExponential.md
@@ -14,15 +14,18 @@ lua:
description: "Generate a random float with an exponential distribution."
arguments:
- - name: "min"
- type: number
- default: "0.0f"
- - name: "max"
- type: number
- default: "0.0f"
- - name: "exponent"
- type: number
- default: "1.0f"
+ - position: 1
+ name: "min"
+ type: number
+ default: "0.0f"
+ - position: 2
+ name: "max"
+ type: number
+ default: "0.0f"
+ - position: 3
+ name: "exponent"
+ type: number
+ default: "1.0f"
returns:
- type: number
description: "The generated random float."
diff --git a/docs/libraries/Randoms/RandomInteger.md b/docs/libraries/Randoms/RandomInteger.md
index 33cd6e5a69..8e0a396ef9 100644
--- a/docs/libraries/Randoms/RandomInteger.md
+++ b/docs/libraries/Randoms/RandomInteger.md
@@ -14,10 +14,12 @@ lua:
description: "Generate a random integer."
arguments:
- - name: "min"
- type: number
- - name: "max"
- type: number
+ - position: 1
+ name: "min"
+ type: number
+ - position: 2
+ name: "max"
+ type: number
returns:
- type: integer
description: "The generated random integer."
diff --git a/docs/libraries/Randoms/SetSeed.md b/docs/libraries/Randoms/SetSeed.md
index 22ff471e6d..36b6d7acdb 100644
--- a/docs/libraries/Randoms/SetSeed.md
+++ b/docs/libraries/Randoms/SetSeed.md
@@ -14,8 +14,9 @@ lua:
description: "Set the seed for the random number generator."
arguments:
- - name: "seed"
- type: number
+ - position: 1
+ name: "seed"
+ type: number
returns:
---
diff --git a/docs/libraries/Randoms/SharedRandomAngle.md b/docs/libraries/Randoms/SharedRandomAngle.md
index 2e450b9448..da78223105 100644
--- a/docs/libraries/Randoms/SharedRandomAngle.md
+++ b/docs/libraries/Randoms/SharedRandomAngle.md
@@ -14,15 +14,19 @@ lua:
description: "Generate a shared random angle. Whenever generating random numbers in shared/predicted code, these SharedRandom* functions have to be used. Each call should specify a unique 'sharedName' that seeds the random number generator. In loops make sure the additionalSeed is increased with the loop counter, otherwise it will always return the same random number"
arguments:
- - name: "sharedName"
- type: string
- - name: "min"
- type: number
- - name: "max"
- type: number
- - name: "additionalSeed"
- type: number
- default: "0"
+ - position: 1
+ name: "sharedName"
+ type: string
+ - position: 2
+ name: "min"
+ type: number
+ - position: 3
+ name: "max"
+ type: number
+ - position: 4
+ name: "additionalSeed"
+ type: number
+ default: "0"
returns:
- type: Angle
description: "The generated random angle."
diff --git a/docs/libraries/Randoms/SharedRandomFloat.md b/docs/libraries/Randoms/SharedRandomFloat.md
index 97e028301e..2cad96d7f2 100644
--- a/docs/libraries/Randoms/SharedRandomFloat.md
+++ b/docs/libraries/Randoms/SharedRandomFloat.md
@@ -14,15 +14,19 @@ lua:
description: "Generate a shared random float. Whenever generating random numbers in shared/predicted code, these SharedRandom* functions have to be used. Each call should specify a unique 'sharedName' that seeds the random number generator. In loops make sure the additionalSeed is increased with the loop counter, otherwise it will always return the same random number"
arguments:
- - name: "sharedName"
- type: string
- - name: "min"
- type: number
- - name: "max"
- type: number
- - name: "additionalSeed"
- type: number
- default: "0"
+ - position: 1
+ name: "sharedName"
+ type: string
+ - position: 2
+ name: "min"
+ type: number
+ - position: 3
+ name: "max"
+ type: number
+ - position: 4
+ name: "additionalSeed"
+ type: number
+ default: "0"
returns:
- type: number
description: "The generated random float."
diff --git a/docs/libraries/Randoms/SharedRandomInt.md b/docs/libraries/Randoms/SharedRandomInt.md
index 6915679cf4..b5ae0d9e64 100644
--- a/docs/libraries/Randoms/SharedRandomInt.md
+++ b/docs/libraries/Randoms/SharedRandomInt.md
@@ -14,15 +14,19 @@ lua:
description: "Generate a shared random integer. Whenever generating random numbers in shared/predicted code, these SharedRandom* functions have to be used. Each call should specify a unique 'sharedName' that seeds the random number generator. In loops make sure the additionalSeed is increased with the loop counter, otherwise it will always return the same random number"
arguments:
- - name: "sharedName"
- type: string
- - name: "min"
- type: number
- - name: "max"
- type: number
- - name: "additionalSeed"
- type: number
- default: "0"
+ - position: 1
+ name: "sharedName"
+ type: string
+ - position: 2
+ name: "min"
+ type: number
+ - position: 3
+ name: "max"
+ type: number
+ - position: 4
+ name: "additionalSeed"
+ type: number
+ default: "0"
returns:
- type: integer
description: "The generated random integer."
diff --git a/docs/libraries/Randoms/SharedRandomVector.md b/docs/libraries/Randoms/SharedRandomVector.md
index 86c6b57982..25b4b68ebe 100644
--- a/docs/libraries/Randoms/SharedRandomVector.md
+++ b/docs/libraries/Randoms/SharedRandomVector.md
@@ -14,15 +14,19 @@ lua:
description: "Generate a shared random vector. Whenever generating random numbers in shared/predicted code, these SharedRandom* functions have to be used. Each call should specify a unique 'sharedName' that seeds the random number generator. In loops make sure the additionalSeed is increased with the loop counter, otherwise it will always return the same random number"
arguments:
- - name: "sharedName"
- type: string
- - name: "min"
- type: number
- - name: "max"
- type: number
- - name: "additionalSeed"
- type: number
- default: "0"
+ - position: 1
+ name: "sharedName"
+ type: string
+ - position: 2
+ name: "min"
+ type: number
+ - position: 3
+ name: "max"
+ type: number
+ - position: 4
+ name: "additionalSeed"
+ type: number
+ default: "0"
returns:
- type: Vector
description: "The generated random vector."
diff --git a/docs/libraries/RecipientFilters/Create.md b/docs/libraries/RecipientFilters/Create.md
index b10674c0b5..16808c72cc 100644
--- a/docs/libraries/RecipientFilters/Create.md
+++ b/docs/libraries/RecipientFilters/Create.md
@@ -14,9 +14,10 @@ lua:
description: "Creates a new recipient filter"
arguments:
- - name: "isUnreliable"
- type: boolean
- default: "false"
+ - position: 1
+ name: "isUnreliable"
+ type: boolean
+ default: "false"
returns:
- type: RecipientFilter
description: "The new recipient filter"
diff --git a/docs/libraries/Renders/ClearBuffers.md b/docs/libraries/Renders/ClearBuffers.md
index d4712132f5..f77109f3ea 100644
--- a/docs/libraries/Renders/ClearBuffers.md
+++ b/docs/libraries/Renders/ClearBuffers.md
@@ -14,12 +14,15 @@ lua:
description: "Clear the buffers."
arguments:
- - name: "clearColor"
- type: boolean
- - name: "clearDepth"
- type: boolean
- - name: "clearStencil"
- type: boolean
+ - position: 1
+ name: "clearColor"
+ type: boolean
+ - position: 2
+ name: "clearDepth"
+ type: boolean
+ - position: 3
+ name: "clearStencil"
+ type: boolean
returns:
---
diff --git a/docs/libraries/Renders/ClearColor.md b/docs/libraries/Renders/ClearColor.md
index 78225c9d9c..b329c03f54 100644
--- a/docs/libraries/Renders/ClearColor.md
+++ b/docs/libraries/Renders/ClearColor.md
@@ -14,8 +14,9 @@ lua:
description: "Clear the color."
arguments:
- - name: "color"
- type: Color
+ - position: 1
+ name: "color"
+ type: Color
returns:
---
diff --git a/docs/libraries/Renders/ClearStencilBufferRectangle.md b/docs/libraries/Renders/ClearStencilBufferRectangle.md
new file mode 100644
index 0000000000..05f27df837
--- /dev/null
+++ b/docs/libraries/Renders/ClearStencilBufferRectangle.md
@@ -0,0 +1,38 @@
+---
+template: lua-library-function.html
+title: ClearStencilBufferRectangle
+icon: lua-client
+tags:
+ - lua
+ - client
+ - needs-verification
+ - needs-example
+lua:
+ library: Renders
+ function: ClearStencilBufferRectangle
+ realm: client
+ description: "Clear the stencil buffer rectangle."
+
+ arguments:
+ - position: 1
+ name: "startX"
+ type: number
+ - position: 2
+ name: "startY"
+ type: number
+ - position: 3
+ name: "endX"
+ type: number
+ - position: 4
+ name: "endY"
+ type: number
+ - position: 5
+ name: "value"
+ type: number
+ returns:
+
+---
+
+
+Renders.ClearStencilBufferRectangle – Clear the stencil buffer rectangle.
+
diff --git a/docs/libraries/Renders/CopyRenderTargetToTexture.md b/docs/libraries/Renders/CopyRenderTargetToTexture.md
index 52eb62155c..5f2772754d 100644
--- a/docs/libraries/Renders/CopyRenderTargetToTexture.md
+++ b/docs/libraries/Renders/CopyRenderTargetToTexture.md
@@ -14,8 +14,9 @@ lua:
description: "Copies the currently active Render Target to the specified texture."
arguments:
- - name: "texture"
- type: Texture
+ - position: 1
+ name: "texture"
+ type: Texture
returns:
---
diff --git a/docs/libraries/Renders/CreateRenderTargetTextureEx.md b/docs/libraries/Renders/CreateRenderTargetTextureEx.md
index 2872b1ebd3..a4888fd004 100644
--- a/docs/libraries/Renders/CreateRenderTargetTextureEx.md
+++ b/docs/libraries/Renders/CreateRenderTargetTextureEx.md
@@ -14,27 +14,35 @@ lua:
description: "Create a new render target texture."
arguments:
- - name: "name"
- type: string
- - name: "width"
- type: number
- - name: "height"
- type: number
- - name: "sizeMode"
- type: number
- default: "RT_SIZE_DEFAULT"
- - name: "depthMode"
- type: number
- default: "MATERIAL_RT_DEPTH_SHARED"
- - name: "textureFlags"
- type: number
- default: "TEXTUREFLAGS_CLAMPS | TEXTUREFLAGS_CLAMPT"
- - name: "renderTargetFlags"
- type: number
- default: "0"
- - name: "imageFormat"
- type: number
- default: "IMAGE_FORMAT_RGBA8888"
+ - position: 1
+ name: "name"
+ type: string
+ - position: 2
+ name: "width"
+ type: number
+ - position: 3
+ name: "height"
+ type: number
+ - position: 4
+ name: "sizeMode"
+ type: number
+ default: "RT_SIZE_DEFAULT"
+ - position: 5
+ name: "depthMode"
+ type: number
+ default: "MATERIAL_RT_DEPTH_SHARED"
+ - position: 6
+ name: "textureFlags"
+ type: number
+ default: "TEXTUREFLAGS_CLAMPS | TEXTUREFLAGS_CLAMPT"
+ - position: 7
+ name: "renderTargetFlags"
+ type: number
+ default: "0"
+ - position: 8
+ name: "imageFormat"
+ type: number
+ default: "IMAGE_FORMAT_RGBA8888"
returns:
- type: Texture
description: "The created render target texture."
diff --git a/docs/libraries/Renders/CullMode.md b/docs/libraries/Renders/CullMode.md
index 0c4ffa6767..5cae523b09 100644
--- a/docs/libraries/Renders/CullMode.md
+++ b/docs/libraries/Renders/CullMode.md
@@ -14,8 +14,9 @@ lua:
description: "Sets the cull mode that decides how back faces are culled when rendering geometry."
arguments:
- - name: "cullMode"
- type: enumeration/CULL_MODE
+ - position: 1
+ name: "cullMode"
+ type: enumeration/CULL_MODE
returns:
---
diff --git a/docs/libraries/Renders/DepthRange.md b/docs/libraries/Renders/DepthRange.md
index 990c23dd4d..38bd3cafd2 100644
--- a/docs/libraries/Renders/DepthRange.md
+++ b/docs/libraries/Renders/DepthRange.md
@@ -14,10 +14,12 @@ lua:
description: "Set's the depth range of the upcoming render."
arguments:
- - name: "depthMin"
- type: number
- - name: "depthMax"
- type: number
+ - position: 1
+ name: "depthMin"
+ type: number
+ - position: 2
+ name: "depthMax"
+ type: number
returns:
---
diff --git a/docs/libraries/Renders/DrawBeam.md b/docs/libraries/Renders/DrawBeam.md
new file mode 100644
index 0000000000..fa9d765635
--- /dev/null
+++ b/docs/libraries/Renders/DrawBeam.md
@@ -0,0 +1,38 @@
+---
+template: lua-library-function.html
+title: DrawBeam
+icon: lua-client
+tags:
+ - lua
+ - client
+ - needs-verification
+ - needs-example
+lua:
+ library: Renders
+ function: DrawBeam
+ realm: client
+ description: "Draws a beam"
+
+ arguments:
+ - position: 1
+ name: "start"
+ type: Vector
+ - position: 2
+ name: "end"
+ type: Vector
+ - position: 3
+ name: "width"
+ type: number
+ - position: 4
+ name: "textureStart"
+ type: number
+ - position: 5
+ name: "textureEnd"
+ type: number
+ returns:
+
+---
+
+
+Renders.DrawBeam – Draws a beam
+
diff --git a/docs/libraries/Renders/DrawSprite.md b/docs/libraries/Renders/DrawSprite.md
index d5b2b75708..0e2ae0cd37 100644
--- a/docs/libraries/Renders/DrawSprite.md
+++ b/docs/libraries/Renders/DrawSprite.md
@@ -14,12 +14,15 @@ lua:
description: "Draws a sprite"
arguments:
- - name: "position"
- type: Vector
- - name: "width"
- type: number
- - name: "height"
- type: number
+ - position: 1
+ name: "position"
+ type: Vector
+ - position: 2
+ name: "width"
+ type: number
+ - position: 3
+ name: "height"
+ type: number
returns:
---
diff --git a/docs/libraries/Renders/GetModelMatrix.md b/docs/libraries/Renders/GetModelMatrix.md
new file mode 100644
index 0000000000..470cca723c
--- /dev/null
+++ b/docs/libraries/Renders/GetModelMatrix.md
@@ -0,0 +1,25 @@
+---
+template: lua-library-function.html
+title: GetModelMatrix
+icon: lua-client
+tags:
+ - lua
+ - client
+ - needs-verification
+ - needs-example
+lua:
+ library: Renders
+ function: GetModelMatrix
+ realm: client
+ description: "Get the model matrix."
+
+ arguments:
+
+ returns:
+ - type: VMatrix
+ description: "The model matrix."
+---
+
+
+Renders.GetModelMatrix – Get the model matrix.
+
diff --git a/docs/libraries/Renders/GetRenderTarget.md b/docs/libraries/Renders/GetRenderTarget.md
index 87489dd250..b41aadcd50 100644
--- a/docs/libraries/Renders/GetRenderTarget.md
+++ b/docs/libraries/Renders/GetRenderTarget.md
@@ -13,6 +13,7 @@ lua:
realm: client
description: "Get the currently active render target."
+ arguments:
returns:
- type: Texture
diff --git a/docs/libraries/Renders/GetScreenEffectTexture.md b/docs/libraries/Renders/GetScreenEffectTexture.md
index 5cacd66428..4622d59adb 100644
--- a/docs/libraries/Renders/GetScreenEffectTexture.md
+++ b/docs/libraries/Renders/GetScreenEffectTexture.md
@@ -14,8 +14,9 @@ lua:
description: "Get the screen effect texture."
arguments:
- - name: "textureIndex"
- type: number
+ - position: 1
+ name: "textureIndex"
+ type: number
returns:
- type: Texture
description: "The screen effect texture."
diff --git a/docs/libraries/Renders/GetViewEntity.md b/docs/libraries/Renders/GetViewEntity.md
index e5d9369832..6cce93b0e2 100644
--- a/docs/libraries/Renders/GetViewEntity.md
+++ b/docs/libraries/Renders/GetViewEntity.md
@@ -13,6 +13,7 @@ lua:
realm: client
description: "Returns the entity the client is using to see (mostly the player itself)"
+ arguments:
returns:
- type: Entity
diff --git a/docs/libraries/Renders/MainViewAngles.md b/docs/libraries/Renders/MainViewAngles.md
index 7495f44444..bdf9fade15 100644
--- a/docs/libraries/Renders/MainViewAngles.md
+++ b/docs/libraries/Renders/MainViewAngles.md
@@ -13,6 +13,7 @@ lua:
realm: client
description: "Get the main view angles."
+ arguments:
returns:
- type: Angle
diff --git a/docs/libraries/Renders/MainViewForward.md b/docs/libraries/Renders/MainViewForward.md
index 37fd2e697e..1cf2641810 100644
--- a/docs/libraries/Renders/MainViewForward.md
+++ b/docs/libraries/Renders/MainViewForward.md
@@ -13,6 +13,7 @@ lua:
realm: client
description: "Get the main view forward."
+ arguments:
returns:
- type: Vector
diff --git a/docs/libraries/Renders/MainViewOrigin.md b/docs/libraries/Renders/MainViewOrigin.md
index 83f07b26e8..8abe112ac1 100644
--- a/docs/libraries/Renders/MainViewOrigin.md
+++ b/docs/libraries/Renders/MainViewOrigin.md
@@ -13,6 +13,7 @@ lua:
realm: client
description: "Get the main view origin."
+ arguments:
returns:
- type: Vector
diff --git a/docs/libraries/Renders/PopCustomClipPlane.md b/docs/libraries/Renders/PopCustomClipPlane.md
new file mode 100644
index 0000000000..410d312149
--- /dev/null
+++ b/docs/libraries/Renders/PopCustomClipPlane.md
@@ -0,0 +1,24 @@
+---
+template: lua-library-function.html
+title: PopCustomClipPlane
+icon: lua-client
+tags:
+ - lua
+ - client
+ - needs-verification
+ - needs-example
+lua:
+ library: Renders
+ function: PopCustomClipPlane
+ realm: client
+ description: "Pop a custom clip plane."
+
+ arguments:
+
+ returns:
+
+---
+
+
+Renders.PopCustomClipPlane – Pop a custom clip plane.
+
diff --git a/docs/libraries/Renders/PopFilterMagnification.md b/docs/libraries/Renders/PopFilterMagnification.md
index 7173428e19..7abd78eab5 100644
--- a/docs/libraries/Renders/PopFilterMagnification.md
+++ b/docs/libraries/Renders/PopFilterMagnification.md
@@ -13,6 +13,7 @@ lua:
realm: client
description: "Pop a magnification filter. (Non-functional; help wanted)"
+ arguments:
returns:
diff --git a/docs/libraries/Renders/PopFilterMinification.md b/docs/libraries/Renders/PopFilterMinification.md
index 5eccd7a535..0fb90b0ee3 100644
--- a/docs/libraries/Renders/PopFilterMinification.md
+++ b/docs/libraries/Renders/PopFilterMinification.md
@@ -13,6 +13,7 @@ lua:
realm: client
description: "Pop a minification filter."
+ arguments:
returns:
diff --git a/docs/libraries/Renders/PopModelMatrix.md b/docs/libraries/Renders/PopModelMatrix.md
new file mode 100644
index 0000000000..e925d15692
--- /dev/null
+++ b/docs/libraries/Renders/PopModelMatrix.md
@@ -0,0 +1,24 @@
+---
+template: lua-library-function.html
+title: PopModelMatrix
+icon: lua-client
+tags:
+ - lua
+ - client
+ - needs-verification
+ - needs-example
+lua:
+ library: Renders
+ function: PopModelMatrix
+ realm: client
+ description: "Pop a model matrix."
+
+ arguments:
+
+ returns:
+
+---
+
+
+Renders.PopModelMatrix – Pop a model matrix.
+
diff --git a/docs/libraries/Renders/PopView2D.md b/docs/libraries/Renders/PopView2D.md
index 69058189d8..74e36202d5 100644
--- a/docs/libraries/Renders/PopView2D.md
+++ b/docs/libraries/Renders/PopView2D.md
@@ -13,6 +13,7 @@ lua:
realm: client
description: "Pop a 2D view."
+ arguments:
returns:
diff --git a/docs/libraries/Renders/PopView3D.md b/docs/libraries/Renders/PopView3D.md
index c52c11bdef..f53d6e1e22 100644
--- a/docs/libraries/Renders/PopView3D.md
+++ b/docs/libraries/Renders/PopView3D.md
@@ -13,6 +13,7 @@ lua:
realm: client
description: "Pop a 3D view."
+ arguments:
returns:
diff --git a/docs/libraries/Renders/PushCustomClipPlane.md b/docs/libraries/Renders/PushCustomClipPlane.md
new file mode 100644
index 0000000000..99ae2236ee
--- /dev/null
+++ b/docs/libraries/Renders/PushCustomClipPlane.md
@@ -0,0 +1,29 @@
+---
+template: lua-library-function.html
+title: PushCustomClipPlane
+icon: lua-client
+tags:
+ - lua
+ - client
+ - needs-verification
+ - needs-example
+lua:
+ library: Renders
+ function: PushCustomClipPlane
+ realm: client
+ description: "Push a custom clip plane."
+
+ arguments:
+ - position: 1
+ name: "normal"
+ type: Vector
+ - position: 2
+ name: "distance"
+ type: number
+ returns:
+
+---
+
+
+Renders.PushCustomClipPlane – Push a custom clip plane.
+
diff --git a/docs/libraries/Renders/PushFilterMagnification.md b/docs/libraries/Renders/PushFilterMagnification.md
index 5969d8716f..896fe83b2d 100644
--- a/docs/libraries/Renders/PushFilterMagnification.md
+++ b/docs/libraries/Renders/PushFilterMagnification.md
@@ -14,8 +14,9 @@ lua:
description: "Push a magnification filter."
arguments:
- - name: "filter"
- type: number
+ - position: 1
+ name: "filter"
+ type: number
returns:
---
diff --git a/docs/libraries/Renders/PushFilterMinification.md b/docs/libraries/Renders/PushFilterMinification.md
index c8ccc6c5dd..fc91359bd8 100644
--- a/docs/libraries/Renders/PushFilterMinification.md
+++ b/docs/libraries/Renders/PushFilterMinification.md
@@ -14,8 +14,9 @@ lua:
description: "Push a minification filter. (Non-functional; help wanted)"
arguments:
- - name: "filter"
- type: number
+ - position: 1
+ name: "filter"
+ type: number
returns:
---
diff --git a/docs/libraries/Renders/PushModelMatrix.md b/docs/libraries/Renders/PushModelMatrix.md
new file mode 100644
index 0000000000..fec53f2289
--- /dev/null
+++ b/docs/libraries/Renders/PushModelMatrix.md
@@ -0,0 +1,30 @@
+---
+template: lua-library-function.html
+title: PushModelMatrix
+icon: lua-client
+tags:
+ - lua
+ - client
+ - needs-verification
+ - needs-example
+lua:
+ library: Renders
+ function: PushModelMatrix
+ realm: client
+ description: "Push a model matrix."
+
+ arguments:
+ - position: 1
+ name: "matrix"
+ type: Matrix
+ - position: 2
+ name: "shouldMultiply"
+ type: boolean
+ default: "false"
+ returns:
+
+---
+
+
+Renders.PushModelMatrix – Push a model matrix.
+
diff --git a/docs/libraries/Renders/PushView2D.md b/docs/libraries/Renders/PushView2D.md
index 58fa2657d4..f324eeac3a 100644
--- a/docs/libraries/Renders/PushView2D.md
+++ b/docs/libraries/Renders/PushView2D.md
@@ -13,6 +13,7 @@ lua:
realm: client
description: "Push a 2D view."
+ arguments:
returns:
diff --git a/docs/libraries/Renders/PushView3D.md b/docs/libraries/Renders/PushView3D.md
index eb0ea87ff5..50884637bc 100644
--- a/docs/libraries/Renders/PushView3D.md
+++ b/docs/libraries/Renders/PushView3D.md
@@ -14,33 +14,42 @@ lua:
description: "Push a 3D view."
arguments:
- - name: "origin"
- type: Vector
- default: "&playerView.origin"
- - name: "angles"
- type: Angle
- default: "&playerView.angles"
- - name: "fov"
- type: number
- default: "playerView.fov"
- - name: "x"
- type: number
- default: "playerView.x"
- - name: "y"
- type: number
- default: "playerView.y"
- - name: "width"
- type: number
- default: "playerView.width"
- - name: "height"
- type: number
- default: "playerView.height"
- - name: "zNear"
- type: number
- default: "playerView.zNear"
- - name: "zFar"
- type: number
- default: "playerView.zFar"
+ - position: 1
+ name: "origin"
+ type: Vector
+ default: "&playerView.origin"
+ - position: 2
+ name: "angles"
+ type: Angle
+ default: "&playerView.angles"
+ - position: 3
+ name: "fov"
+ type: number
+ default: "playerView.fov"
+ - position: 4
+ name: "x"
+ type: number
+ default: "playerView.x"
+ - position: 5
+ name: "y"
+ type: number
+ default: "playerView.y"
+ - position: 6
+ name: "width"
+ type: number
+ default: "playerView.width"
+ - position: 7
+ name: "height"
+ type: number
+ default: "playerView.height"
+ - position: 8
+ name: "zNear"
+ type: number
+ default: "playerView.zNear"
+ - position: 9
+ name: "zFar"
+ type: number
+ default: "playerView.zFar"
returns:
---
diff --git a/docs/libraries/Renders/RenderFlashlights.md b/docs/libraries/Renders/RenderFlashlights.md
new file mode 100644
index 0000000000..25a2698454
--- /dev/null
+++ b/docs/libraries/Renders/RenderFlashlights.md
@@ -0,0 +1,24 @@
+---
+template: lua-library-function.html
+title: RenderFlashlights
+icon: lua-client
+tags:
+ - lua
+ - client
+ - needs-verification
+ - needs-example
+lua:
+ library: Renders
+ function: RenderFlashlights
+ realm: client
+ description: "Render flashlights."
+
+ arguments:
+
+ returns:
+
+---
+
+
+Renders.RenderFlashlights – Render flashlights.
+
diff --git a/docs/libraries/Renders/ResetAmbientLightCube.md b/docs/libraries/Renders/ResetAmbientLightCube.md
index 7278cd52b3..2ff03e4698 100644
--- a/docs/libraries/Renders/ResetAmbientLightCube.md
+++ b/docs/libraries/Renders/ResetAmbientLightCube.md
@@ -14,12 +14,15 @@ lua:
description: "Reset the ambient light cube."
arguments:
- - name: "r"
- type: number
- - name: "g"
- type: number
- - name: "b"
- type: number
+ - position: 1
+ name: "r"
+ type: number
+ - position: 2
+ name: "g"
+ type: number
+ - position: 3
+ name: "b"
+ type: number
returns:
---
diff --git a/docs/libraries/Renders/SetAmbientLightCube.md b/docs/libraries/Renders/SetAmbientLightCube.md
index f994466853..49e940e0ef 100644
--- a/docs/libraries/Renders/SetAmbientLightCube.md
+++ b/docs/libraries/Renders/SetAmbientLightCube.md
@@ -14,14 +14,18 @@ lua:
description: "Set the ambient light cube."
arguments:
- - name: "directionFace"
- type: number
- - name: "r"
- type: number
- - name: "g"
- type: number
- - name: "b"
- type: number
+ - position: 1
+ name: "directionFace"
+ type: number
+ - position: 2
+ name: "r"
+ type: number
+ - position: 3
+ name: "g"
+ type: number
+ - position: 4
+ name: "b"
+ type: number
returns:
---
diff --git a/docs/libraries/Renders/SetBlend.md b/docs/libraries/Renders/SetBlend.md
index 51aa21cf21..3ef15df040 100644
--- a/docs/libraries/Renders/SetBlend.md
+++ b/docs/libraries/Renders/SetBlend.md
@@ -14,8 +14,9 @@ lua:
description: "Set the blend."
arguments:
- - name: "blend"
- type: number
+ - position: 1
+ name: "blend"
+ type: number
returns:
---
diff --git a/docs/libraries/Renders/SetClippingEnabled.md b/docs/libraries/Renders/SetClippingEnabled.md
new file mode 100644
index 0000000000..79632ad6a7
--- /dev/null
+++ b/docs/libraries/Renders/SetClippingEnabled.md
@@ -0,0 +1,26 @@
+---
+template: lua-library-function.html
+title: SetClippingEnabled
+icon: lua-client
+tags:
+ - lua
+ - client
+ - needs-verification
+ - needs-example
+lua:
+ library: Renders
+ function: SetClippingEnabled
+ realm: client
+ description: "Set the clipping enabled."
+
+ arguments:
+ - position: 1
+ name: "isEnabled"
+ type: boolean
+ returns:
+
+---
+
+
+Renders.SetClippingEnabled – Set the clipping enabled.
+
diff --git a/docs/libraries/Renders/SetColorModulation.md b/docs/libraries/Renders/SetColorModulation.md
index a2e332aed4..207e251350 100644
--- a/docs/libraries/Renders/SetColorModulation.md
+++ b/docs/libraries/Renders/SetColorModulation.md
@@ -14,12 +14,15 @@ lua:
description: "Set the color modulation."
arguments:
- - name: "r"
- type: number
- - name: "g"
- type: number
- - name: "b"
- type: number
+ - position: 1
+ name: "r"
+ type: number
+ - position: 2
+ name: "g"
+ type: number
+ - position: 3
+ name: "b"
+ type: number
returns:
---
diff --git a/docs/libraries/Renders/SetLight.md b/docs/libraries/Renders/SetLight.md
index 708efc739c..d82eab1656 100644
--- a/docs/libraries/Renders/SetLight.md
+++ b/docs/libraries/Renders/SetLight.md
@@ -14,18 +14,24 @@ lua:
description: "Set a light."
arguments:
- - name: "r"
- type: number
- - name: "g"
- type: number
- - name: "b"
- type: number
- - name: "intensity"
- type: number
- - name: "direction"
- type: Vector
- - name: "lightIndex"
- type: number
+ - position: 1
+ name: "r"
+ type: number
+ - position: 2
+ name: "g"
+ type: number
+ - position: 3
+ name: "b"
+ type: number
+ - position: 4
+ name: "intensity"
+ type: number
+ - position: 5
+ name: "direction"
+ type: Vector
+ - position: 6
+ name: "lightIndex"
+ type: number
returns:
---
diff --git a/docs/libraries/Renders/SetLightingOrigin.md b/docs/libraries/Renders/SetLightingOrigin.md
index 75a5efa683..e8ac624b61 100644
--- a/docs/libraries/Renders/SetLightingOrigin.md
+++ b/docs/libraries/Renders/SetLightingOrigin.md
@@ -14,8 +14,9 @@ lua:
description: "Set the lighting origin."
arguments:
- - name: "lightingOrigin"
- type: Vector
+ - position: 1
+ name: "lightingOrigin"
+ type: Vector
returns:
---
diff --git a/docs/libraries/Renders/SetMaterial.md b/docs/libraries/Renders/SetMaterial.md
index 8b80f33a44..9311d04967 100644
--- a/docs/libraries/Renders/SetMaterial.md
+++ b/docs/libraries/Renders/SetMaterial.md
@@ -14,8 +14,9 @@ lua:
description: "Binds a material for use in the next render operations"
arguments:
- - name: "material"
- type: Material
+ - position: 1
+ name: "material"
+ type: Material
returns:
---
diff --git a/docs/libraries/Renders/SetScissorRectangle.md b/docs/libraries/Renders/SetScissorRectangle.md
index f4df4939ed..3559a838fe 100644
--- a/docs/libraries/Renders/SetScissorRectangle.md
+++ b/docs/libraries/Renders/SetScissorRectangle.md
@@ -14,16 +14,21 @@ lua:
description: "Set the scissor rectangle."
arguments:
- - name: "left"
- type: number
- - name: "top"
- type: number
- - name: "right"
- type: number
- - name: "bottom"
- type: number
- - name: "enableScissor"
- type: boolean
+ - position: 1
+ name: "left"
+ type: number
+ - position: 2
+ name: "top"
+ type: number
+ - position: 3
+ name: "right"
+ type: number
+ - position: 4
+ name: "bottom"
+ type: number
+ - position: 5
+ name: "enableScissor"
+ type: boolean
returns:
---
diff --git a/docs/libraries/Renders/SetStencilCompareFunction.md b/docs/libraries/Renders/SetStencilCompareFunction.md
new file mode 100644
index 0000000000..1403ccf691
--- /dev/null
+++ b/docs/libraries/Renders/SetStencilCompareFunction.md
@@ -0,0 +1,26 @@
+---
+template: lua-library-function.html
+title: SetStencilCompareFunction
+icon: lua-client
+tags:
+ - lua
+ - client
+ - needs-verification
+ - needs-example
+lua:
+ library: Renders
+ function: SetStencilCompareFunction
+ realm: client
+ description: "Set the stencil compare function."
+
+ arguments:
+ - position: 1
+ name: "compareFunction"
+ type: enumeration/STENCIL_COMPARISON_FUNCTION
+ returns:
+
+---
+
+
+Renders.SetStencilCompareFunction – Set the stencil compare function.
+
diff --git a/docs/libraries/Renders/SetStencilEnable.md b/docs/libraries/Renders/SetStencilEnable.md
new file mode 100644
index 0000000000..272d936d62
--- /dev/null
+++ b/docs/libraries/Renders/SetStencilEnable.md
@@ -0,0 +1,26 @@
+---
+template: lua-library-function.html
+title: SetStencilEnable
+icon: lua-client
+tags:
+ - lua
+ - client
+ - needs-verification
+ - needs-example
+lua:
+ library: Renders
+ function: SetStencilEnable
+ realm: client
+ description: "Set the stencil enable."
+
+ arguments:
+ - position: 1
+ name: "enable"
+ type: boolean
+ returns:
+
+---
+
+
+Renders.SetStencilEnable – Set the stencil enable.
+
diff --git a/docs/libraries/Renders/SetStencilFailOperation.md b/docs/libraries/Renders/SetStencilFailOperation.md
new file mode 100644
index 0000000000..fe636b88f0
--- /dev/null
+++ b/docs/libraries/Renders/SetStencilFailOperation.md
@@ -0,0 +1,26 @@
+---
+template: lua-library-function.html
+title: SetStencilFailOperation
+icon: lua-client
+tags:
+ - lua
+ - client
+ - needs-verification
+ - needs-example
+lua:
+ library: Renders
+ function: SetStencilFailOperation
+ realm: client
+ description: "Set the stencil fail operation."
+
+ arguments:
+ - position: 1
+ name: "failOperation"
+ type: enumeration/STENCIL_OPERATION
+ returns:
+
+---
+
+
+Renders.SetStencilFailOperation – Set the stencil fail operation.
+
diff --git a/docs/libraries/Renders/SetStencilPassOperation.md b/docs/libraries/Renders/SetStencilPassOperation.md
new file mode 100644
index 0000000000..090d67d650
--- /dev/null
+++ b/docs/libraries/Renders/SetStencilPassOperation.md
@@ -0,0 +1,26 @@
+---
+template: lua-library-function.html
+title: SetStencilPassOperation
+icon: lua-client
+tags:
+ - lua
+ - client
+ - needs-verification
+ - needs-example
+lua:
+ library: Renders
+ function: SetStencilPassOperation
+ realm: client
+ description: "Set the stencil pass operation."
+
+ arguments:
+ - position: 1
+ name: "passOperation"
+ type: enumeration/STENCIL_OPERATION
+ returns:
+
+---
+
+
+Renders.SetStencilPassOperation – Set the stencil pass operation.
+
diff --git a/docs/libraries/Renders/SetStencilReferenceValue.md b/docs/libraries/Renders/SetStencilReferenceValue.md
new file mode 100644
index 0000000000..bffddea102
--- /dev/null
+++ b/docs/libraries/Renders/SetStencilReferenceValue.md
@@ -0,0 +1,26 @@
+---
+template: lua-library-function.html
+title: SetStencilReferenceValue
+icon: lua-client
+tags:
+ - lua
+ - client
+ - needs-verification
+ - needs-example
+lua:
+ library: Renders
+ function: SetStencilReferenceValue
+ realm: client
+ description: "Set the stencil reference value."
+
+ arguments:
+ - position: 1
+ name: "referenceValue"
+ type: number
+ returns:
+
+---
+
+
+Renders.SetStencilReferenceValue – Set the stencil reference value.
+
diff --git a/docs/libraries/Renders/SetStencilTestMask.md b/docs/libraries/Renders/SetStencilTestMask.md
new file mode 100644
index 0000000000..7588b7d014
--- /dev/null
+++ b/docs/libraries/Renders/SetStencilTestMask.md
@@ -0,0 +1,26 @@
+---
+template: lua-library-function.html
+title: SetStencilTestMask
+icon: lua-client
+tags:
+ - lua
+ - client
+ - needs-verification
+ - needs-example
+lua:
+ library: Renders
+ function: SetStencilTestMask
+ realm: client
+ description: "Set the stencil test mask."
+
+ arguments:
+ - position: 1
+ name: "testMask"
+ type: number
+ returns:
+
+---
+
+
+Renders.SetStencilTestMask – Set the stencil test mask.
+
diff --git a/docs/libraries/Renders/SetStencilWriteMask.md b/docs/libraries/Renders/SetStencilWriteMask.md
new file mode 100644
index 0000000000..4e33ecafe9
--- /dev/null
+++ b/docs/libraries/Renders/SetStencilWriteMask.md
@@ -0,0 +1,26 @@
+---
+template: lua-library-function.html
+title: SetStencilWriteMask
+icon: lua-client
+tags:
+ - lua
+ - client
+ - needs-verification
+ - needs-example
+lua:
+ library: Renders
+ function: SetStencilWriteMask
+ realm: client
+ description: "Set the stencil write mask."
+
+ arguments:
+ - position: 1
+ name: "writeMask"
+ type: number
+ returns:
+
+---
+
+
+Renders.SetStencilWriteMask – Set the stencil write mask.
+
diff --git a/docs/libraries/Renders/SetStencilZFailOperation.md b/docs/libraries/Renders/SetStencilZFailOperation.md
new file mode 100644
index 0000000000..3852207be6
--- /dev/null
+++ b/docs/libraries/Renders/SetStencilZFailOperation.md
@@ -0,0 +1,26 @@
+---
+template: lua-library-function.html
+title: SetStencilZFailOperation
+icon: lua-client
+tags:
+ - lua
+ - client
+ - needs-verification
+ - needs-example
+lua:
+ library: Renders
+ function: SetStencilZFailOperation
+ realm: client
+ description: "Set the stencil z fail operation."
+
+ arguments:
+ - position: 1
+ name: "zFailOperation"
+ type: enumeration/STENCIL_OPERATION
+ returns:
+
+---
+
+
+Renders.SetStencilZFailOperation – Set the stencil z fail operation.
+
diff --git a/docs/libraries/Renders/SetWriteDepthToDestinationAlpha.md b/docs/libraries/Renders/SetWriteDepthToDestinationAlpha.md
index 26d6805645..eceb8b19a7 100644
--- a/docs/libraries/Renders/SetWriteDepthToDestinationAlpha.md
+++ b/docs/libraries/Renders/SetWriteDepthToDestinationAlpha.md
@@ -14,8 +14,9 @@ lua:
description: "Set the write depth to destination alpha."
arguments:
- - name: "enable"
- type: boolean
+ - position: 1
+ name: "enable"
+ type: boolean
returns:
---
diff --git a/docs/libraries/Renders/SpawnBeam.md b/docs/libraries/Renders/SpawnBeam.md
index bdd47ff7a6..fe99d68307 100644
--- a/docs/libraries/Renders/SpawnBeam.md
+++ b/docs/libraries/Renders/SpawnBeam.md
@@ -14,32 +14,45 @@ lua:
description: "Spawns a temporary beam entity to render a beam. The alpha of the color servers as the brightness of it."
arguments:
- - name: "start"
- type: Vector
- - name: "end"
- type: Vector
- - name: "modelIndex"
- type: number
- - name: "haloIndex"
- type: number
- - name: "frameStart"
- type: number
- - name: "frameRate"
- type: number
- - name: "life"
- type: number
- - name: "width"
- type: number
- - name: "endWidth"
- type: number
- - name: "fadeLength"
- type: number
- - name: "noise"
- type: number
- - name: "colorAndBrightness"
- type: Color
- - name: "speed"
- type: number
+ - position: 1
+ name: "start"
+ type: Vector
+ - position: 2
+ name: "end"
+ type: Vector
+ - position: 3
+ name: "modelIndex"
+ type: number
+ - position: 4
+ name: "haloIndex"
+ type: number
+ - position: 5
+ name: "frameStart"
+ type: number
+ - position: 6
+ name: "frameRate"
+ type: number
+ - position: 7
+ name: "life"
+ type: number
+ - position: 8
+ name: "width"
+ type: number
+ - position: 9
+ name: "endWidth"
+ type: number
+ - position: 10
+ name: "fadeLength"
+ type: number
+ - position: 11
+ name: "noise"
+ type: number
+ - position: 12
+ name: "colorAndBrightness"
+ type: Color
+ - position: 13
+ name: "speed"
+ type: number
returns:
---
diff --git a/docs/libraries/Renders/SuppressEngineLighting.md b/docs/libraries/Renders/SuppressEngineLighting.md
index 0a3bc45194..7e7f6b8a75 100644
--- a/docs/libraries/Renders/SuppressEngineLighting.md
+++ b/docs/libraries/Renders/SuppressEngineLighting.md
@@ -14,8 +14,9 @@ lua:
description: "Suppress engine lighting."
arguments:
- - name: "suppress"
- type: boolean
+ - position: 1
+ name: "suppress"
+ type: boolean
returns:
---
diff --git a/docs/libraries/Renders/UpdateScreenEffectTexture.md b/docs/libraries/Renders/UpdateScreenEffectTexture.md
index 2da1f9f0f2..666d05f95f 100644
--- a/docs/libraries/Renders/UpdateScreenEffectTexture.md
+++ b/docs/libraries/Renders/UpdateScreenEffectTexture.md
@@ -14,8 +14,10 @@ lua:
description: "Update the screen effect texture."
arguments:
- - name: "textureIndex"
- type: number
+ - position: 1
+ name: "textureIndex"
+ type: number
+ default: "0"
returns:
---
diff --git a/docs/libraries/Resources/AddFile.md b/docs/libraries/Resources/AddFile.md
index 4288c13009..07aaf34ef3 100644
--- a/docs/libraries/Resources/AddFile.md
+++ b/docs/libraries/Resources/AddFile.md
@@ -14,8 +14,9 @@ lua:
description: "Add a file to the list of resources so it's downloaded when players connect to the server. For convenience .vmt and .mdl will also add the related .vtf/.png/.jpg and model files (.vvd, .ani, .dx80.vtx, .dx90.vtx, .sw.vtx, .phy) with the same name. It will warn for each missing file."
arguments:
- - name: "filePath"
- type: string
+ - position: 1
+ name: "filePath"
+ type: string
returns:
---
diff --git a/docs/libraries/Resources/AddSingleFile.md b/docs/libraries/Resources/AddSingleFile.md
index ec711acc07..9789cf2435 100644
--- a/docs/libraries/Resources/AddSingleFile.md
+++ b/docs/libraries/Resources/AddSingleFile.md
@@ -14,8 +14,9 @@ lua:
description: "Add a file to the list of resources so it's downloaded when players connect to the server."
arguments:
- - name: "filePath"
- type: string
+ - position: 1
+ name: "filePath"
+ type: string
returns:
---
diff --git a/docs/libraries/Resources/GetFiles.md b/docs/libraries/Resources/GetFiles.md
index 64305a4bfe..125d0e2ceb 100644
--- a/docs/libraries/Resources/GetFiles.md
+++ b/docs/libraries/Resources/GetFiles.md
@@ -13,6 +13,7 @@ lua:
realm: server
description: "Get the list of files added with Resources.AddFile."
+ arguments:
returns:
- type: table
diff --git a/docs/libraries/Schemes/GetDefaultScheme.md b/docs/libraries/Schemes/GetDefaultScheme.md
index 672194ef54..bccfc2cc0d 100644
--- a/docs/libraries/Schemes/GetDefaultScheme.md
+++ b/docs/libraries/Schemes/GetDefaultScheme.md
@@ -13,6 +13,7 @@ lua:
realm: client
description: "Returns the default scheme."
+ arguments:
returns:
- type: scheme
diff --git a/docs/libraries/Schemes/GetProportionalNormalizedValue.md b/docs/libraries/Schemes/GetProportionalNormalizedValue.md
index 93ee49050f..5c2cd9a505 100644
--- a/docs/libraries/Schemes/GetProportionalNormalizedValue.md
+++ b/docs/libraries/Schemes/GetProportionalNormalizedValue.md
@@ -14,8 +14,9 @@ lua:
description: "Returns the proportional normalized value."
arguments:
- - name: "scaledValue"
- type: number
+ - position: 1
+ name: "scaledValue"
+ type: number
returns:
- type: integer
description: "The proportional normalized value."
diff --git a/docs/libraries/Schemes/GetProportionalScaledValue.md b/docs/libraries/Schemes/GetProportionalScaledValue.md
index da336b8b9d..cc252f687d 100644
--- a/docs/libraries/Schemes/GetProportionalScaledValue.md
+++ b/docs/libraries/Schemes/GetProportionalScaledValue.md
@@ -14,8 +14,9 @@ lua:
description: "Returns the proportional scaled value."
arguments:
- - name: "normalizedValue"
- type: number
+ - position: 1
+ name: "normalizedValue"
+ type: number
returns:
- type: integer
description: "The proportional scaled value."
diff --git a/docs/libraries/Schemes/GetScheme.md b/docs/libraries/Schemes/GetScheme.md
index b762698391..3e7220175e 100644
--- a/docs/libraries/Schemes/GetScheme.md
+++ b/docs/libraries/Schemes/GetScheme.md
@@ -14,8 +14,9 @@ lua:
description: "Returns the scheme for the specified scheme name."
arguments:
- - name: "schemeName"
- type: string
+ - position: 1
+ name: "schemeName"
+ type: string
returns:
- type: scheme
description: "The scheme for the specified scheme name."
diff --git a/docs/libraries/Schemes/LoadSchemeFromFile.md b/docs/libraries/Schemes/LoadSchemeFromFile.md
index 9a4f9f440a..b5aa135be4 100644
--- a/docs/libraries/Schemes/LoadSchemeFromFile.md
+++ b/docs/libraries/Schemes/LoadSchemeFromFile.md
@@ -14,10 +14,12 @@ lua:
description: "Loads the scheme from the specified file."
arguments:
- - name: "fileName"
- type: string
- - name: "tag"
- type: string
+ - position: 1
+ name: "fileName"
+ type: string
+ - position: 2
+ name: "tag"
+ type: string
returns:
- type: scheme
description: "The scheme loaded from the specified file."
diff --git a/docs/libraries/Schemes/LoadSchemeFromFileEx.md b/docs/libraries/Schemes/LoadSchemeFromFileEx.md
index c06c9d2249..7b921783ac 100644
--- a/docs/libraries/Schemes/LoadSchemeFromFileEx.md
+++ b/docs/libraries/Schemes/LoadSchemeFromFileEx.md
@@ -14,12 +14,15 @@ lua:
description: "Loads the scheme from the specified file."
arguments:
- - name: "sizingPanel"
- type: Panel
- - name: "fileName"
- type: string
- - name: "tag"
- type: string
+ - position: 1
+ name: "sizingPanel"
+ type: Panel
+ - position: 2
+ name: "fileName"
+ type: string
+ - position: 3
+ name: "tag"
+ type: string
returns:
- type: scheme
description: "The scheme loaded from the specified file."
diff --git a/docs/libraries/Schemes/ReloadFonts.md b/docs/libraries/Schemes/ReloadFonts.md
index e9143b22a0..5717c66c7b 100644
--- a/docs/libraries/Schemes/ReloadFonts.md
+++ b/docs/libraries/Schemes/ReloadFonts.md
@@ -13,6 +13,7 @@ lua:
realm: client
description: "Reloads the fonts."
+ arguments:
returns:
diff --git a/docs/libraries/Schemes/ReloadSchemes.md b/docs/libraries/Schemes/ReloadSchemes.md
index c07a878a06..afbb43bc64 100644
--- a/docs/libraries/Schemes/ReloadSchemes.md
+++ b/docs/libraries/Schemes/ReloadSchemes.md
@@ -13,6 +13,7 @@ lua:
realm: client
description: "Reloads the schemes."
+ arguments:
returns:
diff --git a/docs/libraries/Serializers/Base64Decode.md b/docs/libraries/Serializers/Base64Decode.md
index 8bfe9fc3dd..7bbf614d4e 100644
--- a/docs/libraries/Serializers/Base64Decode.md
+++ b/docs/libraries/Serializers/Base64Decode.md
@@ -14,8 +14,9 @@ lua:
description: "Decode a base64 encoded string"
arguments:
- - name: "string"
- type: string
+ - position: 1
+ name: "string"
+ type: string
returns:
- type: string
description: "Decoded string."
diff --git a/docs/libraries/Serializers/Base64Encode.md b/docs/libraries/Serializers/Base64Encode.md
index 93ced748a7..054cc52ecc 100644
--- a/docs/libraries/Serializers/Base64Encode.md
+++ b/docs/libraries/Serializers/Base64Encode.md
@@ -14,11 +14,13 @@ lua:
description: "Encode a string to base64"
arguments:
- - name: "string"
- type: string
- - name: "disableRfc2045Compliance"
- type: boolean
- default: "false"
+ - position: 1
+ name: "string"
+ type: string
+ - position: 2
+ name: "disableRfc2045Compliance"
+ type: boolean
+ default: "false"
returns:
- type: string
description: "Base64 encoded string."
diff --git a/docs/libraries/Serializers/Crc32.md b/docs/libraries/Serializers/Crc32.md
index 1c86556523..132ce08d3b 100644
--- a/docs/libraries/Serializers/Crc32.md
+++ b/docs/libraries/Serializers/Crc32.md
@@ -14,8 +14,9 @@ lua:
description: "Compute the CRC32 of a string"
arguments:
- - name: "string"
- type: string
+ - position: 1
+ name: "string"
+ type: string
returns:
- type: integer
description: "CRC32 of the string."
diff --git a/docs/libraries/Serializers/JsonEncode.md b/docs/libraries/Serializers/JsonEncode.md
index 242b3dd864..7b5c131902 100644
--- a/docs/libraries/Serializers/JsonEncode.md
+++ b/docs/libraries/Serializers/JsonEncode.md
@@ -13,6 +13,7 @@ lua:
realm: shared
description: "Encode a lua table to JSON"
+ arguments:
returns:
- type: string
diff --git a/docs/libraries/Serializers/LzmaCompress.md b/docs/libraries/Serializers/LzmaCompress.md
new file mode 100644
index 0000000000..17fe2519db
--- /dev/null
+++ b/docs/libraries/Serializers/LzmaCompress.md
@@ -0,0 +1,27 @@
+---
+template: lua-library-function.html
+title: LzmaCompress
+icon: lua-shared
+tags:
+ - lua
+ - shared
+ - needs-verification
+ - needs-example
+lua:
+ library: Serializers
+ function: LzmaCompress
+ realm: shared
+ description: "Compress a string using LZMA"
+
+ arguments:
+ - position: 1
+ name: "string"
+ type: string
+ returns:
+ - type: string
+ description: "Compressed string."
+---
+
+
+Serializers.LzmaCompress – Compress a string using LZMA
+
diff --git a/docs/libraries/Serializers/LzmaDecompress.md b/docs/libraries/Serializers/LzmaDecompress.md
new file mode 100644
index 0000000000..9bcd9eb9d1
--- /dev/null
+++ b/docs/libraries/Serializers/LzmaDecompress.md
@@ -0,0 +1,27 @@
+---
+template: lua-library-function.html
+title: LzmaDecompress
+icon: lua-shared
+tags:
+ - lua
+ - shared
+ - needs-verification
+ - needs-example
+lua:
+ library: Serializers
+ function: LzmaDecompress
+ realm: shared
+ description: "Decompress a string using LZMA"
+
+ arguments:
+ - position: 1
+ name: "compressedString"
+ type: string
+ returns:
+ - type: string
+ description: "Decompressed string."
+---
+
+
+Serializers.LzmaDecompress – Decompress a string using LZMA
+
diff --git a/docs/libraries/Sounds/Add.md b/docs/libraries/Sounds/Add.md
index b86a28ff5d..b76e0eacef 100644
--- a/docs/libraries/Sounds/Add.md
+++ b/docs/libraries/Sounds/Add.md
@@ -14,8 +14,9 @@ lua:
description: "Creates a sound script."
arguments:
- - name: "soundData"
- type: table
+ - position: 1
+ name: "soundData"
+ type: table
returns:
---
diff --git a/docs/libraries/Sounds/Play.md b/docs/libraries/Sounds/Play.md
new file mode 100644
index 0000000000..cff9e019ad
--- /dev/null
+++ b/docs/libraries/Sounds/Play.md
@@ -0,0 +1,45 @@
+---
+template: lua-library-function.html
+title: Play
+icon: lua-shared
+tags:
+ - lua
+ - shared
+ - needs-verification
+ - needs-example
+lua:
+ library: Sounds
+ function: Play
+ realm: shared
+ description: "Plays a sound emitting from a place in the world. Not properly tested for sound script names (didn't work when I tried it)"
+
+ arguments:
+ - position: 1
+ name: "soundName"
+ type: string
+ - position: 2
+ name: "origin"
+ type: Vector
+ - position: 3
+ name: "soundLevel"
+ type: enumeration/SOUND_LEVEL
+ default: "SNDLVL_NORM"
+ - position: 4
+ name: "pitchPercent"
+ type: number
+ default: "100"
+ - position: 5
+ name: "volume"
+ type: number
+ default: "1"
+ - position: 6
+ name: "dsp"
+ type: number
+ default: "0"
+ returns:
+
+---
+
+
+Sounds.Play – Plays a sound emitting from a place in the world. Not properly tested for sound script names (didn't work when I tried it)
+
diff --git a/docs/libraries/Sounds/PlayFile.md b/docs/libraries/Sounds/PlayFile.md
new file mode 100644
index 0000000000..cc9c256615
--- /dev/null
+++ b/docs/libraries/Sounds/PlayFile.md
@@ -0,0 +1,30 @@
+---
+template: lua-library-function.html
+title: PlayFile
+icon: lua-client
+tags:
+ - lua
+ - client
+ - needs-verification
+ - needs-example
+lua:
+ library: Sounds
+ function: PlayFile
+ realm: client
+ description: "Plays a sound from a file."
+
+ arguments:
+ - position: 1
+ name: "file"
+ type: string
+ - position: 2
+ name: "flags"
+ type: integer
+ default: "PLAY_SOUND_FLAG::STREAM_BLOCK"
+ returns:
+
+---
+
+
+Sounds.PlayFile – Plays a sound from a file.
+
diff --git a/docs/libraries/Sounds/PlayUrl.md b/docs/libraries/Sounds/PlayUrl.md
new file mode 100644
index 0000000000..c794808dc5
--- /dev/null
+++ b/docs/libraries/Sounds/PlayUrl.md
@@ -0,0 +1,30 @@
+---
+template: lua-library-function.html
+title: PlayUrl
+icon: lua-client
+tags:
+ - lua
+ - client
+ - needs-verification
+ - needs-example
+lua:
+ library: Sounds
+ function: PlayUrl
+ realm: client
+ description: "Plays a sound from a URL."
+
+ arguments:
+ - position: 1
+ name: "url"
+ type: string
+ - position: 2
+ name: "flags"
+ type: integer
+ default: "PLAY_SOUND_FLAG::STREAM_BLOCK"
+ returns:
+
+---
+
+
+Sounds.PlayUrl – Plays a sound from a URL.
+
diff --git a/docs/libraries/SteamApiContexts/SteamFriends.md b/docs/libraries/SteamApiContexts/SteamFriends.md
index d3250487a2..6f32ef73b6 100644
--- a/docs/libraries/SteamApiContexts/SteamFriends.md
+++ b/docs/libraries/SteamApiContexts/SteamFriends.md
@@ -13,6 +13,7 @@ lua:
realm: shared
description: "Get Steam Friends."
+ arguments:
returns:
- type: SteamFriendsHandle
diff --git a/docs/libraries/Surfaces/AddBitmapFontFile.md b/docs/libraries/Surfaces/AddBitmapFontFile.md
index 27f090c35b..715ac34dca 100644
--- a/docs/libraries/Surfaces/AddBitmapFontFile.md
+++ b/docs/libraries/Surfaces/AddBitmapFontFile.md
@@ -14,8 +14,9 @@ lua:
description: "Adds a bitmap font file to the list of fonts."
arguments:
- - name: "fontFileName"
- type: string
+ - position: 1
+ name: "fontFileName"
+ type: string
returns:
- type: boolean
description: "True if the font was added, false otherwise."
diff --git a/docs/libraries/Surfaces/AddCustomFontFile.md b/docs/libraries/Surfaces/AddCustomFontFile.md
index 282bb7555f..5e9455b0a6 100644
--- a/docs/libraries/Surfaces/AddCustomFontFile.md
+++ b/docs/libraries/Surfaces/AddCustomFontFile.md
@@ -14,10 +14,12 @@ lua:
description: "Adds a custom font file to the list of fonts."
arguments:
- - name: "fontFileName"
- type: string
- - name: "fontName"
- type: string
+ - position: 1
+ name: "fontFileName"
+ type: string
+ - position: 2
+ name: "fontName"
+ type: string
returns:
- type: boolean
description: "True if the font was added, false otherwise."
diff --git a/docs/libraries/Surfaces/AddPanel.md b/docs/libraries/Surfaces/AddPanel.md
index 531c1db2c0..1b8dbef538 100644
--- a/docs/libraries/Surfaces/AddPanel.md
+++ b/docs/libraries/Surfaces/AddPanel.md
@@ -14,8 +14,9 @@ lua:
description: "Adds a panel to the surface."
arguments:
- - name: "panel"
- type: Panel
+ - position: 1
+ name: "panel"
+ type: Panel
returns:
---
diff --git a/docs/libraries/Surfaces/ApplyChanges.md b/docs/libraries/Surfaces/ApplyChanges.md
index bca2710462..0a8c870e20 100644
--- a/docs/libraries/Surfaces/ApplyChanges.md
+++ b/docs/libraries/Surfaces/ApplyChanges.md
@@ -13,6 +13,7 @@ lua:
realm: client
description: "Applies changes to the surface."
+ arguments:
returns:
diff --git a/docs/libraries/Surfaces/BringToFront.md b/docs/libraries/Surfaces/BringToFront.md
index c292cae88d..8e62554c1a 100644
--- a/docs/libraries/Surfaces/BringToFront.md
+++ b/docs/libraries/Surfaces/BringToFront.md
@@ -14,8 +14,9 @@ lua:
description: "Brings the panel to the front."
arguments:
- - name: "panel"
- type: Panel
+ - position: 1
+ name: "panel"
+ type: Panel
returns:
---
diff --git a/docs/libraries/Surfaces/CalculateMouseVisible.md b/docs/libraries/Surfaces/CalculateMouseVisible.md
index c6145b1417..9a179eaf33 100644
--- a/docs/libraries/Surfaces/CalculateMouseVisible.md
+++ b/docs/libraries/Surfaces/CalculateMouseVisible.md
@@ -13,6 +13,7 @@ lua:
realm: client
description: "Calculates if the mouse is visible."
+ arguments:
returns:
diff --git a/docs/libraries/Surfaces/ClearTemporaryFontCache.md b/docs/libraries/Surfaces/ClearTemporaryFontCache.md
index 19e881b127..1eacc6c86d 100644
--- a/docs/libraries/Surfaces/ClearTemporaryFontCache.md
+++ b/docs/libraries/Surfaces/ClearTemporaryFontCache.md
@@ -13,6 +13,7 @@ lua:
realm: client
description: "Clears the temporary font cache."
+ arguments:
returns:
diff --git a/docs/libraries/Surfaces/CreateFont.md b/docs/libraries/Surfaces/CreateFont.md
index d7776b7955..f0c4bfeee2 100644
--- a/docs/libraries/Surfaces/CreateFont.md
+++ b/docs/libraries/Surfaces/CreateFont.md
@@ -13,6 +13,7 @@ lua:
realm: client
description: "Creates a new font."
+ arguments:
returns:
- type: font
diff --git a/docs/libraries/Surfaces/CreateNewTextureID.md b/docs/libraries/Surfaces/CreateNewTextureID.md
index 9d7601fb1b..28bc1d9035 100644
--- a/docs/libraries/Surfaces/CreateNewTextureID.md
+++ b/docs/libraries/Surfaces/CreateNewTextureID.md
@@ -14,9 +14,10 @@ lua:
description: "Creates a new texture ID."
arguments:
- - name: "procedural"
- type: boolean
- default: "false"
+ - position: 1
+ name: "procedural"
+ type: boolean
+ default: "false"
returns:
- type: integer
description: "The new texture ID."
diff --git a/docs/libraries/Surfaces/CreatePopup.md b/docs/libraries/Surfaces/CreatePopup.md
index a6d49857a6..d74e93318b 100644
--- a/docs/libraries/Surfaces/CreatePopup.md
+++ b/docs/libraries/Surfaces/CreatePopup.md
@@ -14,22 +14,28 @@ lua:
description: "Creates a popup."
arguments:
- - name: "panel"
- type: Panel
- - name: "isMinimized"
- type: boolean
- - name: "shouldShowTaskbarIcon"
- type: boolean
- default: "true"
- - name: "isDisabled"
- type: boolean
- default: "false"
- - name: "hasMouseInput"
- type: boolean
- default: "true"
- - name: "hasKeyboardInput"
- type: boolean
- default: "true"
+ - position: 1
+ name: "panel"
+ type: Panel
+ - position: 2
+ name: "isMinimized"
+ type: boolean
+ - position: 3
+ name: "shouldShowTaskbarIcon"
+ type: boolean
+ default: "true"
+ - position: 4
+ name: "isDisabled"
+ type: boolean
+ default: "false"
+ - position: 5
+ name: "hasMouseInput"
+ type: boolean
+ default: "true"
+ - position: 6
+ name: "hasKeyboardInput"
+ type: boolean
+ default: "true"
returns:
---
diff --git a/docs/libraries/Surfaces/DisableClipping.md b/docs/libraries/Surfaces/DisableClipping.md
index 58a3503f93..bb07e41bc2 100644
--- a/docs/libraries/Surfaces/DisableClipping.md
+++ b/docs/libraries/Surfaces/DisableClipping.md
@@ -14,8 +14,9 @@ lua:
description: "Disables clipping"
arguments:
- - name: "shouldDisable"
- type: boolean
+ - position: 1
+ name: "shouldDisable"
+ type: boolean
returns:
- type: boolean
description: "The previous clipping state"
diff --git a/docs/libraries/Surfaces/DrawFilledRectangle.md b/docs/libraries/Surfaces/DrawFilledRectangle.md
index a6d3f13710..0cc5649631 100644
--- a/docs/libraries/Surfaces/DrawFilledRectangle.md
+++ b/docs/libraries/Surfaces/DrawFilledRectangle.md
@@ -14,14 +14,18 @@ lua:
description: "Draws a filled rectangle"
arguments:
- - name: "x"
- type: number
- - name: "y"
- type: number
- - name: "width"
- type: number
- - name: "height"
- type: number
+ - position: 1
+ name: "x"
+ type: number
+ - position: 2
+ name: "y"
+ type: number
+ - position: 3
+ name: "width"
+ type: number
+ - position: 4
+ name: "height"
+ type: number
returns:
---
diff --git a/docs/libraries/Surfaces/DrawFilledRectangleFade.md b/docs/libraries/Surfaces/DrawFilledRectangleFade.md
index 898a67a785..2b89008456 100644
--- a/docs/libraries/Surfaces/DrawFilledRectangleFade.md
+++ b/docs/libraries/Surfaces/DrawFilledRectangleFade.md
@@ -14,20 +14,27 @@ lua:
description: "Draws a filled rectangle with a fade"
arguments:
- - name: "x"
- type: number
- - name: "y"
- type: number
- - name: "width"
- type: number
- - name: "height"
- type: number
- - name: "alpha1"
- type: number
- - name: "alpha2"
- type: number
- - name: "horizontal"
- type: boolean
+ - position: 1
+ name: "x"
+ type: number
+ - position: 2
+ name: "y"
+ type: number
+ - position: 3
+ name: "width"
+ type: number
+ - position: 4
+ name: "height"
+ type: number
+ - position: 5
+ name: "alpha1"
+ type: number
+ - position: 6
+ name: "alpha2"
+ type: number
+ - position: 7
+ name: "horizontal"
+ type: boolean
returns:
---
diff --git a/docs/libraries/Surfaces/DrawFlushText.md b/docs/libraries/Surfaces/DrawFlushText.md
index ef687deb23..fce1d2d31a 100644
--- a/docs/libraries/Surfaces/DrawFlushText.md
+++ b/docs/libraries/Surfaces/DrawFlushText.md
@@ -13,6 +13,7 @@ lua:
realm: client
description: "Flushes the text"
+ arguments:
returns:
diff --git a/docs/libraries/Surfaces/DrawGetAlphaMultiplier.md b/docs/libraries/Surfaces/DrawGetAlphaMultiplier.md
index 9650ead49b..6a9f344488 100644
--- a/docs/libraries/Surfaces/DrawGetAlphaMultiplier.md
+++ b/docs/libraries/Surfaces/DrawGetAlphaMultiplier.md
@@ -13,6 +13,7 @@ lua:
realm: client
description: "Gets the alpha multiplier"
+ arguments:
returns:
- type: number
diff --git a/docs/libraries/Surfaces/DrawGetTextPosition.md b/docs/libraries/Surfaces/DrawGetTextPosition.md
index 02ac084cf5..8210bd1f0e 100644
--- a/docs/libraries/Surfaces/DrawGetTextPosition.md
+++ b/docs/libraries/Surfaces/DrawGetTextPosition.md
@@ -13,6 +13,7 @@ lua:
realm: client
description: "Gets the text position"
+ arguments:
returns:
- type: integer
diff --git a/docs/libraries/Surfaces/DrawGetTextureFile.md b/docs/libraries/Surfaces/DrawGetTextureFile.md
index 26566e4fe4..910fbcca5a 100644
--- a/docs/libraries/Surfaces/DrawGetTextureFile.md
+++ b/docs/libraries/Surfaces/DrawGetTextureFile.md
@@ -14,8 +14,9 @@ lua:
description: "Gets the texture file"
arguments:
- - name: "textureId"
- type: number
+ - position: 1
+ name: "textureId"
+ type: number
returns:
- type: boolean
description: "True if the texture file was found, false otherwise."
diff --git a/docs/libraries/Surfaces/DrawGetTextureId.md b/docs/libraries/Surfaces/DrawGetTextureId.md
index 7bbe685c70..c3bcb8e00f 100644
--- a/docs/libraries/Surfaces/DrawGetTextureId.md
+++ b/docs/libraries/Surfaces/DrawGetTextureId.md
@@ -14,8 +14,9 @@ lua:
description: "Gets the texture ID"
arguments:
- - name: "texturePath"
- type: string
+ - position: 1
+ name: "texturePath"
+ type: string
returns:
- type: integer
description: "The texture ID"
diff --git a/docs/libraries/Surfaces/DrawGetTextureSize.md b/docs/libraries/Surfaces/DrawGetTextureSize.md
index 9a71572768..05d6574f9d 100644
--- a/docs/libraries/Surfaces/DrawGetTextureSize.md
+++ b/docs/libraries/Surfaces/DrawGetTextureSize.md
@@ -14,8 +14,9 @@ lua:
description: "Gets the texture size"
arguments:
- - name: "textureId"
- type: number
+ - position: 1
+ name: "textureId"
+ type: number
returns:
- type: integer
description: "The width of the texture"
diff --git a/docs/libraries/Surfaces/DrawLine.md b/docs/libraries/Surfaces/DrawLine.md
index 923b4456fc..bd51b796d8 100644
--- a/docs/libraries/Surfaces/DrawLine.md
+++ b/docs/libraries/Surfaces/DrawLine.md
@@ -14,14 +14,18 @@ lua:
description: "Draws a line"
arguments:
- - name: "x0"
- type: number
- - name: "y0"
- type: number
- - name: "x1"
- type: number
- - name: "y1"
- type: number
+ - position: 1
+ name: "x0"
+ type: number
+ - position: 2
+ name: "y0"
+ type: number
+ - position: 3
+ name: "x1"
+ type: number
+ - position: 4
+ name: "y1"
+ type: number
returns:
---
diff --git a/docs/libraries/Surfaces/DrawOutlinedCircle.md b/docs/libraries/Surfaces/DrawOutlinedCircle.md
index 2a9312d630..f39a32d02e 100644
--- a/docs/libraries/Surfaces/DrawOutlinedCircle.md
+++ b/docs/libraries/Surfaces/DrawOutlinedCircle.md
@@ -14,14 +14,18 @@ lua:
description: "Draws an outlined circle"
arguments:
- - name: "x"
- type: number
- - name: "y"
- type: number
- - name: "radius"
- type: number
- - name: "segments"
- type: number
+ - position: 1
+ name: "x"
+ type: number
+ - position: 2
+ name: "y"
+ type: number
+ - position: 3
+ name: "radius"
+ type: number
+ - position: 4
+ name: "segments"
+ type: number
returns:
---
diff --git a/docs/libraries/Surfaces/DrawOutlinedRectangle.md b/docs/libraries/Surfaces/DrawOutlinedRectangle.md
index 6b34c9c5ec..5c58660fa5 100644
--- a/docs/libraries/Surfaces/DrawOutlinedRectangle.md
+++ b/docs/libraries/Surfaces/DrawOutlinedRectangle.md
@@ -14,14 +14,18 @@ lua:
description: "Draws an outlined rectangle"
arguments:
- - name: "x"
- type: number
- - name: "y"
- type: number
- - name: "width"
- type: number
- - name: "height"
- type: number
+ - position: 1
+ name: "x"
+ type: number
+ - position: 2
+ name: "y"
+ type: number
+ - position: 3
+ name: "width"
+ type: number
+ - position: 4
+ name: "height"
+ type: number
returns:
---
diff --git a/docs/libraries/Surfaces/DrawPrintText.md b/docs/libraries/Surfaces/DrawPrintText.md
index e14660fbe8..e6bb68d454 100644
--- a/docs/libraries/Surfaces/DrawPrintText.md
+++ b/docs/libraries/Surfaces/DrawPrintText.md
@@ -14,11 +14,13 @@ lua:
description: "Prints text"
arguments:
- - name: "text"
- type: string
- - name: "drawType"
- type: enumeration/FONT_DRAW_TYPE
- default: "FONT_DRAW_DEFAULT"
+ - position: 1
+ name: "text"
+ type: string
+ - position: 2
+ name: "drawType"
+ type: enumeration/FONT_DRAW_TYPE
+ default: "FONT_DRAW_DEFAULT"
returns:
---
diff --git a/docs/libraries/Surfaces/DrawSetAlphaMultiplier.md b/docs/libraries/Surfaces/DrawSetAlphaMultiplier.md
index 94c71127ed..6f386ac7bb 100644
--- a/docs/libraries/Surfaces/DrawSetAlphaMultiplier.md
+++ b/docs/libraries/Surfaces/DrawSetAlphaMultiplier.md
@@ -14,8 +14,9 @@ lua:
description: "Sets the alpha multiplier"
arguments:
- - name: "alphaMultiplier"
- type: number
+ - position: 1
+ name: "alphaMultiplier"
+ type: number
returns:
---
diff --git a/docs/libraries/Surfaces/DrawSetColor.md b/docs/libraries/Surfaces/DrawSetColor.md
index 5a7fb44be0..44838c5dc6 100644
--- a/docs/libraries/Surfaces/DrawSetColor.md
+++ b/docs/libraries/Surfaces/DrawSetColor.md
@@ -13,20 +13,23 @@ lua:
realm: client
description: "Sets the color"
- argumentSets:
- - arguments:
+ arguments:
+ - position: 1
+ types:
- name: "red"
type: number
- - name: "green"
- type: number
- - name: "blue"
- type: number
- - name: "alpha"
- type: number
- default: "255"
- - arguments:
- name: "color"
type: Color
+ - position: 2
+ name: "green"
+ type: number
+ - position: 3
+ name: "blue"
+ type: number
+ - position: 4
+ name: "alpha"
+ type: number
+ default: "255"
returns:
---
diff --git a/docs/libraries/Surfaces/DrawSetTextColor.md b/docs/libraries/Surfaces/DrawSetTextColor.md
index a2b998b77b..b5919c12bd 100644
--- a/docs/libraries/Surfaces/DrawSetTextColor.md
+++ b/docs/libraries/Surfaces/DrawSetTextColor.md
@@ -13,20 +13,23 @@ lua:
realm: client
description: "Sets the text color"
- argumentSets:
- - arguments:
+ arguments:
+ - position: 1
+ types:
- name: "red"
type: number
- - name: "green"
- type: number
- - name: "blue"
- type: number
- - name: "alpha"
- type: number
- default: "255"
- - arguments:
- name: "color"
type: Color
+ - position: 2
+ name: "green"
+ type: number
+ - position: 3
+ name: "blue"
+ type: number
+ - position: 4
+ name: "alpha"
+ type: number
+ default: "255"
returns:
---
diff --git a/docs/libraries/Surfaces/DrawSetTextFont.md b/docs/libraries/Surfaces/DrawSetTextFont.md
index 3c013a276f..15b26b43ee 100644
--- a/docs/libraries/Surfaces/DrawSetTextFont.md
+++ b/docs/libraries/Surfaces/DrawSetTextFont.md
@@ -14,8 +14,9 @@ lua:
description: "Sets the text font"
arguments:
- - name: "font"
- type: FontHandle
+ - position: 1
+ name: "font"
+ type: FontHandle
returns:
---
diff --git a/docs/libraries/Surfaces/DrawSetTextPosition.md b/docs/libraries/Surfaces/DrawSetTextPosition.md
index 1d28e3169d..bbb2aec75a 100644
--- a/docs/libraries/Surfaces/DrawSetTextPosition.md
+++ b/docs/libraries/Surfaces/DrawSetTextPosition.md
@@ -14,10 +14,12 @@ lua:
description: "Sets the text position"
arguments:
- - name: "x"
- type: number
- - name: "y"
- type: number
+ - position: 1
+ name: "x"
+ type: number
+ - position: 2
+ name: "y"
+ type: number
returns:
---
diff --git a/docs/libraries/Surfaces/DrawSetTextScale.md b/docs/libraries/Surfaces/DrawSetTextScale.md
index bab50d0698..393af32830 100644
--- a/docs/libraries/Surfaces/DrawSetTextScale.md
+++ b/docs/libraries/Surfaces/DrawSetTextScale.md
@@ -14,10 +14,12 @@ lua:
description: "Sets the text scale"
arguments:
- - name: "xScale"
- type: number
- - name: "yScale"
- type: number
+ - position: 1
+ name: "xScale"
+ type: number
+ - position: 2
+ name: "yScale"
+ type: number
returns:
---
diff --git a/docs/libraries/Surfaces/DrawSetTexture.md b/docs/libraries/Surfaces/DrawSetTexture.md
index dd593a76a5..58e58fa2de 100644
--- a/docs/libraries/Surfaces/DrawSetTexture.md
+++ b/docs/libraries/Surfaces/DrawSetTexture.md
@@ -14,8 +14,9 @@ lua:
description: "Sets the texture"
arguments:
- - name: "textureId"
- type: number
+ - position: 1
+ name: "textureId"
+ type: number
returns:
---
diff --git a/docs/libraries/Surfaces/DrawSetTextureFile.md b/docs/libraries/Surfaces/DrawSetTextureFile.md
index 03f4c497d8..1d209c8aee 100644
--- a/docs/libraries/Surfaces/DrawSetTextureFile.md
+++ b/docs/libraries/Surfaces/DrawSetTextureFile.md
@@ -14,16 +14,20 @@ lua:
description: "Sets the texture file"
arguments:
- - name: "textureId"
- type: number
- - name: "texturePath"
- type: string
- - name: "hardwareFilter"
- type: number
- default: "0"
- - name: "shouldForceReload"
- type: boolean
- default: "true"
+ - position: 1
+ name: "textureId"
+ type: number
+ - position: 2
+ name: "texturePath"
+ type: string
+ - position: 3
+ name: "hardwareFilter"
+ type: number
+ default: "0"
+ - position: 4
+ name: "shouldForceReload"
+ type: boolean
+ default: "true"
returns:
---
diff --git a/docs/libraries/Surfaces/DrawSetTextureMaterial.md b/docs/libraries/Surfaces/DrawSetTextureMaterial.md
index b6f7229f8f..9018e231a7 100644
--- a/docs/libraries/Surfaces/DrawSetTextureMaterial.md
+++ b/docs/libraries/Surfaces/DrawSetTextureMaterial.md
@@ -14,10 +14,12 @@ lua:
description: "Sets the texture material"
arguments:
- - name: "textureId"
- type: number
- - name: "material"
- type: Material
+ - position: 1
+ name: "textureId"
+ type: number
+ - position: 2
+ name: "material"
+ type: Material
returns:
---
diff --git a/docs/libraries/Surfaces/DrawSetTextureRgba.md b/docs/libraries/Surfaces/DrawSetTextureRgba.md
index dbc038eb41..c9e3c918cf 100644
--- a/docs/libraries/Surfaces/DrawSetTextureRgba.md
+++ b/docs/libraries/Surfaces/DrawSetTextureRgba.md
@@ -14,20 +14,26 @@ lua:
description: "Sets the texture raw RGBA bytes"
arguments:
- - name: "textureId"
- type: number
- - name: "rgba"
- type: string
- - name: "width"
- type: number
- - name: "height"
- type: number
- - name: "hardwareFilter"
- type: number
- default: "0"
- - name: "shouldForceReload"
- type: boolean
- default: "true"
+ - position: 1
+ name: "textureId"
+ type: number
+ - position: 2
+ name: "rgba"
+ type: string
+ - position: 3
+ name: "width"
+ type: number
+ - position: 4
+ name: "height"
+ type: number
+ - position: 5
+ name: "hardwareFilter"
+ type: number
+ default: "0"
+ - position: 6
+ name: "shouldForceReload"
+ type: boolean
+ default: "true"
returns:
---
diff --git a/docs/libraries/Surfaces/DrawTexturedRectangle.md b/docs/libraries/Surfaces/DrawTexturedRectangle.md
index 28cd334bbc..b7909976e0 100644
--- a/docs/libraries/Surfaces/DrawTexturedRectangle.md
+++ b/docs/libraries/Surfaces/DrawTexturedRectangle.md
@@ -14,14 +14,18 @@ lua:
description: "Draws a textured rectangle"
arguments:
- - name: "x0"
- type: number
- - name: "y0"
- type: number
- - name: "x1"
- type: number
- - name: "y1"
- type: number
+ - position: 1
+ name: "x0"
+ type: number
+ - position: 2
+ name: "y0"
+ type: number
+ - position: 3
+ name: "x1"
+ type: number
+ - position: 4
+ name: "y1"
+ type: number
returns:
---
diff --git a/docs/libraries/Surfaces/DrawTexturedSubRectangle.md b/docs/libraries/Surfaces/DrawTexturedSubRectangle.md
index 8d61076bde..67a7ae6984 100644
--- a/docs/libraries/Surfaces/DrawTexturedSubRectangle.md
+++ b/docs/libraries/Surfaces/DrawTexturedSubRectangle.md
@@ -14,22 +14,30 @@ lua:
description: "Draws a textured sub rectangle"
arguments:
- - name: "x0"
- type: number
- - name: "y0"
- type: number
- - name: "x1"
- type: number
- - name: "y1"
- type: number
- - name: "texs0"
- type: number
- - name: "text0"
- type: number
- - name: "texs1"
- type: number
- - name: "text1"
- type: number
+ - position: 1
+ name: "x0"
+ type: number
+ - position: 2
+ name: "y0"
+ type: number
+ - position: 3
+ name: "x1"
+ type: number
+ - position: 4
+ name: "y1"
+ type: number
+ - position: 5
+ name: "texs0"
+ type: number
+ - position: 6
+ name: "text0"
+ type: number
+ - position: 7
+ name: "texs1"
+ type: number
+ - position: 8
+ name: "text1"
+ type: number
returns:
---
diff --git a/docs/libraries/Surfaces/EnableMouseCapture.md b/docs/libraries/Surfaces/EnableMouseCapture.md
index b89a8a4ac6..649ca5cc5b 100644
--- a/docs/libraries/Surfaces/EnableMouseCapture.md
+++ b/docs/libraries/Surfaces/EnableMouseCapture.md
@@ -14,10 +14,12 @@ lua:
description: "Enables mouse capture"
arguments:
- - name: "panel"
- type: Panel
- - name: "enable"
- type: boolean
+ - position: 1
+ name: "panel"
+ type: Panel
+ - position: 2
+ name: "enable"
+ type: boolean
returns:
---
diff --git a/docs/libraries/Surfaces/FlashWindow.md b/docs/libraries/Surfaces/FlashWindow.md
index 8bb721be71..15f4b73142 100644
--- a/docs/libraries/Surfaces/FlashWindow.md
+++ b/docs/libraries/Surfaces/FlashWindow.md
@@ -14,10 +14,12 @@ lua:
description: "Flashes the window"
arguments:
- - name: "panel"
- type: Panel
- - name: "flash"
- type: boolean
+ - position: 1
+ name: "panel"
+ type: Panel
+ - position: 2
+ name: "flash"
+ type: boolean
returns:
---
diff --git a/docs/libraries/Surfaces/GetAbsoluteWindowBounds.md b/docs/libraries/Surfaces/GetAbsoluteWindowBounds.md
index 21feb6fc9b..2571bae458 100644
--- a/docs/libraries/Surfaces/GetAbsoluteWindowBounds.md
+++ b/docs/libraries/Surfaces/GetAbsoluteWindowBounds.md
@@ -13,6 +13,7 @@ lua:
realm: client
description: "Gets the absolute window bounds"
+ arguments:
returns:
- type: integer
diff --git a/docs/libraries/Surfaces/GetBitmapFontName.md b/docs/libraries/Surfaces/GetBitmapFontName.md
index 7c69e9ce9d..ee736ed517 100644
--- a/docs/libraries/Surfaces/GetBitmapFontName.md
+++ b/docs/libraries/Surfaces/GetBitmapFontName.md
@@ -14,8 +14,9 @@ lua:
description: "Gets the bitmap font name"
arguments:
- - name: "fontName"
- type: string
+ - position: 1
+ name: "fontName"
+ type: string
returns:
- type: string
description: "The bitmap font name"
diff --git a/docs/libraries/Surfaces/GetCharacterAbcWidth.md b/docs/libraries/Surfaces/GetCharacterAbcWidth.md
index c8c4f76910..64393ca136 100644
--- a/docs/libraries/Surfaces/GetCharacterAbcWidth.md
+++ b/docs/libraries/Surfaces/GetCharacterAbcWidth.md
@@ -14,10 +14,12 @@ lua:
description: "Gets the character ABC width"
arguments:
- - name: "font"
- type: FontHandle
- - name: "character"
- type: number
+ - position: 1
+ name: "font"
+ type: FontHandle
+ - position: 2
+ name: "character"
+ type: number
returns:
- type: integer
description: "The A value"
diff --git a/docs/libraries/Surfaces/GetCharacterWidth.md b/docs/libraries/Surfaces/GetCharacterWidth.md
index 815eb9e013..6073600630 100644
--- a/docs/libraries/Surfaces/GetCharacterWidth.md
+++ b/docs/libraries/Surfaces/GetCharacterWidth.md
@@ -14,8 +14,12 @@ lua:
description: "Gets the character width"
arguments:
- - name: "font"
- type: FontHandle
+ - position: 1
+ name: "font"
+ type: FontHandle
+ - position: 2
+ name: "character"
+ type: number
returns:
- type: integer
description: "The character width"
diff --git a/docs/libraries/Surfaces/GetEmbeddedPanel.md b/docs/libraries/Surfaces/GetEmbeddedPanel.md
index d8c9beb8ff..5289bdea0a 100644
--- a/docs/libraries/Surfaces/GetEmbeddedPanel.md
+++ b/docs/libraries/Surfaces/GetEmbeddedPanel.md
@@ -13,6 +13,7 @@ lua:
realm: client
description: "Gets the embedded panel"
+ arguments:
returns:
diff --git a/docs/libraries/Surfaces/GetFontAscent.md b/docs/libraries/Surfaces/GetFontAscent.md
index 1b0478168f..b63594a292 100644
--- a/docs/libraries/Surfaces/GetFontAscent.md
+++ b/docs/libraries/Surfaces/GetFontAscent.md
@@ -14,10 +14,12 @@ lua:
description: "Gets the font ascent"
arguments:
- - name: "text"
- type: string
- - name: "font"
- type: FontHandle
+ - position: 1
+ name: "font"
+ type: FontHandle
+ - position: 2
+ name: "text"
+ type: string
returns:
- type: integer
description: "The font ascent"
diff --git a/docs/libraries/Surfaces/GetFontTall.md b/docs/libraries/Surfaces/GetFontTall.md
index 7d366afddd..92878197e1 100644
--- a/docs/libraries/Surfaces/GetFontTall.md
+++ b/docs/libraries/Surfaces/GetFontTall.md
@@ -14,8 +14,9 @@ lua:
description: "Gets the font tall"
arguments:
- - name: "font"
- type: FontHandle
+ - position: 1
+ name: "font"
+ type: FontHandle
returns:
- type: integer
description: "The font tall"
diff --git a/docs/libraries/Surfaces/GetModalPanel.md b/docs/libraries/Surfaces/GetModalPanel.md
index e37dd7226d..7b25f44919 100644
--- a/docs/libraries/Surfaces/GetModalPanel.md
+++ b/docs/libraries/Surfaces/GetModalPanel.md
@@ -13,6 +13,7 @@ lua:
realm: client
description: "Gets the modal panel"
+ arguments:
returns:
diff --git a/docs/libraries/Surfaces/GetNotifyPanel.md b/docs/libraries/Surfaces/GetNotifyPanel.md
index 79ad598393..93467c4484 100644
--- a/docs/libraries/Surfaces/GetNotifyPanel.md
+++ b/docs/libraries/Surfaces/GetNotifyPanel.md
@@ -13,6 +13,7 @@ lua:
realm: client
description: "Gets the notify panel"
+ arguments:
returns:
diff --git a/docs/libraries/Surfaces/GetPopup.md b/docs/libraries/Surfaces/GetPopup.md
index dd3d58d955..6b0c21d78a 100644
--- a/docs/libraries/Surfaces/GetPopup.md
+++ b/docs/libraries/Surfaces/GetPopup.md
@@ -14,8 +14,9 @@ lua:
description: "Gets the popup"
arguments:
- - name: "index"
- type: number
+ - position: 1
+ name: "index"
+ type: number
returns:
---
diff --git a/docs/libraries/Surfaces/GetPopupCount.md b/docs/libraries/Surfaces/GetPopupCount.md
index 0feb6e237e..df433ec6db 100644
--- a/docs/libraries/Surfaces/GetPopupCount.md
+++ b/docs/libraries/Surfaces/GetPopupCount.md
@@ -13,6 +13,7 @@ lua:
realm: client
description: "Gets the popup count"
+ arguments:
returns:
- type: integer
diff --git a/docs/libraries/Surfaces/GetProportionalBase.md b/docs/libraries/Surfaces/GetProportionalBase.md
index 9d84492bc3..dcce382062 100644
--- a/docs/libraries/Surfaces/GetProportionalBase.md
+++ b/docs/libraries/Surfaces/GetProportionalBase.md
@@ -13,6 +13,7 @@ lua:
realm: client
description: "Gets the proportional base"
+ arguments:
returns:
- type: integer
diff --git a/docs/libraries/Surfaces/GetResolutionKey.md b/docs/libraries/Surfaces/GetResolutionKey.md
index be1f359123..4e17635fb7 100644
--- a/docs/libraries/Surfaces/GetResolutionKey.md
+++ b/docs/libraries/Surfaces/GetResolutionKey.md
@@ -13,6 +13,7 @@ lua:
realm: client
description: "Gets the resolution key"
+ arguments:
returns:
- type: string
diff --git a/docs/libraries/Surfaces/GetScreenSize.md b/docs/libraries/Surfaces/GetScreenSize.md
index ae8d15f85e..4f86a5278b 100644
--- a/docs/libraries/Surfaces/GetScreenSize.md
+++ b/docs/libraries/Surfaces/GetScreenSize.md
@@ -13,6 +13,7 @@ lua:
realm: client
description: "Gets the screen size"
+ arguments:
returns:
- type: integer
diff --git a/docs/libraries/Surfaces/GetTextSize.md b/docs/libraries/Surfaces/GetTextSize.md
index 154020ea75..5e5d2fb509 100644
--- a/docs/libraries/Surfaces/GetTextSize.md
+++ b/docs/libraries/Surfaces/GetTextSize.md
@@ -14,10 +14,12 @@ lua:
description: "Gets the text size"
arguments:
- - name: "text"
- type: string
- - name: "font"
- type: FontHandle
+ - position: 1
+ name: "font"
+ type: FontHandle
+ - position: 2
+ name: "text"
+ type: string
returns:
- type: integer
description: "The width"
diff --git a/docs/libraries/Surfaces/GetTitle.md b/docs/libraries/Surfaces/GetTitle.md
index bf1c9c95ae..397adfacfa 100644
--- a/docs/libraries/Surfaces/GetTitle.md
+++ b/docs/libraries/Surfaces/GetTitle.md
@@ -14,8 +14,9 @@ lua:
description: "Gets the title"
arguments:
- - name: "panel"
- type: Panel
+ - position: 1
+ name: "panel"
+ type: Panel
returns:
- type: string
description: "The title"
diff --git a/docs/libraries/Surfaces/GetTopmostPopup.md b/docs/libraries/Surfaces/GetTopmostPopup.md
index db31768778..b18c007c8f 100644
--- a/docs/libraries/Surfaces/GetTopmostPopup.md
+++ b/docs/libraries/Surfaces/GetTopmostPopup.md
@@ -13,6 +13,7 @@ lua:
realm: client
description: "Gets the topmost popup"
+ arguments:
returns:
diff --git a/docs/libraries/Surfaces/GetWorkspaceBounds.md b/docs/libraries/Surfaces/GetWorkspaceBounds.md
index 3b86a1ff42..e5fa06a242 100644
--- a/docs/libraries/Surfaces/GetWorkspaceBounds.md
+++ b/docs/libraries/Surfaces/GetWorkspaceBounds.md
@@ -13,6 +13,7 @@ lua:
realm: client
description: "Gets the workspace bounds"
+ arguments:
returns:
- type: integer
diff --git a/docs/libraries/Surfaces/GetZPosition.md b/docs/libraries/Surfaces/GetZPosition.md
index eb418b268e..2e0cfc9343 100644
--- a/docs/libraries/Surfaces/GetZPosition.md
+++ b/docs/libraries/Surfaces/GetZPosition.md
@@ -13,6 +13,7 @@ lua:
realm: client
description: "Gets the Z position"
+ arguments:
returns:
- type: number
diff --git a/docs/libraries/Surfaces/HasCursorPositionFunctions.md b/docs/libraries/Surfaces/HasCursorPositionFunctions.md
index 04b3af6eb4..cab790b80c 100644
--- a/docs/libraries/Surfaces/HasCursorPositionFunctions.md
+++ b/docs/libraries/Surfaces/HasCursorPositionFunctions.md
@@ -13,6 +13,7 @@ lua:
realm: client
description: "Checks if the surface has cursor position functions"
+ arguments:
returns:
- type: boolean
diff --git a/docs/libraries/Surfaces/HasFocus.md b/docs/libraries/Surfaces/HasFocus.md
index 174ec4f50c..e71a5fa436 100644
--- a/docs/libraries/Surfaces/HasFocus.md
+++ b/docs/libraries/Surfaces/HasFocus.md
@@ -13,6 +13,7 @@ lua:
realm: client
description: "Checks if the surface has focus"
+ arguments:
returns:
- type: boolean
diff --git a/docs/libraries/Surfaces/Invalidate.md b/docs/libraries/Surfaces/Invalidate.md
index c8f21d13dd..4067e92ed4 100644
--- a/docs/libraries/Surfaces/Invalidate.md
+++ b/docs/libraries/Surfaces/Invalidate.md
@@ -14,8 +14,9 @@ lua:
description: "Invalidates the panel"
arguments:
- - name: "panel"
- type: Panel
+ - position: 1
+ name: "panel"
+ type: Panel
returns:
---
diff --git a/docs/libraries/Surfaces/IsCursorLocked.md b/docs/libraries/Surfaces/IsCursorLocked.md
index b3c4e8fab0..79f5808739 100644
--- a/docs/libraries/Surfaces/IsCursorLocked.md
+++ b/docs/libraries/Surfaces/IsCursorLocked.md
@@ -13,6 +13,7 @@ lua:
realm: client
description: "Checks if the cursor is locked"
+ arguments:
returns:
- type: boolean
diff --git a/docs/libraries/Surfaces/IsCursorVisible.md b/docs/libraries/Surfaces/IsCursorVisible.md
index 5e1184cb57..cbaa12ad1f 100644
--- a/docs/libraries/Surfaces/IsCursorVisible.md
+++ b/docs/libraries/Surfaces/IsCursorVisible.md
@@ -13,6 +13,7 @@ lua:
realm: client
description: "Checks if the cursor is visible"
+ arguments:
returns:
- type: boolean
diff --git a/docs/libraries/Surfaces/IsFontAdditive.md b/docs/libraries/Surfaces/IsFontAdditive.md
index dc04a73ad2..9b66729aee 100644
--- a/docs/libraries/Surfaces/IsFontAdditive.md
+++ b/docs/libraries/Surfaces/IsFontAdditive.md
@@ -14,8 +14,9 @@ lua:
description: "Checks if the font is additive"
arguments:
- - name: "font"
- type: FontHandle
+ - position: 1
+ name: "font"
+ type: FontHandle
returns:
- type: boolean
description: "True if the font is additive, false otherwise."
diff --git a/docs/libraries/Surfaces/IsMinimized.md b/docs/libraries/Surfaces/IsMinimized.md
index 28b9178eac..8aa0d706c1 100644
--- a/docs/libraries/Surfaces/IsMinimized.md
+++ b/docs/libraries/Surfaces/IsMinimized.md
@@ -14,8 +14,9 @@ lua:
description: "Checks if the panel is minimized"
arguments:
- - name: "panel"
- type: Panel
+ - position: 1
+ name: "panel"
+ type: Panel
returns:
- type: boolean
description: "True if the panel is minimized, false otherwise."
diff --git a/docs/libraries/Surfaces/IsTextureIdValid.md b/docs/libraries/Surfaces/IsTextureIdValid.md
index 95543c1bee..e5cb6f25d0 100644
--- a/docs/libraries/Surfaces/IsTextureIdValid.md
+++ b/docs/libraries/Surfaces/IsTextureIdValid.md
@@ -14,8 +14,9 @@ lua:
description: "Checks if the texture ID is valid"
arguments:
- - name: "textureId"
- type: number
+ - position: 1
+ name: "textureId"
+ type: number
returns:
- type: boolean
description: "True if the texture ID is valid, false otherwise."
diff --git a/docs/libraries/Surfaces/IsWithin.md b/docs/libraries/Surfaces/IsWithin.md
index 9d8900d57f..ccf5fead23 100644
--- a/docs/libraries/Surfaces/IsWithin.md
+++ b/docs/libraries/Surfaces/IsWithin.md
@@ -14,8 +14,12 @@ lua:
description: "Checks if the point is within the surface"
arguments:
- - name: "x"
- type: number
+ - position: 1
+ name: "x"
+ type: number
+ - position: 2
+ name: "y"
+ type: number
returns:
- type: boolean
description: "True if the point is within the surface, false otherwise."
diff --git a/docs/libraries/Surfaces/LockCursor.md b/docs/libraries/Surfaces/LockCursor.md
index 38069db950..57425b1e0e 100644
--- a/docs/libraries/Surfaces/LockCursor.md
+++ b/docs/libraries/Surfaces/LockCursor.md
@@ -13,6 +13,7 @@ lua:
realm: client
description: "Locks the cursor"
+ arguments:
returns:
diff --git a/docs/libraries/Surfaces/MovePopupToBack.md b/docs/libraries/Surfaces/MovePopupToBack.md
index 1b7b58adff..5ce4c748a3 100644
--- a/docs/libraries/Surfaces/MovePopupToBack.md
+++ b/docs/libraries/Surfaces/MovePopupToBack.md
@@ -14,8 +14,9 @@ lua:
description: "Moves the popup to the back"
arguments:
- - name: "panel"
- type: Panel
+ - position: 1
+ name: "panel"
+ type: Panel
returns:
---
diff --git a/docs/libraries/Surfaces/MovePopupToFront.md b/docs/libraries/Surfaces/MovePopupToFront.md
index 29f231e6d9..113fc0cc96 100644
--- a/docs/libraries/Surfaces/MovePopupToFront.md
+++ b/docs/libraries/Surfaces/MovePopupToFront.md
@@ -14,8 +14,9 @@ lua:
description: "Moves the popup to the front"
arguments:
- - name: "panel"
- type: Panel
+ - position: 1
+ name: "panel"
+ type: Panel
returns:
---
diff --git a/docs/libraries/Surfaces/NeedKeyboardInput.md b/docs/libraries/Surfaces/NeedKeyboardInput.md
index 8146bed2af..90be848ea3 100644
--- a/docs/libraries/Surfaces/NeedKeyboardInput.md
+++ b/docs/libraries/Surfaces/NeedKeyboardInput.md
@@ -13,6 +13,7 @@ lua:
realm: client
description: "Checks if the surface needs keyboard input"
+ arguments:
returns:
- type: boolean
diff --git a/docs/libraries/Surfaces/OnScreenSizeChanged.md b/docs/libraries/Surfaces/OnScreenSizeChanged.md
index 069cff6ab1..adb6c14d89 100644
--- a/docs/libraries/Surfaces/OnScreenSizeChanged.md
+++ b/docs/libraries/Surfaces/OnScreenSizeChanged.md
@@ -14,10 +14,12 @@ lua:
description: "Called when the screen size changes"
arguments:
- - name: "oldWidth"
- type: number
- - name: "oldHeight"
- type: number
+ - position: 1
+ name: "oldWidth"
+ type: number
+ - position: 2
+ name: "oldHeight"
+ type: number
returns:
---
diff --git a/docs/libraries/Surfaces/PaintTraverse.md b/docs/libraries/Surfaces/PaintTraverse.md
index c595a12524..870fd398cc 100644
--- a/docs/libraries/Surfaces/PaintTraverse.md
+++ b/docs/libraries/Surfaces/PaintTraverse.md
@@ -14,8 +14,9 @@ lua:
description: "Paints the panel"
arguments:
- - name: "panel"
- type: Panel
+ - position: 1
+ name: "panel"
+ type: Panel
returns:
---
diff --git a/docs/libraries/Surfaces/PaintTraverseEx.md b/docs/libraries/Surfaces/PaintTraverseEx.md
index 4dfdba733c..da3866ff87 100644
--- a/docs/libraries/Surfaces/PaintTraverseEx.md
+++ b/docs/libraries/Surfaces/PaintTraverseEx.md
@@ -14,11 +14,13 @@ lua:
description: "Paints the panel"
arguments:
- - name: "panel"
- type: Panel
- - name: "paintPopups"
- type: boolean
- default: "false"
+ - position: 1
+ name: "panel"
+ type: Panel
+ - position: 2
+ name: "paintPopups"
+ type: boolean
+ default: "false"
returns:
---
diff --git a/docs/libraries/Surfaces/PlaySound.md b/docs/libraries/Surfaces/PlaySound.md
index db61a1c2c6..b7528d4d96 100644
--- a/docs/libraries/Surfaces/PlaySound.md
+++ b/docs/libraries/Surfaces/PlaySound.md
@@ -14,8 +14,9 @@ lua:
description: "Plays a sound"
arguments:
- - name: "sound"
- type: string
+ - position: 1
+ name: "sound"
+ type: string
returns:
---
diff --git a/docs/libraries/Surfaces/PopMakeCurrent.md b/docs/libraries/Surfaces/PopMakeCurrent.md
index 2c63e4411e..b9b464f93d 100644
--- a/docs/libraries/Surfaces/PopMakeCurrent.md
+++ b/docs/libraries/Surfaces/PopMakeCurrent.md
@@ -14,8 +14,9 @@ lua:
description: "Pops the make current"
arguments:
- - name: "panel"
- type: Panel
+ - position: 1
+ name: "panel"
+ type: Panel
returns:
---
diff --git a/docs/libraries/Surfaces/RunFrame.md b/docs/libraries/Surfaces/RunFrame.md
index 0d4cc78150..d9c4437c1f 100644
--- a/docs/libraries/Surfaces/RunFrame.md
+++ b/docs/libraries/Surfaces/RunFrame.md
@@ -13,6 +13,7 @@ lua:
realm: client
description: "Runs a frame"
+ arguments:
returns:
diff --git a/docs/libraries/Surfaces/SetAllowHtmlJavaScript.md b/docs/libraries/Surfaces/SetAllowHtmlJavaScript.md
index 302a4efdc0..3f1122a79e 100644
--- a/docs/libraries/Surfaces/SetAllowHtmlJavaScript.md
+++ b/docs/libraries/Surfaces/SetAllowHtmlJavaScript.md
@@ -14,8 +14,9 @@ lua:
description: "Sets whether HTML JavaScript is allowed"
arguments:
- - name: "allow"
- type: boolean
+ - position: 1
+ name: "allow"
+ type: boolean
returns:
---
diff --git a/docs/libraries/Surfaces/SetBitmapFontName.md b/docs/libraries/Surfaces/SetBitmapFontName.md
index cd07139eed..442a015e17 100644
--- a/docs/libraries/Surfaces/SetBitmapFontName.md
+++ b/docs/libraries/Surfaces/SetBitmapFontName.md
@@ -14,10 +14,12 @@ lua:
description: "Sets the bitmap font name"
arguments:
- - name: "fontName"
- type: string
- - name: "fontFilename"
- type: string
+ - position: 1
+ name: "fontName"
+ type: string
+ - position: 2
+ name: "fontFilename"
+ type: string
returns:
---
diff --git a/docs/libraries/Surfaces/SetCursorAlwaysVisible.md b/docs/libraries/Surfaces/SetCursorAlwaysVisible.md
new file mode 100644
index 0000000000..b78156dc37
--- /dev/null
+++ b/docs/libraries/Surfaces/SetCursorAlwaysVisible.md
@@ -0,0 +1,26 @@
+---
+template: lua-library-function.html
+title: SetCursorAlwaysVisible
+icon: lua-client
+tags:
+ - lua
+ - client
+ - needs-verification
+ - needs-example
+lua:
+ library: Surfaces
+ function: SetCursorAlwaysVisible
+ realm: client
+ description: "Sets whether the cursor is always visible"
+
+ arguments:
+ - position: 1
+ name: "visible"
+ type: boolean
+ returns:
+
+---
+
+
+Surfaces.SetCursorAlwaysVisible – Sets whether the cursor is always visible
+
diff --git a/docs/libraries/Surfaces/SetEmbeddedPanel.md b/docs/libraries/Surfaces/SetEmbeddedPanel.md
index 88d351d55a..3253f122ea 100644
--- a/docs/libraries/Surfaces/SetEmbeddedPanel.md
+++ b/docs/libraries/Surfaces/SetEmbeddedPanel.md
@@ -14,8 +14,9 @@ lua:
description: "Sets the embedded panel"
arguments:
- - name: "panel"
- type: Panel
+ - position: 1
+ name: "panel"
+ type: Panel
returns:
---
diff --git a/docs/libraries/Surfaces/SetFontGlyphSet.md b/docs/libraries/Surfaces/SetFontGlyphSet.md
index d460bdcc21..aee30c6035 100644
--- a/docs/libraries/Surfaces/SetFontGlyphSet.md
+++ b/docs/libraries/Surfaces/SetFontGlyphSet.md
@@ -14,8 +14,35 @@ lua:
description: "Sets the font glyph set"
arguments:
- - name: "font"
- type: FontHandle
+ - position: 1
+ name: "font"
+ type: FontHandle
+ - position: 2
+ name: "fontName"
+ type: string
+ - position: 3
+ name: "tall"
+ type: number
+ - position: 4
+ name: "weight"
+ type: number
+ - position: 5
+ name: "blur"
+ type: number
+ - position: 6
+ name: "scanlines"
+ type: number
+ - position: 7
+ name: "flags"
+ type: number
+ - position: 8
+ name: "rangeMin"
+ type: number
+ default: "0"
+ - position: 9
+ name: "rangeMax"
+ type: number
+ default: "0"
returns:
- type: boolean
description: "True if the font glyph set was set, false otherwise."
diff --git a/docs/libraries/Surfaces/SetTranslateExtendedKeys.md b/docs/libraries/Surfaces/SetTranslateExtendedKeys.md
index 94a92ec703..8a1d580519 100644
--- a/docs/libraries/Surfaces/SetTranslateExtendedKeys.md
+++ b/docs/libraries/Surfaces/SetTranslateExtendedKeys.md
@@ -14,8 +14,9 @@ lua:
description: "Sets whether to translate extended keys"
arguments:
- - name: "state"
- type: boolean
+ - position: 1
+ name: "state"
+ type: boolean
returns:
---
diff --git a/docs/libraries/Surfaces/SetWorkspaceInsets.md b/docs/libraries/Surfaces/SetWorkspaceInsets.md
index bb665cf6c8..090fe973a4 100644
--- a/docs/libraries/Surfaces/SetWorkspaceInsets.md
+++ b/docs/libraries/Surfaces/SetWorkspaceInsets.md
@@ -14,14 +14,18 @@ lua:
description: "Sets the workspace insets"
arguments:
- - name: "left"
- type: number
- - name: "top"
- type: number
- - name: "right"
- type: number
- - name: "bottom"
- type: number
+ - position: 1
+ name: "left"
+ type: number
+ - position: 2
+ name: "top"
+ type: number
+ - position: 3
+ name: "right"
+ type: number
+ - position: 4
+ name: "bottom"
+ type: number
returns:
---
diff --git a/docs/libraries/Surfaces/SupportsFeature.md b/docs/libraries/Surfaces/SupportsFeature.md
index 0d2617847c..f8e4ee0913 100644
--- a/docs/libraries/Surfaces/SupportsFeature.md
+++ b/docs/libraries/Surfaces/SupportsFeature.md
@@ -13,7 +13,10 @@ lua:
realm: client
description: "Checks if the surface supports a feature"
-
+ arguments:
+ - position: 1
+ name: "feature"
+ type: enumeration/SURFACE_FEATURE
returns:
- type: boolean
description: "True if the surface supports the feature, false otherwise."
diff --git a/docs/libraries/Surfaces/SurfaceGetCursorPosition.md b/docs/libraries/Surfaces/SurfaceGetCursorPosition.md
index 95ba4c0d63..aee2b50720 100644
--- a/docs/libraries/Surfaces/SurfaceGetCursorPosition.md
+++ b/docs/libraries/Surfaces/SurfaceGetCursorPosition.md
@@ -13,6 +13,7 @@ lua:
realm: client
description: "Gets the cursor position"
+ arguments:
returns:
- type: integer
diff --git a/docs/libraries/Surfaces/SurfaceSetCursorPosition.md b/docs/libraries/Surfaces/SurfaceSetCursorPosition.md
index b33346ba5a..3fa9bf9d35 100644
--- a/docs/libraries/Surfaces/SurfaceSetCursorPosition.md
+++ b/docs/libraries/Surfaces/SurfaceSetCursorPosition.md
@@ -14,10 +14,12 @@ lua:
description: "Sets the cursor position"
arguments:
- - name: "x"
- type: number
- - name: "y"
- type: number
+ - position: 1
+ name: "x"
+ type: number
+ - position: 2
+ name: "y"
+ type: number
returns:
---
diff --git a/docs/libraries/Surfaces/UnlockCursor.md b/docs/libraries/Surfaces/UnlockCursor.md
index 899e54e7da..dd99292ea6 100644
--- a/docs/libraries/Surfaces/UnlockCursor.md
+++ b/docs/libraries/Surfaces/UnlockCursor.md
@@ -13,6 +13,7 @@ lua:
realm: client
description: "Unlocks the cursor"
+ arguments:
returns:
diff --git a/docs/libraries/Systems/GetCountry.md b/docs/libraries/Systems/GetCountry.md
index 8b40fd3fbc..08d500d2f0 100644
--- a/docs/libraries/Systems/GetCountry.md
+++ b/docs/libraries/Systems/GetCountry.md
@@ -13,6 +13,7 @@ lua:
realm: shared
description: "Get the country code of the user."
+ arguments:
returns:
- type: string
diff --git a/docs/libraries/Systems/GetSecondsSinceAppActive.md b/docs/libraries/Systems/GetSecondsSinceAppActive.md
index b50662342d..eeacff079a 100644
--- a/docs/libraries/Systems/GetSecondsSinceAppActive.md
+++ b/docs/libraries/Systems/GetSecondsSinceAppActive.md
@@ -13,6 +13,7 @@ lua:
realm: shared
description: "Get the number of seconds since the application was started."
+ arguments:
returns:
- type: integer
diff --git a/docs/libraries/Systems/GetSecondsSinceComputerActive.md b/docs/libraries/Systems/GetSecondsSinceComputerActive.md
index eed2b6db9c..ecf900f374 100644
--- a/docs/libraries/Systems/GetSecondsSinceComputerActive.md
+++ b/docs/libraries/Systems/GetSecondsSinceComputerActive.md
@@ -13,6 +13,7 @@ lua:
realm: shared
description: "Get the number of seconds since the computer was started."
+ arguments:
returns:
- type: integer
diff --git a/docs/libraries/Systems/GetSteamServerRealTime.md b/docs/libraries/Systems/GetSteamServerRealTime.md
index a31bc521be..6cf05cfd0f 100644
--- a/docs/libraries/Systems/GetSteamServerRealTime.md
+++ b/docs/libraries/Systems/GetSteamServerRealTime.md
@@ -13,6 +13,7 @@ lua:
realm: shared
description: "Get the server time."
+ arguments:
returns:
- type: integer
diff --git a/docs/libraries/Systems/HasFocus.md b/docs/libraries/Systems/HasFocus.md
index 51ff79aa3f..db1dd595c2 100644
--- a/docs/libraries/Systems/HasFocus.md
+++ b/docs/libraries/Systems/HasFocus.md
@@ -13,6 +13,7 @@ lua:
realm: shared
description: "Check if the application has focus."
+ arguments:
returns:
- type: boolean
diff --git a/docs/libraries/Systems/IsLinux.md b/docs/libraries/Systems/IsLinux.md
index 179553d441..acf554ffbb 100644
--- a/docs/libraries/Systems/IsLinux.md
+++ b/docs/libraries/Systems/IsLinux.md
@@ -13,6 +13,7 @@ lua:
realm: shared
description: "Check if the application is running on Linux."
+ arguments:
returns:
- type: boolean
diff --git a/docs/libraries/Systems/IsOsx.md b/docs/libraries/Systems/IsOsx.md
index 73d5775f8d..4b2f650fa6 100644
--- a/docs/libraries/Systems/IsOsx.md
+++ b/docs/libraries/Systems/IsOsx.md
@@ -13,6 +13,7 @@ lua:
realm: shared
description: "Check if the application is running on macOS."
+ arguments:
returns:
- type: boolean
diff --git a/docs/libraries/Systems/IsWindowed.md b/docs/libraries/Systems/IsWindowed.md
index 66129df5df..b948f84926 100644
--- a/docs/libraries/Systems/IsWindowed.md
+++ b/docs/libraries/Systems/IsWindowed.md
@@ -13,6 +13,7 @@ lua:
realm: shared
description: "Check if the application is running in windowed mode."
+ arguments:
returns:
- type: boolean
diff --git a/docs/libraries/Systems/IsWindows.md b/docs/libraries/Systems/IsWindows.md
index 849d9d2420..49b89bcc26 100644
--- a/docs/libraries/Systems/IsWindows.md
+++ b/docs/libraries/Systems/IsWindows.md
@@ -13,6 +13,7 @@ lua:
realm: shared
description: "Check if the application is running on Windows."
+ arguments:
returns:
- type: boolean
diff --git a/docs/libraries/Systems/SetClipboardText.md b/docs/libraries/Systems/SetClipboardText.md
index b5b688e851..38fc8c23a6 100644
--- a/docs/libraries/Systems/SetClipboardText.md
+++ b/docs/libraries/Systems/SetClipboardText.md
@@ -14,8 +14,9 @@ lua:
description: "Set the text in the clipboard."
arguments:
- - name: "text"
- type: string
+ - position: 1
+ name: "text"
+ type: string
returns:
---
diff --git a/docs/libraries/TakeDamageInfos/AddMultiDamage.md b/docs/libraries/TakeDamageInfos/AddMultiDamage.md
index dbe1c03caa..18f1fb63cb 100644
--- a/docs/libraries/TakeDamageInfos/AddMultiDamage.md
+++ b/docs/libraries/TakeDamageInfos/AddMultiDamage.md
@@ -14,10 +14,12 @@ lua:
description: "Adds multi damage"
arguments:
- - name: "damageInfo"
- type: DamageInfo
- - name: "entity"
- type: Entity
+ - position: 1
+ name: "damageInfo"
+ type: DamageInfo
+ - position: 2
+ name: "entity"
+ type: Entity
returns:
---
diff --git a/docs/libraries/TakeDamageInfos/ApplyMultiDamage.md b/docs/libraries/TakeDamageInfos/ApplyMultiDamage.md
index 24326a6a28..b5ba9cbf17 100644
--- a/docs/libraries/TakeDamageInfos/ApplyMultiDamage.md
+++ b/docs/libraries/TakeDamageInfos/ApplyMultiDamage.md
@@ -13,6 +13,7 @@ lua:
realm: shared
description: "Applies multi damage"
+ arguments:
returns:
diff --git a/docs/libraries/TakeDamageInfos/CalculateBulletDamageForce.md b/docs/libraries/TakeDamageInfos/CalculateBulletDamageForce.md
index 07eebb09cd..dd45f514e5 100644
--- a/docs/libraries/TakeDamageInfos/CalculateBulletDamageForce.md
+++ b/docs/libraries/TakeDamageInfos/CalculateBulletDamageForce.md
@@ -14,17 +14,22 @@ lua:
description: "Calculates the bullet damage force"
arguments:
- - name: "damageInfo"
- type: DamageInfo
- - name: "bulletType"
- type: number
- - name: "damageDirection"
- type: Vector
- - name: "damagePosition"
- type: Vector
- - name: "scale"
- type: number
- default: "1.0"
+ - position: 1
+ name: "damageInfo"
+ type: DamageInfo
+ - position: 2
+ name: "bulletType"
+ type: number
+ - position: 3
+ name: "damageDirection"
+ type: Vector
+ - position: 4
+ name: "damagePosition"
+ type: Vector
+ - position: 5
+ name: "scale"
+ type: number
+ default: "1.0"
returns:
---
diff --git a/docs/libraries/TakeDamageInfos/CalculateExplosiveDamageForce.md b/docs/libraries/TakeDamageInfos/CalculateExplosiveDamageForce.md
index 76b22dd9cf..c0e62c387e 100644
--- a/docs/libraries/TakeDamageInfos/CalculateExplosiveDamageForce.md
+++ b/docs/libraries/TakeDamageInfos/CalculateExplosiveDamageForce.md
@@ -14,15 +14,19 @@ lua:
description: "Calculates the explosive damage force"
arguments:
- - name: "damageInfo"
- type: DamageInfo
- - name: "damageDirection"
- type: Vector
- - name: "damagePosition"
- type: Vector
- - name: "scale"
- type: number
- default: "1.0"
+ - position: 1
+ name: "damageInfo"
+ type: DamageInfo
+ - position: 2
+ name: "damageDirection"
+ type: Vector
+ - position: 3
+ name: "damagePosition"
+ type: Vector
+ - position: 4
+ name: "scale"
+ type: number
+ default: "1.0"
returns:
---
diff --git a/docs/libraries/TakeDamageInfos/CalculateMeleeDamageForce.md b/docs/libraries/TakeDamageInfos/CalculateMeleeDamageForce.md
index 8db9f5d285..20d626145e 100644
--- a/docs/libraries/TakeDamageInfos/CalculateMeleeDamageForce.md
+++ b/docs/libraries/TakeDamageInfos/CalculateMeleeDamageForce.md
@@ -14,15 +14,19 @@ lua:
description: "Calculates the melee damage force"
arguments:
- - name: "damageInfo"
- type: DamageInfo
- - name: "damageDirection"
- type: Vector
- - name: "damagePosition"
- type: Vector
- - name: "scale"
- type: number
- default: "1.0"
+ - position: 1
+ name: "damageInfo"
+ type: DamageInfo
+ - position: 2
+ name: "damageDirection"
+ type: Vector
+ - position: 3
+ name: "damagePosition"
+ type: Vector
+ - position: 4
+ name: "scale"
+ type: number
+ default: "1.0"
returns:
---
diff --git a/docs/libraries/TakeDamageInfos/ClearMultiDamage.md b/docs/libraries/TakeDamageInfos/ClearMultiDamage.md
index 41ed197749..66e81782e9 100644
--- a/docs/libraries/TakeDamageInfos/ClearMultiDamage.md
+++ b/docs/libraries/TakeDamageInfos/ClearMultiDamage.md
@@ -13,6 +13,7 @@ lua:
realm: shared
description: "Clears multi damage"
+ arguments:
returns:
diff --git a/docs/libraries/TakeDamageInfos/Create.md b/docs/libraries/TakeDamageInfos/Create.md
index 2dad1454fc..6942380f01 100644
--- a/docs/libraries/TakeDamageInfos/Create.md
+++ b/docs/libraries/TakeDamageInfos/Create.md
@@ -13,73 +13,86 @@ lua:
realm: shared
description: "Creates a new TakeDamageInfo object"
- argumentSets:
- - arguments:
+ arguments:
+ - position: 1
+ types:
- name: "inflictor"
type: Entity
- - name: "attacker"
+ - name: "inflictor"
+ type: Entity
+ - name: "inflictor"
type: Entity
- - name: "damage"
- type: number
- - name: "damageType"
- type: number
- - name: "killType"
- type: number
- default: "0"
- - arguments:
- name: "inflictor"
type: Entity
+ - position: 2
+ types:
- name: "attacker"
type: Entity
- - name: "weapon"
+ - name: "attacker"
type: Entity
- - name: "damage"
- type: number
- - name: "damageType"
- type: number
- - name: "killType"
- type: number
- default: "0"
- - arguments:
- - name: "inflictor"
+ - name: "attacker"
type: Entity
- name: "attacker"
type: Entity
- - name: "damageForce"
- type: Vector
- - name: "damagePosition"
- type: Vector
+ - position: 3
+ types:
- name: "damage"
type: number
+ - name: "weapon"
+ type: Entity
+ - name: "damageForce"
+ type: Vector
+ - name: "weapon"
+ type: Entity
+ - position: 4
+ types:
- name: "damageType"
type: number
- - name: "killType"
+ - name: "damage"
type: number
- default: "0"
- - name: "reportedPosition"
+ - name: "damagePosition"
type: Vector
- default: "NULL"
- - arguments:
- - name: "inflictor"
- type: Entity
- - name: "attacker"
- type: Entity
- - name: "weapon"
- type: Entity
- name: "damageForce"
type: Vector
+ - position: 5
+ types:
+ - name: "damageType"
+ type: number
+ - name: "damage"
+ type: number
- name: "damagePosition"
type: Vector
+ - name: "killType"
+ type: number
+ default: "0"
+ - position: 6
+ types:
+ - name: "damageType"
+ type: number
- name: "damage"
type: number
+ - name: "killType"
+ type: number
+ default: "0"
+ - position: 7
+ types:
- name: "damageType"
type: number
- name: "killType"
type: number
- default: "0"
+ default: "0"
+ - position: 8
+ types:
- name: "reportedPosition"
type: Vector
- default: "NULL"
+ default: "NULL"
+ - name: "killType"
+ type: number
+ default: "0"
+ - position: 9
+ name: "reportedPosition"
+ type: Vector
+ default: "NULL"
returns:
- type: TakeDamageInfo
description: "The new TakeDamageInfo object."
diff --git a/docs/libraries/TakeDamageInfos/GuessDamageForce.md b/docs/libraries/TakeDamageInfos/GuessDamageForce.md
index 65c1c336af..c342965cea 100644
--- a/docs/libraries/TakeDamageInfos/GuessDamageForce.md
+++ b/docs/libraries/TakeDamageInfos/GuessDamageForce.md
@@ -14,15 +14,19 @@ lua:
description: "Guesses the damage force"
arguments:
- - name: "damageInfo"
- type: DamageInfo
- - name: "damageDirection"
- type: Vector
- - name: "damagePosition"
- type: Vector
- - name: "scale"
- type: number
- default: "1.0"
+ - position: 1
+ name: "damageInfo"
+ type: DamageInfo
+ - position: 2
+ name: "damageDirection"
+ type: Vector
+ - position: 3
+ name: "damagePosition"
+ type: Vector
+ - position: 4
+ name: "scale"
+ type: number
+ default: "1.0"
returns:
---
diff --git a/docs/libraries/TakeDamageInfos/ImpulseScale.md b/docs/libraries/TakeDamageInfos/ImpulseScale.md
index 4750028de1..79813201eb 100644
--- a/docs/libraries/TakeDamageInfos/ImpulseScale.md
+++ b/docs/libraries/TakeDamageInfos/ImpulseScale.md
@@ -14,8 +14,12 @@ lua:
description: "Scales the impulse"
arguments:
- - name: "targetMass"
- type: number
+ - position: 1
+ name: "targetMass"
+ type: number
+ - position: 2
+ name: "desiredSpeed"
+ type: number
returns:
- type: number
description: "The scaled impulse."
diff --git a/docs/libraries/Traces/ClearTrace.md b/docs/libraries/Traces/ClearTrace.md
index 4f06448a3b..0b8a4e109d 100644
--- a/docs/libraries/Traces/ClearTrace.md
+++ b/docs/libraries/Traces/ClearTrace.md
@@ -14,8 +14,9 @@ lua:
description: "Clears the given trace object."
arguments:
- - name: "trace"
- type: Trace
+ - position: 1
+ name: "trace"
+ type: Trace
returns:
---
diff --git a/docs/libraries/Traces/Create.md b/docs/libraries/Traces/Create.md
index 125a8f71a2..c7fe93039d 100644
--- a/docs/libraries/Traces/Create.md
+++ b/docs/libraries/Traces/Create.md
@@ -13,6 +13,7 @@ lua:
realm: shared
description: "Create a new trace object."
+ arguments:
returns:
- type: Trace
diff --git a/docs/libraries/Traces/PointContents.md b/docs/libraries/Traces/PointContents.md
index d18920808b..e637b6aa56 100644
--- a/docs/libraries/Traces/PointContents.md
+++ b/docs/libraries/Traces/PointContents.md
@@ -14,8 +14,9 @@ lua:
description: "Returns the contents mask + entity at a particular world-space position."
arguments:
- - name: "point"
- type: Vector
+ - position: 1
+ name: "point"
+ type: Vector
returns:
- type: integer
description: "Bitwise contents mask."
diff --git a/docs/libraries/Traces/TraceEntity.md b/docs/libraries/Traces/TraceEntity.md
index 4c96b9ce27..aeae5e5e69 100644
--- a/docs/libraries/Traces/TraceEntity.md
+++ b/docs/libraries/Traces/TraceEntity.md
@@ -14,10 +14,12 @@ lua:
description: "Runs a trace using the entity's collisionmodel between two points. This does not take the entity's angles into account and will trace its unrotated collisionmodel."
arguments:
- - name: "entity"
- type: Entity
- - name: "trace"
- type: Trace
+ - position: 1
+ name: "trace"
+ type: Trace
+ - position: 2
+ name: "entity"
+ type: Entity
returns:
- type: TraceResult
description: "The trace result."
diff --git a/docs/libraries/Traces/TraceHull.md b/docs/libraries/Traces/TraceHull.md
index 4ab70c1948..f08649b61a 100644
--- a/docs/libraries/Traces/TraceHull.md
+++ b/docs/libraries/Traces/TraceHull.md
@@ -14,8 +14,9 @@ lua:
description: "Trace a hull."
arguments:
- - name: "trace"
- type: Trace
+ - position: 1
+ name: "trace"
+ type: Trace
returns:
- type: TraceResult
description: "The trace result."
diff --git a/docs/libraries/Traces/TraceLine.md b/docs/libraries/Traces/TraceLine.md
index fe81e9081a..f8a2f6fcb6 100644
--- a/docs/libraries/Traces/TraceLine.md
+++ b/docs/libraries/Traces/TraceLine.md
@@ -14,8 +14,9 @@ lua:
description: "Trace a line."
arguments:
- - name: "trace"
- type: Trace
+ - position: 1
+ name: "trace"
+ type: Trace
returns:
- type: TraceResult
description: "The trace result."
diff --git a/docs/libraries/Traces/TraceModel.md b/docs/libraries/Traces/TraceModel.md
index 8b537879b2..96646fa3a3 100644
--- a/docs/libraries/Traces/TraceModel.md
+++ b/docs/libraries/Traces/TraceModel.md
@@ -14,16 +14,21 @@ lua:
description: "Sweeps against a particular model, using collision rules."
arguments:
- - name: "entity"
- type: Entity
- - name: "start"
- type: Vector
- - name: "end"
- type: Vector
- - name: "hullMinimum"
- type: Vector
- - name: "hullMaximum"
- type: Vector
+ - position: 1
+ name: "start"
+ type: Vector
+ - position: 2
+ name: "end"
+ type: Vector
+ - position: 3
+ name: "hullMinimum"
+ type: Vector
+ - position: 4
+ name: "hullMaximum"
+ type: Vector
+ - position: 5
+ name: "entity"
+ type: Entity
returns:
- type: TraceResult
description: "The trace result."
diff --git a/docs/libraries/UserMessages/MessageEnd.md b/docs/libraries/UserMessages/MessageEnd.md
index 9073df33be..9edabf0b8c 100644
--- a/docs/libraries/UserMessages/MessageEnd.md
+++ b/docs/libraries/UserMessages/MessageEnd.md
@@ -13,6 +13,7 @@ lua:
realm: server
description: "Ends a user message."
+ arguments:
returns:
diff --git a/docs/libraries/UserMessages/Start.md b/docs/libraries/UserMessages/Start.md
index 7278ce1f49..1eb2e717dd 100644
--- a/docs/libraries/UserMessages/Start.md
+++ b/docs/libraries/UserMessages/Start.md
@@ -14,11 +14,13 @@ lua:
description: "Starts a user message."
arguments:
- - name: "messageName"
- type: string
- - name: "recipientFilter"
- type: RecipientFilter
- nillable: true
+ - position: 1
+ name: "messageName"
+ type: string
+ - position: 2
+ name: "recipientFilter"
+ type: RecipientFilter
+ nillable: true
returns:
---
diff --git a/docs/libraries/UserMessages/WriteAngle.md b/docs/libraries/UserMessages/WriteAngle.md
index 074517e010..2ae2bf6341 100644
--- a/docs/libraries/UserMessages/WriteAngle.md
+++ b/docs/libraries/UserMessages/WriteAngle.md
@@ -14,8 +14,9 @@ lua:
description: "Writes an angle."
arguments:
- - name: "angle"
- type: Angle
+ - position: 1
+ name: "angle"
+ type: Angle
returns:
---
diff --git a/docs/libraries/UserMessages/WriteBool.md b/docs/libraries/UserMessages/WriteBool.md
index b5ffb1216d..75b8c62a20 100644
--- a/docs/libraries/UserMessages/WriteBool.md
+++ b/docs/libraries/UserMessages/WriteBool.md
@@ -14,8 +14,9 @@ lua:
description: "Writes a boolean."
arguments:
- - name: "boolean"
- type: boolean
+ - position: 1
+ name: "boolean"
+ type: boolean
returns:
---
diff --git a/docs/libraries/UserMessages/WriteByte.md b/docs/libraries/UserMessages/WriteByte.md
index e6fbf84026..64f49f6bdf 100644
--- a/docs/libraries/UserMessages/WriteByte.md
+++ b/docs/libraries/UserMessages/WriteByte.md
@@ -14,8 +14,9 @@ lua:
description: "Writes a byte."
arguments:
- - name: "byte"
- type: number
+ - position: 1
+ name: "byte"
+ type: number
returns:
---
diff --git a/docs/libraries/UserMessages/WriteChar.md b/docs/libraries/UserMessages/WriteChar.md
index 237f75a9e5..92c2994932 100644
--- a/docs/libraries/UserMessages/WriteChar.md
+++ b/docs/libraries/UserMessages/WriteChar.md
@@ -14,8 +14,9 @@ lua:
description: "Writes a char."
arguments:
- - name: "char"
- type: number
+ - position: 1
+ name: "char"
+ type: number
returns:
---
diff --git a/docs/libraries/UserMessages/WriteEntity.md b/docs/libraries/UserMessages/WriteEntity.md
index edc03b11b0..cb835a15de 100644
--- a/docs/libraries/UserMessages/WriteEntity.md
+++ b/docs/libraries/UserMessages/WriteEntity.md
@@ -13,11 +13,11 @@ lua:
realm: server
description: "Writes an entity."
- argumentSets:
- - arguments:
+ arguments:
+ - position: 1
+ types:
- name: "entity"
type: Entity
- - arguments:
- name: "entity"
type: Entity
returns:
diff --git a/docs/libraries/UserMessages/WriteFloat.md b/docs/libraries/UserMessages/WriteFloat.md
index 9580e60937..4147bfc5f5 100644
--- a/docs/libraries/UserMessages/WriteFloat.md
+++ b/docs/libraries/UserMessages/WriteFloat.md
@@ -14,8 +14,9 @@ lua:
description: "Writes a float."
arguments:
- - name: "float"
- type: number
+ - position: 1
+ name: "float"
+ type: number
returns:
---
diff --git a/docs/libraries/UserMessages/WriteLong.md b/docs/libraries/UserMessages/WriteLong.md
index 7df7ef7911..1a515ea9cc 100644
--- a/docs/libraries/UserMessages/WriteLong.md
+++ b/docs/libraries/UserMessages/WriteLong.md
@@ -14,8 +14,9 @@ lua:
description: "Writes a long integer."
arguments:
- - name: "long"
- type: number
+ - position: 1
+ name: "long"
+ type: number
returns:
---
diff --git a/docs/libraries/UserMessages/WriteNormal.md b/docs/libraries/UserMessages/WriteNormal.md
index cf9bbe0144..5046739d43 100644
--- a/docs/libraries/UserMessages/WriteNormal.md
+++ b/docs/libraries/UserMessages/WriteNormal.md
@@ -14,8 +14,9 @@ lua:
description: "Writes a normal vector."
arguments:
- - name: "normal"
- type: Vector
+ - position: 1
+ name: "normal"
+ type: Vector
returns:
---
diff --git a/docs/libraries/UserMessages/WriteSBitLong.md b/docs/libraries/UserMessages/WriteSBitLong.md
new file mode 100644
index 0000000000..4cbf76269c
--- /dev/null
+++ b/docs/libraries/UserMessages/WriteSBitLong.md
@@ -0,0 +1,29 @@
+---
+template: lua-library-function.html
+title: WriteSBitLong
+icon: lua-server
+tags:
+ - lua
+ - server
+ - needs-verification
+ - needs-example
+lua:
+ library: UserMessages
+ function: WriteSBitLong
+ realm: server
+ description: "Writes a signed bit long."
+
+ arguments:
+ - position: 1
+ name: "value"
+ type: number
+ - position: 2
+ name: "numBits"
+ type: number
+ returns:
+
+---
+
+
+UserMessages.WriteSBitLong – Writes a signed bit long.
+
diff --git a/docs/libraries/UserMessages/WriteShort.md b/docs/libraries/UserMessages/WriteShort.md
index 4335ba9388..e603ba4703 100644
--- a/docs/libraries/UserMessages/WriteShort.md
+++ b/docs/libraries/UserMessages/WriteShort.md
@@ -14,8 +14,9 @@ lua:
description: "Writes a short integer."
arguments:
- - name: "short"
- type: number
+ - position: 1
+ name: "short"
+ type: number
returns:
---
diff --git a/docs/libraries/UserMessages/WriteString.md b/docs/libraries/UserMessages/WriteString.md
index 3e6935b877..23d47235ef 100644
--- a/docs/libraries/UserMessages/WriteString.md
+++ b/docs/libraries/UserMessages/WriteString.md
@@ -14,8 +14,9 @@ lua:
description: "Writes a string."
arguments:
- - name: "string"
- type: string
+ - position: 1
+ name: "string"
+ type: string
returns:
---
diff --git a/docs/libraries/UserMessages/WriteUInt.md b/docs/libraries/UserMessages/WriteUInt.md
new file mode 100644
index 0000000000..5139b8c9ba
--- /dev/null
+++ b/docs/libraries/UserMessages/WriteUInt.md
@@ -0,0 +1,29 @@
+---
+template: lua-library-function.html
+title: WriteUInt
+icon: lua-server
+tags:
+ - lua
+ - server
+ - needs-verification
+ - needs-example
+lua:
+ library: UserMessages
+ function: WriteUInt
+ realm: server
+ description: "Writes an unsigned bit long."
+
+ arguments:
+ - position: 1
+ name: "value"
+ type: number
+ - position: 2
+ name: "numBits"
+ type: number
+ returns:
+
+---
+
+
+UserMessages.WriteUInt – Writes an unsigned bit long.
+
diff --git a/docs/libraries/UserMessages/WriteVector.md b/docs/libraries/UserMessages/WriteVector.md
index 84406cad92..a5df756c0a 100644
--- a/docs/libraries/UserMessages/WriteVector.md
+++ b/docs/libraries/UserMessages/WriteVector.md
@@ -14,8 +14,9 @@ lua:
description: "Writes a vector."
arguments:
- - name: "vector"
- type: Vector
+ - position: 1
+ name: "vector"
+ type: Vector
returns:
---
diff --git a/docs/libraries/UserMessages/WriteWord.md b/docs/libraries/UserMessages/WriteWord.md
index e1861d0db2..f4b8eb2908 100644
--- a/docs/libraries/UserMessages/WriteWord.md
+++ b/docs/libraries/UserMessages/WriteWord.md
@@ -14,8 +14,9 @@ lua:
description: "Writes a word."
arguments:
- - name: "word"
- type: number
+ - position: 1
+ name: "word"
+ type: number
returns:
---
diff --git a/docs/libraries/Utilities/AngleDifference.md b/docs/libraries/Utilities/AngleDifference.md
index 1577359c11..bfb74cbdc9 100644
--- a/docs/libraries/Utilities/AngleDifference.md
+++ b/docs/libraries/Utilities/AngleDifference.md
@@ -14,10 +14,12 @@ lua:
description: "Compute the difference between two angles"
arguments:
- - name: "srcAngle"
- type: number
- - name: "dstAngle"
- type: number
+ - position: 1
+ name: "srcAngle"
+ type: number
+ - position: 2
+ name: "dstAngle"
+ type: number
returns:
- type: number
description: "Difference between the angles."
diff --git a/docs/libraries/Utilities/BoundToWorldSize.md b/docs/libraries/Utilities/BoundToWorldSize.md
index e2e719ad8f..6d5106a81e 100644
--- a/docs/libraries/Utilities/BoundToWorldSize.md
+++ b/docs/libraries/Utilities/BoundToWorldSize.md
@@ -14,8 +14,9 @@ lua:
description: "Bound the vector to the world size"
arguments:
- - name: "vec"
- type: Vector
+ - position: 1
+ name: "vec"
+ type: Vector
returns:
---
diff --git a/docs/libraries/Utilities/ComputeStringWidth.md b/docs/libraries/Utilities/ComputeStringWidth.md
index f1b9c0f253..f6908914a0 100644
--- a/docs/libraries/Utilities/ComputeStringWidth.md
+++ b/docs/libraries/Utilities/ComputeStringWidth.md
@@ -14,10 +14,12 @@ lua:
description: "Compute width of the string with the given font"
arguments:
- - name: "font"
- type: FontHandle
- - name: "text"
- type: string
+ - position: 1
+ name: "font"
+ type: FontHandle
+ - position: 2
+ name: "text"
+ type: string
returns:
- type: integer
description: "Width of the string."
diff --git a/docs/libraries/Utilities/CreateBubbles.md b/docs/libraries/Utilities/CreateBubbles.md
index 36eef5f314..2dae52e054 100644
--- a/docs/libraries/Utilities/CreateBubbles.md
+++ b/docs/libraries/Utilities/CreateBubbles.md
@@ -14,12 +14,15 @@ lua:
description: "Create bubbles at the specified position and range"
arguments:
- - name: "minPos"
- type: Vector
- - name: "maxPos"
- type: Vector
- - name: "count"
- type: number
+ - position: 1
+ name: "minPos"
+ type: Vector
+ - position: 2
+ name: "maxPos"
+ type: Vector
+ - position: 3
+ name: "count"
+ type: number
returns:
---
diff --git a/docs/libraries/Utilities/CreateSmoke.md b/docs/libraries/Utilities/CreateSmoke.md
index bb06d2f764..3c4af35ef7 100644
--- a/docs/libraries/Utilities/CreateSmoke.md
+++ b/docs/libraries/Utilities/CreateSmoke.md
@@ -14,12 +14,15 @@ lua:
description: "Create smoke effect at a position"
arguments:
- - name: "position"
- type: Vector
- - name: "modelIndex"
- type: number
- - name: "scale"
- type: number
+ - position: 1
+ name: "position"
+ type: Vector
+ - position: 2
+ name: "modelIndex"
+ type: number
+ - position: 3
+ name: "scale"
+ type: number
returns:
---
diff --git a/docs/libraries/Utilities/CreateTracer.md b/docs/libraries/Utilities/CreateTracer.md
index e219e4f9d6..bb7d88e9c1 100644
--- a/docs/libraries/Utilities/CreateTracer.md
+++ b/docs/libraries/Utilities/CreateTracer.md
@@ -14,20 +14,27 @@ lua:
description: "Create a tracer from the specified start to end position"
arguments:
- - name: "startPos"
- type: Vector
- - name: "endPos"
- type: Vector
- - name: "life"
- type: number
- - name: "width"
- type: number
- - name: "brightness"
- type: number
- - name: "noise"
- type: boolean
- - name: "modelname"
- type: string
+ - position: 1
+ name: "startPos"
+ type: Vector
+ - position: 2
+ name: "endPos"
+ type: Vector
+ - position: 3
+ name: "life"
+ type: number
+ - position: 4
+ name: "width"
+ type: number
+ - position: 5
+ name: "brightness"
+ type: number
+ - position: 6
+ name: "noise"
+ type: boolean
+ - position: 7
+ name: "modelname"
+ type: string
returns:
---
diff --git a/docs/libraries/Utilities/FindWaterSurface.md b/docs/libraries/Utilities/FindWaterSurface.md
index 7171eff19c..09827adcd8 100644
--- a/docs/libraries/Utilities/FindWaterSurface.md
+++ b/docs/libraries/Utilities/FindWaterSurface.md
@@ -14,12 +14,15 @@ lua:
description: "Finds the water surface at the given position."
arguments:
- - name: "position"
- type: Vector
- - name: "minZ"
- type: number
- - name: "maxZ"
- type: number
+ - position: 1
+ name: "position"
+ type: Vector
+ - position: 2
+ name: "minZ"
+ type: number
+ - position: 3
+ name: "maxZ"
+ type: number
returns:
- type: number
description: "The water surface z position."
diff --git a/docs/libraries/Utilities/GetLocalPlayer.md b/docs/libraries/Utilities/GetLocalPlayer.md
index 5fbc86ffed..5b9a54389b 100644
--- a/docs/libraries/Utilities/GetLocalPlayer.md
+++ b/docs/libraries/Utilities/GetLocalPlayer.md
@@ -13,6 +13,7 @@ lua:
realm: client
description: "Get the local player entity"
+ arguments:
returns:
- type: Entity
diff --git a/docs/libraries/Utilities/GetPointWaterLevel.md b/docs/libraries/Utilities/GetPointWaterLevel.md
index caae4e82c8..2058cadefe 100644
--- a/docs/libraries/Utilities/GetPointWaterLevel.md
+++ b/docs/libraries/Utilities/GetPointWaterLevel.md
@@ -14,12 +14,15 @@ lua:
description: "Get the water level at the specified position"
arguments:
- - name: "point"
- type: Vector
- - name: "minz"
- type: number
- - name: "maxz"
- type: number
+ - position: 1
+ name: "point"
+ type: Vector
+ - position: 2
+ name: "minz"
+ type: number
+ - position: 3
+ name: "maxz"
+ type: number
returns:
- type: number
description: "Water level at the specified position"
diff --git a/docs/libraries/Utilities/GetScreenHeight.md b/docs/libraries/Utilities/GetScreenHeight.md
index 74b476ea3f..8f9abd860b 100644
--- a/docs/libraries/Utilities/GetScreenHeight.md
+++ b/docs/libraries/Utilities/GetScreenHeight.md
@@ -13,6 +13,7 @@ lua:
realm: client
description: "Get screen height"
+ arguments:
returns:
- type: integer
diff --git a/docs/libraries/Utilities/GetScreenWidth.md b/docs/libraries/Utilities/GetScreenWidth.md
index 1de67f489c..4983eba2ca 100644
--- a/docs/libraries/Utilities/GetScreenWidth.md
+++ b/docs/libraries/Utilities/GetScreenWidth.md
@@ -13,6 +13,7 @@ lua:
realm: client
description: "Get screen width"
+ arguments:
returns:
- type: integer
diff --git a/docs/libraries/Utilities/ImpactTrace.md b/docs/libraries/Utilities/ImpactTrace.md
index 9c192bd3d6..629669b75f 100644
--- a/docs/libraries/Utilities/ImpactTrace.md
+++ b/docs/libraries/Utilities/ImpactTrace.md
@@ -14,13 +14,16 @@ lua:
description: "Generate an impact trace"
arguments:
- - name: "trace"
- type: Trace
- - name: "damageType"
- type: number
- - name: "customImpactName"
- type: string
- default: "0"
+ - position: 1
+ name: "trace"
+ type: Trace
+ - position: 2
+ name: "damageType"
+ type: number
+ - position: 3
+ name: "customImpactName"
+ type: string
+ default: "0"
returns:
---
diff --git a/docs/libraries/Utilities/InterpolateAngles.md b/docs/libraries/Utilities/InterpolateAngles.md
index 43bbae65fd..be74e1ae23 100644
--- a/docs/libraries/Utilities/InterpolateAngles.md
+++ b/docs/libraries/Utilities/InterpolateAngles.md
@@ -14,14 +14,18 @@ lua:
description: "Interpolate between angles based on the provided fraction"
arguments:
- - name: "startAngles"
- type: Angle
- - name: "endAngles"
- type: Angle
- - name: "resultAngles"
- type: Angle
- - name: "fraction"
- type: number
+ - position: 1
+ name: "startAngles"
+ type: Angle
+ - position: 2
+ name: "endAngles"
+ type: Angle
+ - position: 3
+ name: "resultAngles"
+ type: Angle
+ - position: 4
+ name: "fraction"
+ type: number
returns:
---
diff --git a/docs/libraries/Utilities/IntersectRayWithObb.md b/docs/libraries/Utilities/IntersectRayWithObb.md
index 48f4466267..8af92e373d 100644
--- a/docs/libraries/Utilities/IntersectRayWithObb.md
+++ b/docs/libraries/Utilities/IntersectRayWithObb.md
@@ -14,18 +14,24 @@ lua:
description: "Intersect a ray with an oriented bounding box"
arguments:
- - name: "vecRayStart"
- type: Vector
- - name: "vecRayDelta"
- type: Vector
- - name: "vecBoxOrigin"
- type: Vector
- - name: "angBoxAngles"
- type: Angle
- - name: "vecBoxMins"
- type: Vector
- - name: "vecBoxMaxs"
- type: Vector
+ - position: 1
+ name: "vecRayStart"
+ type: Vector
+ - position: 2
+ name: "vecRayDelta"
+ type: Vector
+ - position: 3
+ name: "vecBoxOrigin"
+ type: Vector
+ - position: 4
+ name: "angBoxAngles"
+ type: Angle
+ - position: 5
+ name: "vecBoxMins"
+ type: Vector
+ - position: 6
+ name: "vecBoxMaxs"
+ type: Vector
returns:
- type: Vector
description: "End position of the intersection"
diff --git a/docs/libraries/Utilities/IntersectRayWithPlane.md b/docs/libraries/Utilities/IntersectRayWithPlane.md
index df9c1e878d..1ec17c6c86 100644
--- a/docs/libraries/Utilities/IntersectRayWithPlane.md
+++ b/docs/libraries/Utilities/IntersectRayWithPlane.md
@@ -14,14 +14,18 @@ lua:
description: "Intersect a ray with a plane"
arguments:
- - name: "vecRayOrigin"
- type: Vector
- - name: "vecRayDirection"
- type: Vector
- - name: "vecPlaneOrigin"
- type: Vector
- - name: "vecPlaneNormal"
- type: Vector
+ - position: 1
+ name: "vecRayOrigin"
+ type: Vector
+ - position: 2
+ name: "vecRayDirection"
+ type: Vector
+ - position: 3
+ name: "vecPlaneOrigin"
+ type: Vector
+ - position: 4
+ name: "vecPlaneNormal"
+ type: Vector
returns:
- type: Vector
description: "Intersection position"
diff --git a/docs/libraries/Utilities/IntersectRayWithSphere.md b/docs/libraries/Utilities/IntersectRayWithSphere.md
index ea39e8c09d..fa07795e70 100644
--- a/docs/libraries/Utilities/IntersectRayWithSphere.md
+++ b/docs/libraries/Utilities/IntersectRayWithSphere.md
@@ -14,14 +14,18 @@ lua:
description: "Intersect a ray with a sphere"
arguments:
- - name: "vecRayOrigin"
- type: Vector
- - name: "vecRayDelta"
- type: Vector
- - name: "vecSphereCenter"
- type: Vector
- - name: "flRadius"
- type: number
+ - position: 1
+ name: "vecRayOrigin"
+ type: Vector
+ - position: 2
+ name: "vecRayDelta"
+ type: Vector
+ - position: 3
+ name: "vecSphereCenter"
+ type: Vector
+ - position: 4
+ name: "flRadius"
+ type: number
returns:
- type: number
description: "First intersection point"
diff --git a/docs/libraries/Utilities/IsBoxIntersectingSphere.md b/docs/libraries/Utilities/IsBoxIntersectingSphere.md
index 7fe9773dc4..93f3539768 100644
--- a/docs/libraries/Utilities/IsBoxIntersectingSphere.md
+++ b/docs/libraries/Utilities/IsBoxIntersectingSphere.md
@@ -14,14 +14,18 @@ lua:
description: "Check if a box is intersecting a sphere"
arguments:
- - name: "boxMin"
- type: Vector
- - name: "boxMax"
- type: Vector
- - name: "spherePosition"
- type: Vector
- - name: "sphereRadius"
- type: number
+ - position: 1
+ name: "boxMin"
+ type: Vector
+ - position: 2
+ name: "boxMax"
+ type: Vector
+ - position: 3
+ name: "spherePosition"
+ type: Vector
+ - position: 4
+ name: "sphereRadius"
+ type: number
returns:
- type: boolean
description: "True if the box is intersecting the sphere"
diff --git a/docs/libraries/Utilities/IsLowViolence.md b/docs/libraries/Utilities/IsLowViolence.md
index d55a44a052..3927f1f83a 100644
--- a/docs/libraries/Utilities/IsLowViolence.md
+++ b/docs/libraries/Utilities/IsLowViolence.md
@@ -13,6 +13,7 @@ lua:
realm: shared
description: "Check if the game is in low violence mode"
+ arguments:
returns:
- type: boolean
diff --git a/docs/libraries/Utilities/IsObbIntersectingObb.md b/docs/libraries/Utilities/IsObbIntersectingObb.md
index 02094d11a9..90f85a5e29 100644
--- a/docs/libraries/Utilities/IsObbIntersectingObb.md
+++ b/docs/libraries/Utilities/IsObbIntersectingObb.md
@@ -14,25 +14,34 @@ lua:
description: "Check if an oriented bounding box is intersecting another oriented bounding box"
arguments:
- - name: "vecOrigin1"
- type: Vector
- - name: "vecAngles1"
- type: Angle
- - name: "boxMin1"
- type: Vector
- - name: "boxMax1"
- type: Vector
- - name: "vecOrigin2"
- type: Vector
- - name: "vecAngles2"
- type: Angle
- - name: "boxMin2"
- type: Vector
- - name: "boxMax2"
- type: Vector
- - name: "flTolerance"
- type: number
- default: "0.0f"
+ - position: 1
+ name: "vecOrigin1"
+ type: Vector
+ - position: 2
+ name: "vecAngles1"
+ type: Angle
+ - position: 3
+ name: "boxMin1"
+ type: Vector
+ - position: 4
+ name: "boxMax1"
+ type: Vector
+ - position: 5
+ name: "vecOrigin2"
+ type: Vector
+ - position: 6
+ name: "vecAngles2"
+ type: Angle
+ - position: 7
+ name: "boxMin2"
+ type: Vector
+ - position: 8
+ name: "boxMax2"
+ type: Vector
+ - position: 9
+ name: "flTolerance"
+ type: number
+ default: "0.0f"
returns:
- type: boolean
description: "True if the oriented bounding boxes are intersecting"
diff --git a/docs/libraries/Utilities/IsSpaceEmpty.md b/docs/libraries/Utilities/IsSpaceEmpty.md
index fc099ecc44..d8115827cd 100644
--- a/docs/libraries/Utilities/IsSpaceEmpty.md
+++ b/docs/libraries/Utilities/IsSpaceEmpty.md
@@ -14,12 +14,15 @@ lua:
description: "Check if the space is empty"
arguments:
- - name: "entity"
- type: Entity
- - name: "minPos"
- type: Vector
- - name: "maxPos"
- type: Vector
+ - position: 1
+ name: "entity"
+ type: Entity
+ - position: 2
+ name: "minPos"
+ type: Vector
+ - position: 3
+ name: "maxPos"
+ type: Vector
returns:
- type: boolean
description: "True if the space is empty"
diff --git a/docs/libraries/Utilities/IsSphereIntersectingCone.md b/docs/libraries/Utilities/IsSphereIntersectingCone.md
index 866aa96f94..c87d4d5262 100644
--- a/docs/libraries/Utilities/IsSphereIntersectingCone.md
+++ b/docs/libraries/Utilities/IsSphereIntersectingCone.md
@@ -14,18 +14,24 @@ lua:
description: "Check if a sphere is intersecting a cone"
arguments:
- - name: "sphereCenter"
- type: Vector
- - name: "sphereRadius"
- type: number
- - name: "coneOrigin"
- type: Vector
- - name: "coneAxis"
- type: Vector
- - name: "coneSine"
- type: number
- - name: "coneCosine"
- type: number
+ - position: 1
+ name: "sphereCenter"
+ type: Vector
+ - position: 2
+ name: "sphereRadius"
+ type: number
+ - position: 3
+ name: "coneOrigin"
+ type: Vector
+ - position: 4
+ name: "coneAxis"
+ type: Vector
+ - position: 5
+ name: "coneSine"
+ type: number
+ - position: 6
+ name: "coneCosine"
+ type: number
returns:
- type: boolean
description: "True if the sphere is intersecting the cone"
diff --git a/docs/libraries/Utilities/IsSphereIntersectingSphere.md b/docs/libraries/Utilities/IsSphereIntersectingSphere.md
index 6a156245be..ddc67fa634 100644
--- a/docs/libraries/Utilities/IsSphereIntersectingSphere.md
+++ b/docs/libraries/Utilities/IsSphereIntersectingSphere.md
@@ -14,14 +14,18 @@ lua:
description: "Check if a sphere is intersecting another sphere"
arguments:
- - name: "sphereCenter1"
- type: Vector
- - name: "sphereRadius1"
- type: number
- - name: "sphereCenter2"
- type: Vector
- - name: "sphereRadius2"
- type: number
+ - position: 1
+ name: "sphereCenter1"
+ type: Vector
+ - position: 2
+ name: "sphereRadius1"
+ type: number
+ - position: 3
+ name: "sphereCenter2"
+ type: Vector
+ - position: 4
+ name: "sphereRadius2"
+ type: number
returns:
- type: boolean
description: "True if the spheres are intersecting"
diff --git a/docs/libraries/Utilities/IsValidModel.md b/docs/libraries/Utilities/IsValidModel.md
index 6dbd7e1ebc..04fb3c33a6 100644
--- a/docs/libraries/Utilities/IsValidModel.md
+++ b/docs/libraries/Utilities/IsValidModel.md
@@ -14,8 +14,9 @@ lua:
description: "Check if the given string is a valid model"
arguments:
- - name: "model"
- type: string
+ - position: 1
+ name: "model"
+ type: string
returns:
- type: boolean
description: "True if the model is valid"
diff --git a/docs/libraries/Utilities/IsValidPhysicsProp.md b/docs/libraries/Utilities/IsValidPhysicsProp.md
index 98bbee9c02..ae327884cb 100644
--- a/docs/libraries/Utilities/IsValidPhysicsProp.md
+++ b/docs/libraries/Utilities/IsValidPhysicsProp.md
@@ -14,8 +14,9 @@ lua:
description: "Check if the given string is a valid physics props"
arguments:
- - name: "model"
- type: string
+ - position: 1
+ name: "model"
+ type: string
returns:
- type: boolean
description: "True if the model is a valid physics prop"
diff --git a/docs/libraries/Utilities/NormalizeAngles.md b/docs/libraries/Utilities/NormalizeAngles.md
index 14747522f5..61510f6b98 100644
--- a/docs/libraries/Utilities/NormalizeAngles.md
+++ b/docs/libraries/Utilities/NormalizeAngles.md
@@ -14,8 +14,9 @@ lua:
description: "Normalize angles provided"
arguments:
- - name: "angles"
- type: Angle
+ - position: 1
+ name: "angles"
+ type: Angle
returns:
---
diff --git a/docs/libraries/Utilities/PointOnLineNearestPoint.md b/docs/libraries/Utilities/PointOnLineNearestPoint.md
index 3bd8285eca..07f9a11bfc 100644
--- a/docs/libraries/Utilities/PointOnLineNearestPoint.md
+++ b/docs/libraries/Utilities/PointOnLineNearestPoint.md
@@ -14,15 +14,19 @@ lua:
description: "Returns the nearest point on a line to a given point."
arguments:
- - name: "point"
- type: Vector
- - name: "lineStart"
- type: Vector
- - name: "lineEnd"
- type: Vector
- - name: "clamp"
- type: boolean
- default: "false"
+ - position: 1
+ name: "point"
+ type: Vector
+ - position: 2
+ name: "lineStart"
+ type: Vector
+ - position: 3
+ name: "lineEnd"
+ type: Vector
+ - position: 4
+ name: "clamp"
+ type: boolean
+ default: "false"
returns:
- type: Vector
description: "The nearest point on the line."
diff --git a/docs/libraries/Utilities/PrecacheDecal.md b/docs/libraries/Utilities/PrecacheDecal.md
index 5fc3096cf1..338b37caea 100644
--- a/docs/libraries/Utilities/PrecacheDecal.md
+++ b/docs/libraries/Utilities/PrecacheDecal.md
@@ -14,11 +14,13 @@ lua:
description: "Precaches a decal. If preload is specified, the file is loaded into the server/client's cache memory before level startup, otherwise it'll only load when actually used (which can cause a disk i/o hitch if it occurs during play of a level)."
arguments:
- - name: "name"
- type: string
- - name: "shouldPreload"
- type: boolean
- default: "false"
+ - position: 1
+ name: "name"
+ type: string
+ - position: 2
+ name: "shouldPreload"
+ type: boolean
+ default: "false"
returns:
- type: integer
description: "The decal index."
diff --git a/docs/libraries/Utilities/PrecacheOther.md b/docs/libraries/Utilities/PrecacheOther.md
index 4d6b6a99fc..92cf056ae7 100644
--- a/docs/libraries/Utilities/PrecacheOther.md
+++ b/docs/libraries/Utilities/PrecacheOther.md
@@ -14,8 +14,9 @@ lua:
description: "Precache an entity by class name"
arguments:
- - name: "className"
- type: string
+ - position: 1
+ name: "className"
+ type: string
returns:
---
diff --git a/docs/libraries/Utilities/SafeName.md b/docs/libraries/Utilities/SafeName.md
index 7106f112ce..e1ee7e46a1 100644
--- a/docs/libraries/Utilities/SafeName.md
+++ b/docs/libraries/Utilities/SafeName.md
@@ -14,8 +14,9 @@ lua:
description: "Get a safe name for the provided string"
arguments:
- - name: "name"
- type: string
+ - position: 1
+ name: "name"
+ type: string
returns:
- type: string
description: "Safe name."
diff --git a/docs/libraries/Utilities/SetEntityOrigin.md b/docs/libraries/Utilities/SetEntityOrigin.md
index 563edc2c6d..20651500f9 100644
--- a/docs/libraries/Utilities/SetEntityOrigin.md
+++ b/docs/libraries/Utilities/SetEntityOrigin.md
@@ -14,10 +14,12 @@ lua:
description: "Set the origin for an entity"
arguments:
- - name: "entity"
- type: Entity
- - name: "origin"
- type: Vector
+ - position: 1
+ name: "entity"
+ type: Entity
+ - position: 2
+ name: "origin"
+ type: Vector
returns:
---
diff --git a/docs/libraries/Utilities/ShakeScreen.md b/docs/libraries/Utilities/ShakeScreen.md
index 28db650ca9..7b3bb99dca 100644
--- a/docs/libraries/Utilities/ShakeScreen.md
+++ b/docs/libraries/Utilities/ShakeScreen.md
@@ -14,21 +14,28 @@ lua:
description: "Apply screen shake effect"
arguments:
- - name: "center"
- type: Vector
- - name: "amplitude"
- type: number
- - name: "frequency"
- type: number
- - name: "duration"
- type: number
- - name: "radius"
- type: number
- - name: "command"
- type: enumeration/SHAKE_COMMAND
- - name: "localAmplitude"
- type: boolean
- default: "false"
+ - position: 1
+ name: "center"
+ type: Vector
+ - position: 2
+ name: "amplitude"
+ type: number
+ - position: 3
+ name: "frequency"
+ type: number
+ - position: 4
+ name: "duration"
+ type: number
+ - position: 5
+ name: "radius"
+ type: number
+ - position: 6
+ name: "command"
+ type: enumeration/SHAKE_COMMAND
+ - position: 7
+ name: "localAmplitude"
+ type: boolean
+ default: "false"
returns:
---
diff --git a/docs/libraries/Utilities/ShouldShowBlood.md b/docs/libraries/Utilities/ShouldShowBlood.md
index bb5e8046ee..e5dc3f7032 100644
--- a/docs/libraries/Utilities/ShouldShowBlood.md
+++ b/docs/libraries/Utilities/ShouldShowBlood.md
@@ -14,8 +14,9 @@ lua:
description: "Check if blood of the given color should be shown"
arguments:
- - name: "bloodColor"
- type: number
+ - position: 1
+ name: "bloodColor"
+ type: number
returns:
- type: boolean
description: "True if blood should be shown"
diff --git a/docs/libraries/Utilities/ValidateSoundName.md b/docs/libraries/Utilities/ValidateSoundName.md
index 6fd0aeed84..49c88797e4 100644
--- a/docs/libraries/Utilities/ValidateSoundName.md
+++ b/docs/libraries/Utilities/ValidateSoundName.md
@@ -14,10 +14,12 @@ lua:
description: "Validates a sound name."
arguments:
- - name: "name"
- type: string
- - name: "default"
- type: string
+ - position: 1
+ name: "name"
+ type: string
+ - position: 2
+ name: "default"
+ type: string
returns:
- type: string
description: "The validated sound name."
diff --git a/docs/libraries/Vectors/AxisStringToPointDirection.md b/docs/libraries/Vectors/AxisStringToPointDirection.md
index 49aeae34c6..ab49c8ca7e 100644
--- a/docs/libraries/Vectors/AxisStringToPointDirection.md
+++ b/docs/libraries/Vectors/AxisStringToPointDirection.md
@@ -14,8 +14,9 @@ lua:
description: "Converts an axis string to a point direction."
arguments:
- - name: "axisString"
- type: string
+ - position: 1
+ name: "axisString"
+ type: string
returns:
- type: Vector
description: "The converted start point."
diff --git a/docs/libraries/Vectors/AxisStringToPointPoint.md b/docs/libraries/Vectors/AxisStringToPointPoint.md
index 9bfd0e4f0d..5752782b02 100644
--- a/docs/libraries/Vectors/AxisStringToPointPoint.md
+++ b/docs/libraries/Vectors/AxisStringToPointPoint.md
@@ -14,8 +14,9 @@ lua:
description: "Converts an axis string to a point point."
arguments:
- - name: "axisString"
- type: string
+ - position: 1
+ name: "axisString"
+ type: string
returns:
- type: Vector
description: "The converted start point."
diff --git a/docs/libraries/Vectors/AxisStringToUnitDirection.md b/docs/libraries/Vectors/AxisStringToUnitDirection.md
index 74d8f3fbca..bb4bd2656e 100644
--- a/docs/libraries/Vectors/AxisStringToUnitDirection.md
+++ b/docs/libraries/Vectors/AxisStringToUnitDirection.md
@@ -14,8 +14,9 @@ lua:
description: "Converts an axis string to a unit direction."
arguments:
- - name: "axisString"
- type: string
+ - position: 1
+ name: "axisString"
+ type: string
returns:
- type: Vector
description: "The converted unit direction."
diff --git a/docs/libraries/Vectors/Create.md b/docs/libraries/Vectors/Create.md
index f3361add5e..36a6cd61c7 100644
--- a/docs/libraries/Vectors/Create.md
+++ b/docs/libraries/Vectors/Create.md
@@ -13,23 +13,24 @@ lua:
realm: shared
description: "Creates a new vector."
- argumentSets:
- - arguments:
+ arguments:
+ - position: 1
+ types:
- name: "vector"
type: Vector
- - arguments:
- name: "vectorString"
type: string
- - arguments:
- name: "x"
type: number
- default: "0.0f"
- - name: "y"
- type: number
- default: "0.0f"
- - name: "z"
- type: number
- default: "0.0f"
+ default: "0.0f"
+ - position: 2
+ name: "y"
+ type: number
+ default: "0.0f"
+ - position: 3
+ name: "z"
+ type: number
+ default: "0.0f"
returns:
- type: Vector
description: "The created vector."
diff --git a/docs/libraries/Vectors/Lerp.md b/docs/libraries/Vectors/Lerp.md
index 6b15d31b1b..0c7a1512ad 100644
--- a/docs/libraries/Vectors/Lerp.md
+++ b/docs/libraries/Vectors/Lerp.md
@@ -14,12 +14,15 @@ lua:
description: "Linearly interpolates between two vectors."
arguments:
- - name: "fraction"
- type: number
- - name: "from"
- type: Vector
- - name: "to"
- type: Vector
+ - position: 1
+ name: "fraction"
+ type: number
+ - position: 2
+ name: "from"
+ type: Vector
+ - position: 3
+ name: "to"
+ type: Vector
returns:
- type: Vector
description: "The interpolated vector."
diff --git a/docs/libraries/Vectors/SnapDirectionToAxis.md b/docs/libraries/Vectors/SnapDirectionToAxis.md
index 39ec051778..798a917e84 100644
--- a/docs/libraries/Vectors/SnapDirectionToAxis.md
+++ b/docs/libraries/Vectors/SnapDirectionToAxis.md
@@ -14,11 +14,13 @@ lua:
description: "Modifies a vector so it snaps to the nearest axis vector (if within epsilon)."
arguments:
- - name: "direction"
- type: Vector
- - name: "epsilon"
- type: number
- default: "0.002f"
+ - position: 1
+ name: "direction"
+ type: Vector
+ - position: 2
+ name: "epsilon"
+ type: number
+ default: "0.002f"
returns:
---
diff --git a/docs/libraries/Vectors/VectorToPitch.md b/docs/libraries/Vectors/VectorToPitch.md
index e2466b2cf7..e11aa36673 100644
--- a/docs/libraries/Vectors/VectorToPitch.md
+++ b/docs/libraries/Vectors/VectorToPitch.md
@@ -14,8 +14,9 @@ lua:
description: "Converts a vector to a pitch angle."
arguments:
- - name: "vector"
- type: Vector
+ - position: 1
+ name: "vector"
+ type: Vector
returns:
- type: number
description: "The converted pitch angle."
diff --git a/docs/libraries/Vectors/VectorToYaw.md b/docs/libraries/Vectors/VectorToYaw.md
index 61296dc2eb..34bed34134 100644
--- a/docs/libraries/Vectors/VectorToYaw.md
+++ b/docs/libraries/Vectors/VectorToYaw.md
@@ -14,8 +14,9 @@ lua:
description: "Converts a vector to a yaw angle."
arguments:
- - name: "vector"
- type: Vector
+ - position: 1
+ name: "vector"
+ type: Vector
returns:
- type: number
description: "The converted yaw angle."
diff --git a/docs/libraries/Vectors/YawToVector.md b/docs/libraries/Vectors/YawToVector.md
index 7eb7871b37..949eaf8f37 100644
--- a/docs/libraries/Vectors/YawToVector.md
+++ b/docs/libraries/Vectors/YawToVector.md
@@ -14,8 +14,9 @@ lua:
description: "Converts a yaw angle to a vector."
arguments:
- - name: "yaw"
- type: number
+ - position: 1
+ name: "yaw"
+ type: number
returns:
- type: Vector
description: "The converted vector."
diff --git a/docs/libraries/WebConnections/RequestHttpMethod.md b/docs/libraries/WebConnections/RequestHttpMethod.md
new file mode 100644
index 0000000000..283dc865a8
--- /dev/null
+++ b/docs/libraries/WebConnections/RequestHttpMethod.md
@@ -0,0 +1,49 @@
+---
+template: lua-library-function.html
+title: RequestHttpMethod
+icon: lua-client
+tags:
+ - lua
+ - client
+ - needs-verification
+ - needs-example
+lua:
+ library: WebConnections
+ function: RequestHttpMethod
+ realm: client
+ description: "Performs an HTTP request of the specified method"
+
+ arguments:
+ - position: 1
+ name: "url"
+ type: string
+ - position: 2
+ name: "method"
+ type: string
+ - position: 3
+ name: "body"
+ type: string
+ default: "nullptr"
+ - position: 4
+ name: "parameters"
+ type: KeyValuesHandle
+ nillable: true
+ - position: 5
+ name: "headers"
+ type: KeyValuesHandle
+ nillable: true
+ - position: 6
+ name: "contentType"
+ type: string
+ default: "\"text/plain; charset=utf-8\""
+ - position: 7
+ name: "timeout"
+ type: number
+ default: "60"
+ returns:
+
+---
+
+
+WebConnections.RequestHttpMethod – Performs an HTTP request of the specified method
+
diff --git a/docs/libraries/WebConnections/index.md b/docs/libraries/WebConnections/index.md
new file mode 100644
index 0000000000..65ba1a9b35
--- /dev/null
+++ b/docs/libraries/WebConnections/index.md
@@ -0,0 +1,10 @@
+---
+template: lua-index.html
+childrenTitle: Functions
+include:
+ startsWith: libraries/WebConnections/
+exclude:
+ isIndex: true
+---
+
+# WebConnections
diff --git a/docs/libraries/debug/GetRealmColor.md b/docs/libraries/debug/GetRealmColor.md
index 6fa0fcfe1f..86d97d9e62 100644
--- a/docs/libraries/debug/GetRealmColor.md
+++ b/docs/libraries/debug/GetRealmColor.md
@@ -13,6 +13,7 @@ lua:
realm: shared
description: "Get the color of the current realm."
+ arguments:
returns:
diff --git a/docs/libraries/debug/IsSpewActive.md b/docs/libraries/debug/IsSpewActive.md
index 12a1f88601..11fc4acfd4 100644
--- a/docs/libraries/debug/IsSpewActive.md
+++ b/docs/libraries/debug/IsSpewActive.md
@@ -14,10 +14,12 @@ lua:
description: "Check if spew output is active."
arguments:
- - name: "groupName"
- type: string
- - name: "level"
- type: number
+ - position: 1
+ name: "groupName"
+ type: string
+ - position: 2
+ name: "level"
+ type: number
returns:
- type: boolean
description: "True if spew output is active, false otherwise."
diff --git a/docs/libraries/debug/PrintColorMessage.md b/docs/libraries/debug/PrintColorMessage.md
index cb808ae005..b9b92bbc4c 100644
--- a/docs/libraries/debug/PrintColorMessage.md
+++ b/docs/libraries/debug/PrintColorMessage.md
@@ -14,10 +14,12 @@ lua:
description: "Print a message to the console with a specific color."
arguments:
- - name: "color"
- type: Color
- - name: "message"
- type: string
+ - position: 1
+ name: "color"
+ type: Color
+ - position: 2
+ name: "message"
+ type: string
returns:
---
diff --git a/docs/libraries/debug/PrintDebugColorMessage.md b/docs/libraries/debug/PrintDebugColorMessage.md
index fe000a9262..cf67c0b533 100644
--- a/docs/libraries/debug/PrintDebugColorMessage.md
+++ b/docs/libraries/debug/PrintDebugColorMessage.md
@@ -14,10 +14,12 @@ lua:
description: "Print a debug message to the console with a specific color."
arguments:
- - name: "color"
- type: Color
- - name: "message"
- type: string
+ - position: 1
+ name: "color"
+ type: Color
+ - position: 2
+ name: "message"
+ type: string
returns:
---
diff --git a/docs/libraries/debug/PrintDebugLog.md b/docs/libraries/debug/PrintDebugLog.md
index 6d6a421b9e..3e8e333877 100644
--- a/docs/libraries/debug/PrintDebugLog.md
+++ b/docs/libraries/debug/PrintDebugLog.md
@@ -14,12 +14,15 @@ lua:
description: "Print a debug log message to the console."
arguments:
- - name: "message"
- type: string
- - name: "level"
- type: number
- - name: "groupName"
- type: string
+ - position: 1
+ name: "message"
+ type: string
+ - position: 2
+ name: "level"
+ type: number
+ - position: 3
+ name: "groupName"
+ type: string
returns:
---
diff --git a/docs/libraries/debug/PrintDebugMessage.md b/docs/libraries/debug/PrintDebugMessage.md
index 0726787aa4..ef295689aa 100644
--- a/docs/libraries/debug/PrintDebugMessage.md
+++ b/docs/libraries/debug/PrintDebugMessage.md
@@ -14,12 +14,15 @@ lua:
description: "Print a debug message to the console."
arguments:
- - name: "message"
- type: string
- - name: "level"
- type: number
- - name: "groupName"
- type: string
+ - position: 1
+ name: "message"
+ type: string
+ - position: 2
+ name: "level"
+ type: number
+ - position: 3
+ name: "groupName"
+ type: string
returns:
---
diff --git a/docs/libraries/debug/PrintDebugWarning.md b/docs/libraries/debug/PrintDebugWarning.md
index b31a9d0a60..871c0a6483 100644
--- a/docs/libraries/debug/PrintDebugWarning.md
+++ b/docs/libraries/debug/PrintDebugWarning.md
@@ -14,12 +14,15 @@ lua:
description: "Print a debug warning message to the console."
arguments:
- - name: "message"
- type: string
- - name: "level"
- type: number
- - name: "groupName"
- type: string
+ - position: 1
+ name: "message"
+ type: string
+ - position: 2
+ name: "level"
+ type: number
+ - position: 3
+ name: "groupName"
+ type: string
returns:
---
diff --git a/docs/libraries/debug/PrintDevLog.md b/docs/libraries/debug/PrintDevLog.md
index 37f09353c5..5208e56b1d 100644
--- a/docs/libraries/debug/PrintDevLog.md
+++ b/docs/libraries/debug/PrintDevLog.md
@@ -14,8 +14,9 @@ lua:
description: "Print a developer log message to the console."
arguments:
- - name: "message"
- type: string
+ - position: 1
+ name: "message"
+ type: string
returns:
---
diff --git a/docs/libraries/debug/PrintDevMessage.md b/docs/libraries/debug/PrintDevMessage.md
index b02bd6fd55..83dbbc82ea 100644
--- a/docs/libraries/debug/PrintDevMessage.md
+++ b/docs/libraries/debug/PrintDevMessage.md
@@ -14,8 +14,9 @@ lua:
description: "Print a developer message to the console."
arguments:
- - name: "message"
- type: string
+ - position: 1
+ name: "message"
+ type: string
returns:
---
diff --git a/docs/libraries/debug/PrintDevWarning.md b/docs/libraries/debug/PrintDevWarning.md
index d83058054e..6e65d19862 100644
--- a/docs/libraries/debug/PrintDevWarning.md
+++ b/docs/libraries/debug/PrintDevWarning.md
@@ -14,8 +14,9 @@ lua:
description: "Print a developer warning message to the console."
arguments:
- - name: "message"
- type: string
+ - position: 1
+ name: "message"
+ type: string
returns:
---
diff --git a/docs/libraries/debug/PrintLog.md b/docs/libraries/debug/PrintLog.md
index fd6579954c..f5767dd7c4 100644
--- a/docs/libraries/debug/PrintLog.md
+++ b/docs/libraries/debug/PrintLog.md
@@ -14,8 +14,9 @@ lua:
description: "Print a log message to the console."
arguments:
- - name: "message"
- type: string
+ - position: 1
+ name: "message"
+ type: string
returns:
---
diff --git a/docs/libraries/debug/PrintMessage.md b/docs/libraries/debug/PrintMessage.md
index 4faf29c1c4..f2eec9c5d0 100644
--- a/docs/libraries/debug/PrintMessage.md
+++ b/docs/libraries/debug/PrintMessage.md
@@ -14,8 +14,9 @@ lua:
description: "Print a message to the console."
arguments:
- - name: "message"
- type: string
+ - position: 1
+ name: "message"
+ type: string
returns:
---
diff --git a/docs/libraries/debug/PrintNetworkLog.md b/docs/libraries/debug/PrintNetworkLog.md
index e3ca68def7..8a3d8c4c89 100644
--- a/docs/libraries/debug/PrintNetworkLog.md
+++ b/docs/libraries/debug/PrintNetworkLog.md
@@ -14,10 +14,12 @@ lua:
description: "Print a network log message to the console."
arguments:
- - name: "level"
- type: number
- - name: "message"
- type: string
+ - position: 1
+ name: "level"
+ type: number
+ - position: 2
+ name: "message"
+ type: string
returns:
---
diff --git a/docs/libraries/debug/PrintNetworkMessage.md b/docs/libraries/debug/PrintNetworkMessage.md
index 194002d092..1790bac85a 100644
--- a/docs/libraries/debug/PrintNetworkMessage.md
+++ b/docs/libraries/debug/PrintNetworkMessage.md
@@ -14,10 +14,12 @@ lua:
description: "Print a network message to the console."
arguments:
- - name: "level"
- type: number
- - name: "message"
- type: string
+ - position: 1
+ name: "level"
+ type: number
+ - position: 2
+ name: "message"
+ type: string
returns:
---
diff --git a/docs/libraries/debug/PrintNetworkWarning.md b/docs/libraries/debug/PrintNetworkWarning.md
index d74a750fa4..754d576ab8 100644
--- a/docs/libraries/debug/PrintNetworkWarning.md
+++ b/docs/libraries/debug/PrintNetworkWarning.md
@@ -14,10 +14,12 @@ lua:
description: "Print a network warning message to the console."
arguments:
- - name: "level"
- type: number
- - name: "message"
- type: string
+ - position: 1
+ name: "level"
+ type: number
+ - position: 2
+ name: "message"
+ type: string
returns:
---
diff --git a/docs/libraries/debug/PrintWarning.md b/docs/libraries/debug/PrintWarning.md
index a1ec6d1025..49549826dc 100644
--- a/docs/libraries/debug/PrintWarning.md
+++ b/docs/libraries/debug/PrintWarning.md
@@ -14,8 +14,9 @@ lua:
description: "Print a warning message to the console."
arguments:
- - name: "message"
- type: string
+ - position: 1
+ name: "message"
+ type: string
returns:
---
diff --git a/docs/libraries/debug/SpewActivate.md b/docs/libraries/debug/SpewActivate.md
index b94b436af2..d7456d43ad 100644
--- a/docs/libraries/debug/SpewActivate.md
+++ b/docs/libraries/debug/SpewActivate.md
@@ -14,10 +14,12 @@ lua:
description: "Activate spew output."
arguments:
- - name: "groupName"
- type: string
- - name: "level"
- type: number
+ - position: 1
+ name: "groupName"
+ type: string
+ - position: 2
+ name: "level"
+ type: number
returns:
---
diff --git a/docs/libraries/math/AngleVectors.md b/docs/libraries/math/AngleVectors.md
index 6ddc848d2e..ac0e2e9479 100644
--- a/docs/libraries/math/AngleVectors.md
+++ b/docs/libraries/math/AngleVectors.md
@@ -13,21 +13,25 @@ lua:
realm: shared
description: "Converts an angle to a direction vector."
- argumentSets:
- - arguments:
+ arguments:
+ - position: 1
+ types:
- name: "Angle"
type: Angle
- - name: "Vector"
- type: Vector
- - name: "Vector"
- type: Vector
- - name: "Vector"
- type: Vector
- - arguments:
- name: "Angle"
type: Angle
+ - position: 2
+ types:
+ - name: "Vector"
+ type: Vector
- name: "Vector"
type: Vector
+ - position: 3
+ name: "Vector"
+ type: Vector
+ - position: 4
+ name: "Vector"
+ type: Vector
returns:
---
diff --git a/docs/libraries/math/Clamp.md b/docs/libraries/math/Clamp.md
index 141e6d680a..a94991e323 100644
--- a/docs/libraries/math/Clamp.md
+++ b/docs/libraries/math/Clamp.md
@@ -14,8 +14,15 @@ lua:
description: "Clamps a number between two values."
arguments:
- - name: "number"
- type: number
+ - position: 1
+ name: "number"
+ type: number
+ - position: 2
+ name: "number"
+ type: number
+ - position: 3
+ name: "number"
+ type: number
returns:
- type: number
description: "The number clamped between the two values."
diff --git a/docs/libraries/math/VectorAngles.md b/docs/libraries/math/VectorAngles.md
index 8494532901..927f24ce96 100644
--- a/docs/libraries/math/VectorAngles.md
+++ b/docs/libraries/math/VectorAngles.md
@@ -13,19 +13,22 @@ lua:
realm: shared
description: "Converts a direction vector to an angle."
- argumentSets:
- - arguments:
+ arguments:
+ - position: 1
+ types:
- name: "Vector"
type: Vector
- name: "Vector"
type: Vector
- - name: "Angle"
- type: Angle
- - arguments:
+ - position: 2
+ types:
- name: "Vector"
type: Vector
- name: "Angle"
type: Angle
+ - position: 3
+ name: "Angle"
+ type: Angle
returns:
---
diff --git a/docs/portal/contributing.md b/docs/portal/contributing.md
index aad8609575..fa7ff1b5c0 100644
--- a/docs/portal/contributing.md
+++ b/docs/portal/contributing.md
@@ -18,12 +18,12 @@ Most information about functions are specified in a page's metadata. This metada
is placed at the top of the markdown file and is used to generate the page into the
specified template.
-Take the following example taken from [Entity:GetAttachment](../classes/Entity/GetAttachment.md):
+Take the following example taken from [Vectors.Create](../libraries/Vectors/Create.md):
```yaml
---
-template: lua-class-function.html
-title: GetAttachment
+template: lua-library-function.html
+title: Create
icon: lua-shared
tags:
- lua
@@ -31,20 +31,32 @@ tags:
- needs-verification
- needs-example
lua:
- library: Entity
- function: GetAttachment
+ library: Vectors
+ function: Create
realm: shared
- description: "Get the attachment table for the specified attachment (by bone id or attachment name)"
- argumentSets:
- - arguments:
- - name: "boneId"
- type: number
- - arguments:
- - name: "attachmentName"
+ description: "Creates a new vector."
+
+ arguments:
+ - position: 1
+ types:
+ - name: "vector"
+ type: Vector
+ - name: "vectorString"
type: string
+ - name: "x"
+ type: number
+ default: "0.0f"
+ - position: 2
+ name: "y"
+ type: number
+ default: "0.0f"
+ - position: 3
+ name: "z"
+ type: number
+ default: "0.0f"
returns:
- - type: table
- description: "The attachment information"
+ - type: Vector
+ description: "The created vector."
---
```
diff --git a/docs_custom/theme/lua-partials/argument.html b/docs_custom/theme/lua-partials/argument.html
index e972feb7e3..f27192c666 100644
--- a/docs_custom/theme/lua-partials/argument.html
+++ b/docs_custom/theme/lua-partials/argument.html
@@ -2,10 +2,26 @@
{% if argument.nillable or argument.default %}
Optional
{% endif %}
-
{{ argument.name }}
- {% with type=argument.type %}
- {% include 'lua-partials/type.html' %}
- {% endwith %}
+
+ {% if argument.type %}
+
{{ argument.name }}
+
+ {% with type=argument.type %}
+ {% include 'lua-partials/type.html' %}
+ {% endwith %}
+ {% elif argument.types %}
+ {% for argumentVariation in argument.types %}
+
{{ argumentVariation.name }}
+
+ {% with type=argumentVariation.type %}
+ {% include 'lua-partials/type.html' %}
+
+ {% if not loop.last %}
+
or
+ {% endif %}
+ {% endwith %}
+ {% endfor %}
+ {% endif %}
{% if argument.description %}
{{ argument.description }}
diff --git a/docs_custom/theme/lua-partials/arguments.html b/docs_custom/theme/lua-partials/arguments.html
index 0480b9dc80..2a9cbfc6b5 100644
--- a/docs_custom/theme/lua-partials/arguments.html
+++ b/docs_custom/theme/lua-partials/arguments.html
@@ -10,27 +10,3 @@
Arguments
{% endfor %}
{% endif %}
-
-{% if page.meta.lua.argumentSets %}
-{% set hasMultipleArguments = false %}
-{% for argumentSet in page.meta.lua.argumentSets %}
-{% if argumentSet.arguments|length > 1 %}
-{% set hasMultipleArguments = true %}
-{% endif %}
-{% endfor %}
-{% if hasMultipleArguments %}
-
Arguments
-{% else %}
-
Argument
-{% endif %}
-
- {% for argumentSet in page.meta.lua.argumentSets %}
- {% if loop.index > 1 %}
- Or:
- {% endif %}
- {% for argument in argumentSet.arguments %}
- {% include 'lua-partials/argument.html' %}
- {% endfor %}
- {% endfor %}
-
-{% endif %}
diff --git a/docs_custom/theme/lua-partials/function-title-wrapper.html b/docs_custom/theme/lua-partials/function-title-wrapper.html
index 4d47aa3052..b5933836cb 100644
--- a/docs_custom/theme/lua-partials/function-title-wrapper.html
+++ b/docs_custom/theme/lua-partials/function-title-wrapper.html
@@ -3,13 +3,6 @@
{%- if page.meta.lua.arguments -%}
{% set arguments = page.meta.lua.arguments %}
{% include "lua-partials/function-title.html" %}
- {%- elif page.meta.lua.argumentSets -%}
-
- {% for argumentSet in page.meta.lua.argumentSets -%}
- {% set arguments = argumentSet.arguments %}
- {% include "lua-partials/function-title.html" %}
- {% endfor -%}
-
{%- else -%}
{% set arguments = [] %}
{% include "lua-partials/function-title.html" %}
diff --git a/docs_custom/theme/lua-partials/function-title.html b/docs_custom/theme/lua-partials/function-title.html
index 94e8abfe9a..01d1f161b1 100644
--- a/docs_custom/theme/lua-partials/function-title.html
+++ b/docs_custom/theme/lua-partials/function-title.html
@@ -7,7 +7,14 @@
{{- functionSeparator -}}
{%- endif -%}
{{- page.meta.lua.function -}}({% for argument in arguments -%}
- {{- argument.name -}}
+ {%- if argument.type -%}
+ {{- argument.type -}}
+ {%- elif argument.types -%}
+ {%- for argumentVariation in argument.types -%}
+ {{- argumentVariation.type -}}
+ {%- if not loop.last -%}|{%- endif -%}
+ {%- endfor -%}
+ {%- endif -%}
{%- if argument.nillable -%}?{% endif -%}
{%- if argument.default %} = {{ argument.default -}}
{%- endif -%}
diff --git a/src/game/client/scripted_controls/lHTML.cpp b/src/game/client/scripted_controls/lHTML.cpp
index d2354cba77..6897971b79 100644
--- a/src/game/client/scripted_controls/lHTML.cpp
+++ b/src/game/client/scripted_controls/lHTML.cpp
@@ -82,13 +82,13 @@ LUALIB_API lua_HTML *luaL_checkhtml( lua_State *L, int narg )
{
lua_HTML *d = lua_tohtml( L, narg );
if ( d == NULL ) /* avoid extra test when d is not 0 */
- luaL_argerror( L, narg, "HTML expected, got INVALID_PANEL" );
+ luaL_argerror( L, narg, "Html Panel expected, got INVALID_PANEL" );
return d;
}
-LUA_REGISTRATION_INIT( HTML )
+LUA_REGISTRATION_INIT( Html )
-LUA_BINDING_BEGIN( HTML, OpenUrl, "class", "Opens a URL in the HTML object" )
+LUA_BINDING_BEGIN( Html, OpenUrl, "class", "Opens a URL in the HTML object" )
{
lua_HTML *html = LUA_BINDING_ARGUMENT( luaL_checkhtml, 1, "html" );
const char *url = LUA_BINDING_ARGUMENT( luaL_checkstring, 2, "url" );
@@ -99,7 +99,7 @@ LUA_BINDING_BEGIN( HTML, OpenUrl, "class", "Opens a URL in the HTML object" )
}
LUA_BINDING_END()
-LUA_BINDING_BEGIN( HTML, StopLoading, "class", "Stops loading the current page" )
+LUA_BINDING_BEGIN( Html, StopLoading, "class", "Stops loading the current page" )
{
lua_HTML *html = LUA_BINDING_ARGUMENT( luaL_checkhtml, 1, "html" );
html->StopLoading();
@@ -107,7 +107,7 @@ LUA_BINDING_BEGIN( HTML, StopLoading, "class", "Stops loading the current page"
}
LUA_BINDING_END()
-LUA_BINDING_BEGIN( HTML, Refresh, "class", "Refreshes the current page" )
+LUA_BINDING_BEGIN( Html, Refresh, "class", "Refreshes the current page" )
{
lua_HTML *html = LUA_BINDING_ARGUMENT( luaL_checkhtml, 1, "html" );
html->Refresh();
@@ -115,7 +115,7 @@ LUA_BINDING_BEGIN( HTML, Refresh, "class", "Refreshes the current page" )
}
LUA_BINDING_END()
-LUA_BINDING_BEGIN( HTML, RunJavascript, "class", "Executes JavaScript in the HTML object" )
+LUA_BINDING_BEGIN( Html, RunJavascript, "class", "Executes JavaScript in the HTML object" )
{
lua_HTML *html = LUA_BINDING_ARGUMENT( luaL_checkhtml, 1, "html" );
const char *jsCode = LUA_BINDING_ARGUMENT( luaL_checkstring, 2, "jsCode" );
@@ -124,7 +124,7 @@ LUA_BINDING_BEGIN( HTML, RunJavascript, "class", "Executes JavaScript in the HTM
}
LUA_BINDING_END()
-LUA_BINDING_BEGIN( HTML, SetHtml, "class", "Sets the HTML content of the object" )
+LUA_BINDING_BEGIN( Html, SetHtml, "class", "Sets the HTML content of the object" )
{
lua_HTML *html = LUA_BINDING_ARGUMENT( luaL_checkhtml, 1, "html" );
const char *htmlContent = LUA_BINDING_ARGUMENT( luaL_checkstring, 2, "htmlContent" );
@@ -141,7 +141,7 @@ LUA_BINDING_BEGIN( HTML, SetHtml, "class", "Sets the HTML content of the object"
}
LUA_BINDING_END()
-LUA_BINDING_BEGIN( HTML, AddJavascriptObject, "class", "Adds a JavaScript object" )
+LUA_BINDING_BEGIN( Html, AddJavascriptObject, "class", "Adds a JavaScript object" )
{
lua_HTML *html = LUA_BINDING_ARGUMENT( luaL_checkhtml, 1, "html" );
const char *objectName = LUA_BINDING_ARGUMENT( luaL_checkstring, 2, "objectName" );
@@ -150,7 +150,7 @@ LUA_BINDING_BEGIN( HTML, AddJavascriptObject, "class", "Adds a JavaScript object
}
LUA_BINDING_END()
-LUA_BINDING_BEGIN( HTML, AddJavascriptObjectCallback, "class", "Adds a callback to a JavaScript object" )
+LUA_BINDING_BEGIN( Html, AddJavascriptObjectCallback, "class", "Adds a callback to a JavaScript object" )
{
lua_HTML *html = LUA_BINDING_ARGUMENT( luaL_checkhtml, 1, "html" );
const char *objectName = LUA_BINDING_ARGUMENT( luaL_checkstring, 2, "objectName" );
@@ -160,7 +160,7 @@ LUA_BINDING_BEGIN( HTML, AddJavascriptObjectCallback, "class", "Adds a callback
}
LUA_BINDING_END()
-LUA_BINDING_BEGIN( HTML, GoBack, "class", "Navigates back in the browser history" )
+LUA_BINDING_BEGIN( Html, GoBack, "class", "Navigates back in the browser history" )
{
lua_HTML *html = LUA_BINDING_ARGUMENT( luaL_checkhtml, 1, "html" );
html->GoBack();
@@ -168,7 +168,7 @@ LUA_BINDING_BEGIN( HTML, GoBack, "class", "Navigates back in the browser history
}
LUA_BINDING_END()
-LUA_BINDING_BEGIN( HTML, GoForward, "class", "Navigates forward in the browser history" )
+LUA_BINDING_BEGIN( Html, GoForward, "class", "Navigates forward in the browser history" )
{
lua_HTML *html = LUA_BINDING_ARGUMENT( luaL_checkhtml, 1, "html" );
html->GoForward();
@@ -176,7 +176,7 @@ LUA_BINDING_BEGIN( HTML, GoForward, "class", "Navigates forward in the browser h
}
LUA_BINDING_END()
-LUA_BINDING_BEGIN( HTML, CanGoBack, "class", "Checks if the browser can go back" )
+LUA_BINDING_BEGIN( Html, CanGoBack, "class", "Checks if the browser can go back" )
{
lua_HTML *html = LUA_BINDING_ARGUMENT( luaL_checkhtml, 1, "html" );
lua_pushboolean( L, html->BCanGoBack() );
@@ -184,7 +184,7 @@ LUA_BINDING_BEGIN( HTML, CanGoBack, "class", "Checks if the browser can go back"
}
LUA_BINDING_END( "boolean", "Whether the browser can go back" )
-LUA_BINDING_BEGIN( HTML, CanGoForward, "class", "Checks if the browser can go forward" )
+LUA_BINDING_BEGIN( Html, CanGoForward, "class", "Checks if the browser can go forward" )
{
lua_HTML *html = LUA_BINDING_ARGUMENT( luaL_checkhtml, 1, "html" );
lua_pushboolean( L, html->BCanGoFoward() );
@@ -192,7 +192,7 @@ LUA_BINDING_BEGIN( HTML, CanGoForward, "class", "Checks if the browser can go fo
}
LUA_BINDING_END( "boolean", "Whether the browser can go forward" )
-LUA_BINDING_BEGIN( HTML, SetScrollbarsEnabled, "class", "Enables or disables scrollbars" )
+LUA_BINDING_BEGIN( Html, SetScrollbarsEnabled, "class", "Enables or disables scrollbars" )
{
lua_HTML *html = LUA_BINDING_ARGUMENT( luaL_checkhtml, 1, "html" );
bool enable = LUA_BINDING_ARGUMENT( luaL_checkboolean, 2, "enable" );
@@ -201,7 +201,7 @@ LUA_BINDING_BEGIN( HTML, SetScrollbarsEnabled, "class", "Enables or disables scr
}
LUA_BINDING_END()
-LUA_BINDING_BEGIN( HTML, SetContextMenuEnabled, "class", "Enables or disables the context menu" )
+LUA_BINDING_BEGIN( Html, SetContextMenuEnabled, "class", "Enables or disables the context menu" )
{
lua_HTML *html = LUA_BINDING_ARGUMENT( luaL_checkhtml, 1, "html" );
bool enable = LUA_BINDING_ARGUMENT( luaL_checkboolean, 2, "enable" );
@@ -210,7 +210,7 @@ LUA_BINDING_BEGIN( HTML, SetContextMenuEnabled, "class", "Enables or disables th
}
LUA_BINDING_END()
-LUA_BINDING_BEGIN( HTML, SetViewSourceEnabled, "class", "Enables or disables view source option" )
+LUA_BINDING_BEGIN( Html, SetViewSourceEnabled, "class", "Enables or disables view source option" )
{
lua_HTML *html = LUA_BINDING_ARGUMENT( luaL_checkhtml, 1, "html" );
bool enable = LUA_BINDING_ARGUMENT( luaL_checkboolean, 2, "enable" );
@@ -219,7 +219,7 @@ LUA_BINDING_BEGIN( HTML, SetViewSourceEnabled, "class", "Enables or disables vie
}
LUA_BINDING_END()
-LUA_BINDING_BEGIN( HTML, NewWindowsOnly, "class", "Allows opening new windows only" )
+LUA_BINDING_BEGIN( Html, NewWindowsOnly, "class", "Allows opening new windows only" )
{
lua_HTML *html = LUA_BINDING_ARGUMENT( luaL_checkhtml, 1, "html" );
bool enable = LUA_BINDING_ARGUMENT( luaL_checkboolean, 2, "enable" );
@@ -228,13 +228,13 @@ LUA_BINDING_BEGIN( HTML, NewWindowsOnly, "class", "Allows opening new windows on
}
LUA_BINDING_END()
-LUA_BINDING_BEGIN( HTML, IsLoading, "class", "Checks if the HTML is currently loading" )
+LUA_BINDING_BEGIN( Html, IsLoading, "class", "Checks if the HTML is currently loading" )
{
LHTML *html = dynamic_cast< LHTML * >( LUA_BINDING_ARGUMENT( luaL_checkhtml, 1, "html" ) );
if ( html == NULL )
{
// Experiment; TODO: Will this happen?
- luaL_argerror( L, 1, "Lua HTML expected, got a different HTML?" );
+ luaL_argerror( L, 1, "Lua Html Panel expected, got a different HTML?" );
return 0;
}
lua_pushboolean( L, html->IsLoading() );
@@ -242,7 +242,7 @@ LUA_BINDING_BEGIN( HTML, IsLoading, "class", "Checks if the HTML is currently lo
}
LUA_BINDING_END( "boolean", "Whether the HTML is loading" )
-LUA_BINDING_BEGIN( HTML, IsScrolledToBottom, "class", "Checks if the HTML is scrolled to the bottom" )
+LUA_BINDING_BEGIN( Html, IsScrolledToBottom, "class", "Checks if the HTML is scrolled to the bottom" )
{
lua_HTML *html = LUA_BINDING_ARGUMENT( luaL_checkhtml, 1, "html" );
lua_pushboolean( L, html->IsScrolledToBottom() );
@@ -250,7 +250,7 @@ LUA_BINDING_BEGIN( HTML, IsScrolledToBottom, "class", "Checks if the HTML is scr
}
LUA_BINDING_END( "boolean", "Whether the HTML is scrolled to the bottom" )
-LUA_BINDING_BEGIN( HTML, IsScrollbarVisible, "class", "Checks if the scrollbar is visible" )
+LUA_BINDING_BEGIN( Html, IsScrollbarVisible, "class", "Checks if the scrollbar is visible" )
{
lua_HTML *html = LUA_BINDING_ARGUMENT( luaL_checkhtml, 1, "html" );
lua_pushboolean( L, html->IsScrollbarVisible() );
@@ -258,7 +258,7 @@ LUA_BINDING_BEGIN( HTML, IsScrollbarVisible, "class", "Checks if the scrollbar i
}
LUA_BINDING_END( "boolean", "Whether the scrollbar is visible" )
-LUA_BINDING_BEGIN( HTML, AddCustomURLHandler, "class", "Adds a custom URL handler" )
+LUA_BINDING_BEGIN( Html, AddCustomURLHandler, "class", "Adds a custom URL handler" )
{
lua_HTML *html = LUA_BINDING_ARGUMENT( luaL_checkhtml, 1, "html" );
const char *url = LUA_BINDING_ARGUMENT( luaL_checkstring, 2, "url" );
@@ -268,7 +268,7 @@ LUA_BINDING_BEGIN( HTML, AddCustomURLHandler, "class", "Adds a custom URL handle
}
LUA_BINDING_END()
-LUA_BINDING_BEGIN( HTML, Find, "class", "Finds text in the HTML object" )
+LUA_BINDING_BEGIN( Html, Find, "class", "Finds text in the HTML object" )
{
lua_HTML *html = LUA_BINDING_ARGUMENT( luaL_checkhtml, 1, "html" );
const char *text = LUA_BINDING_ARGUMENT( luaL_checkstring, 2, "text" );
@@ -277,7 +277,7 @@ LUA_BINDING_BEGIN( HTML, Find, "class", "Finds text in the HTML object" )
}
LUA_BINDING_END()
-LUA_BINDING_BEGIN( HTML, StopFind, "class", "Stops finding text" )
+LUA_BINDING_BEGIN( Html, StopFind, "class", "Stops finding text" )
{
lua_HTML *html = LUA_BINDING_ARGUMENT( luaL_checkhtml, 1, "html" );
html->StopFind();
@@ -285,14 +285,14 @@ LUA_BINDING_BEGIN( HTML, StopFind, "class", "Stops finding text" )
}
LUA_BINDING_END()
-LUA_BINDING_BEGIN( HTML, FindNext, "class", "Finds the next occurrence of text" )
+LUA_BINDING_BEGIN( Html, FindNext, "class", "Finds the next occurrence of text" )
{
lua_HTML *html = LUA_BINDING_ARGUMENT( luaL_checkhtml, 1, "html" );
html->FindNext();
return 0;
}
LUA_BINDING_END()
-LUA_BINDING_BEGIN( HTML, FindPrevious, "class", "Finds the previous occurrence of text" )
+LUA_BINDING_BEGIN( Html, FindPrevious, "class", "Finds the previous occurrence of text" )
{
lua_HTML *html = LUA_BINDING_ARGUMENT( luaL_checkhtml, 1, "html" );
html->FindPrevious();
@@ -300,7 +300,7 @@ LUA_BINDING_BEGIN( HTML, FindPrevious, "class", "Finds the previous occurrence o
}
LUA_BINDING_END()
-LUA_BINDING_BEGIN( HTML, ShowFindDialog, "class", "Shows the find dialog" )
+LUA_BINDING_BEGIN( Html, ShowFindDialog, "class", "Shows the find dialog" )
{
lua_HTML *html = LUA_BINDING_ARGUMENT( luaL_checkhtml, 1, "html" );
html->ShowFindDialog();
@@ -308,7 +308,7 @@ LUA_BINDING_BEGIN( HTML, ShowFindDialog, "class", "Shows the find dialog" )
}
LUA_BINDING_END()
-LUA_BINDING_BEGIN( HTML, HideFindDialog, "class", "Hides the find dialog" )
+LUA_BINDING_BEGIN( Html, HideFindDialog, "class", "Hides the find dialog" )
{
lua_HTML *html = LUA_BINDING_ARGUMENT( luaL_checkhtml, 1, "html" );
html->HideFindDialog();
@@ -316,7 +316,7 @@ LUA_BINDING_BEGIN( HTML, HideFindDialog, "class", "Hides the find dialog" )
}
LUA_BINDING_END()
-LUA_BINDING_BEGIN( HTML, FindDialogVisible, "class", "Checks if the find dialog is visible" )
+LUA_BINDING_BEGIN( Html, FindDialogVisible, "class", "Checks if the find dialog is visible" )
{
lua_HTML *html = LUA_BINDING_ARGUMENT( luaL_checkhtml, 1, "html" );
lua_pushboolean( L, html->FindDialogVisible() );
@@ -324,7 +324,7 @@ LUA_BINDING_BEGIN( HTML, FindDialogVisible, "class", "Checks if the find dialog
}
LUA_BINDING_END( "boolean", "Whether the find dialog is visible" )
-LUA_BINDING_BEGIN( HTML, HorizontalScrollMax, "class", "Gets the maximum horizontal scroll value" )
+LUA_BINDING_BEGIN( Html, HorizontalScrollMax, "class", "Gets the maximum horizontal scroll value" )
{
lua_HTML *html = LUA_BINDING_ARGUMENT( luaL_checkhtml, 1, "html" );
lua_pushinteger( L, html->HorizontalScrollMax() );
@@ -332,7 +332,7 @@ LUA_BINDING_BEGIN( HTML, HorizontalScrollMax, "class", "Gets the maximum horizon
}
LUA_BINDING_END( "integer", "The maximum horizontal scroll value" )
-LUA_BINDING_BEGIN( HTML, VerticalScrollMax, "class", "Gets the maximum vertical scroll value" )
+LUA_BINDING_BEGIN( Html, VerticalScrollMax, "class", "Gets the maximum vertical scroll value" )
{
lua_HTML *html = LUA_BINDING_ARGUMENT( luaL_checkhtml, 1, "html" );
lua_pushinteger( L, html->VerticalScrollMax() );
@@ -340,7 +340,7 @@ LUA_BINDING_BEGIN( HTML, VerticalScrollMax, "class", "Gets the maximum vertical
}
LUA_BINDING_END( "integer", "The maximum vertical scroll value" )
-LUA_BINDING_BEGIN( HTML, GetLinkAtPosition, "class", "Gets the link at a specific position" )
+LUA_BINDING_BEGIN( Html, GetLinkAtPosition, "class", "Gets the link at a specific position" )
{
lua_HTML *html = LUA_BINDING_ARGUMENT( luaL_checkhtml, 1, "html" );
double x = LUA_BINDING_ARGUMENT( luaL_checknumber, 2, "x" );
@@ -350,7 +350,7 @@ LUA_BINDING_BEGIN( HTML, GetLinkAtPosition, "class", "Gets the link at a specifi
}
LUA_BINDING_END()
-LUA_BINDING_BEGIN( HTML, __index, "class", "Metamethod called when a non-existent field is indexed" )
+LUA_BINDING_BEGIN( Html, __index, "class", "Metamethod called when a non-existent field is indexed" )
{
HTML *pHTML = LUA_BINDING_ARGUMENT( lua_tohtml, 1, "html" );
LUA_METATABLE_INDEX_CHECK_VALID( L, PanelIsValid );
@@ -376,7 +376,7 @@ LUA_BINDING_BEGIN( HTML, __index, "class", "Metamethod called when a non-existen
}
LUA_BINDING_END( "any", "The value of the field" )
-LUA_BINDING_BEGIN( HTML, __newindex, "class", "Metamethod called when a new field is added" )
+LUA_BINDING_BEGIN( Html, __newindex, "class", "Metamethod called when a new field is added" )
{
HTML *pHTML = LUA_BINDING_ARGUMENT( lua_tohtml, 1, "html" );
@@ -403,14 +403,14 @@ LUA_BINDING_BEGIN( HTML, __newindex, "class", "Metamethod called when a new fiel
}
LUA_BINDING_END()
-LUA_BINDING_BEGIN( HTML, __eq, "class", "Metamethod called when two HTML objects are compared" )
+LUA_BINDING_BEGIN( Html, __eq, "class", "Metamethod called when two HTML objects are compared" )
{
lua_pushboolean( L, LUA_BINDING_ARGUMENT( lua_tohtml, 1, "html" ) == LUA_BINDING_ARGUMENT( lua_tohtml, 2, "other" ) );
return 1;
}
LUA_BINDING_END( "boolean", "Whether the HTML objects are equal" )
-LUA_BINDING_BEGIN( HTML, __tostring, "class", "Metamethod called when the HTML object is converted to a string" )
+LUA_BINDING_BEGIN( Html, __tostring, "class", "Metamethod called when the HTML object is converted to a string" )
{
HTML *pHTML = LUA_BINDING_ARGUMENT( lua_tohtml, 1, "html" );
if ( pHTML == NULL )
@@ -420,7 +420,7 @@ LUA_BINDING_BEGIN( HTML, __tostring, "class", "Metamethod called when the HTML o
const char *pName = pHTML->GetName();
if ( Q_strcmp( pName, "" ) == 0 )
pName = "(no name)";
- lua_pushfstring( L, "HTML: \"%s\"", pName );
+ lua_pushfstring( L, "Html: \"%s\"", pName );
}
return 1;
}
@@ -453,7 +453,7 @@ LUALIB_API int luaopen_vgui_HTML( lua_State *L )
{
LUA_PUSH_NEW_METATABLE( L, "Html" );
- LUA_REGISTRATION_COMMIT( HTML );
+ LUA_REGISTRATION_COMMIT( Html );
lua_pushstring( L, LUA_PANELMETANAME );
lua_setfield( L, -2, "__type" ); /* metatable.__type = "Panel" */
diff --git a/src/game/shared/experiment/util/lwebconnections.cpp b/src/game/shared/experiment/util/lwebconnections.cpp
index d76f48b719..ae182ef7a0 100644
--- a/src/game/shared/experiment/util/lwebconnections.cpp
+++ b/src/game/shared/experiment/util/lwebconnections.cpp
@@ -18,7 +18,7 @@ LUA_BINDING_BEGIN( WebConnectionHeadersHandle, __index, "class", "Get the header
luaL_getmetatable( L, WEBCONNECTIONSHEADERSMETANAME );
lua_getmetatable( L, 1 );
- if (!lua_istable( L, 1 ) || !lua_rawequal( L, -1, -2 ))
+ if ( !LUA_BINDING_ARGUMENT( lua_istable, 1, "webConnectionHeaders" ) || !lua_rawequal( L, -1, -2 ) )
{
luaL_typeerror( L, 1, WEBCONNECTIONSHEADERSMETANAME );
return 0;
diff --git a/src/game/shared/lbaseentity_shared.cpp b/src/game/shared/lbaseentity_shared.cpp
index 898fcab341..dfe61128c7 100644
--- a/src/game/shared/lbaseentity_shared.cpp
+++ b/src/game/shared/lbaseentity_shared.cpp
@@ -268,18 +268,6 @@ LUA_BINDING_BEGIN( Entity, CreateDataObject, "class", "Create data object." )
}
LUA_BINDING_END()
-LUA_BINDING_BEGIN( Entity, CreatePredictedEntityByName, "class", "Create predicted entity by name." )
-{
- const char *pszClassName = LUA_BINDING_ARGUMENT( luaL_checkstring, 2, "className" );
- const char *pszModule = LUA_BINDING_ARGUMENT( luaL_checkstring, 3, "module" );
- int nLine = LUA_BINDING_ARGUMENT( luaL_checknumber, 4, "line" );
- bool bPersists = LUA_BINDING_ARGUMENT_WITH_DEFAULT( luaL_optboolean, 5, false, "shouldPersist" );
-
- CBaseEntity::PushLuaInstanceSafe( L, CBaseEntity::CreatePredictedEntityByName( pszClassName, pszModule, nLine, bPersists ) );
- return 1;
-}
-LUA_BINDING_END( "Entity", "The predicted entity." )
-
LUA_BINDING_BEGIN( Entity, CreateVPhysics, "class", "Create VPhysics." )
{
lua_CBaseEntity *pEntity = LUA_BINDING_ARGUMENT( luaL_checkentity, 1, "entity" );
diff --git a/src/game/shared/lentities.cpp b/src/game/shared/lentities.cpp
index 205d1cfc71..699c66ec34 100644
--- a/src/game/shared/lentities.cpp
+++ b/src/game/shared/lentities.cpp
@@ -46,6 +46,18 @@ LUA_BINDING_BEGIN( Entities, CreateByName, "library", "Creates an entity by the
LUA_BINDING_END( "Entity", "The created entity" )
#endif
+LUA_BINDING_BEGIN( Entities, CreatePredictedEntityByName, "class", "Create predicted entity by name." )
+{
+ const char *pszClassName = LUA_BINDING_ARGUMENT( luaL_checkstring, 1, "className" );
+ const char *pszModule = LUA_BINDING_ARGUMENT( luaL_checkstring, 2, "module" );
+ int nLine = LUA_BINDING_ARGUMENT( luaL_checknumber, 3, "line" );
+ bool bPersists = LUA_BINDING_ARGUMENT_WITH_DEFAULT( luaL_optboolean, 4, false, "shouldPersist" );
+
+ CBaseEntity::PushLuaInstanceSafe( L, CBaseEntity::CreatePredictedEntityByName( pszClassName, pszModule, nLine, bPersists ) );
+ return 1;
+}
+LUA_BINDING_END( "Entity", "The predicted entity." )
+
LUA_BINDING_BEGIN( Entities, GetAlongRay, "library", "Finds all entities along the given ray." )
{
CBaseEntity *pList[MAX_ENTITYARRAY];
diff --git a/src/public/engine/livdebugoverlay.cpp b/src/public/engine/livdebugoverlay.cpp
index b2335ba652..eaab168120 100644
--- a/src/public/engine/livdebugoverlay.cpp
+++ b/src/public/engine/livdebugoverlay.cpp
@@ -11,6 +11,8 @@
LUA_REGISTRATION_INIT( DebugOverlays );
+#define color_white lua_Color( 255, 255, 255, 255 )
+
LUA_BINDING_BEGIN( DebugOverlays, AddBox, "library", "Add a box overlay to the screen with specific colors." )
{
Vector start = LUA_BINDING_ARGUMENT( luaL_checkvector, 1, "start" );
@@ -18,7 +20,7 @@ LUA_BINDING_BEGIN( DebugOverlays, AddBox, "library", "Add a box overlay to the s
Vector maxs = LUA_BINDING_ARGUMENT( luaL_checkvector, 3, "maxs" );
QAngle angles = LUA_BINDING_ARGUMENT( luaL_checkangle, 4, "angles" );
float duration = LUA_BINDING_ARGUMENT_WITH_DEFAULT( luaL_optnumber, 5, 1, "duration" );
- lua_Color faceColor = LUA_BINDING_ARGUMENT_WITH_DEFAULT( luaL_optcolor, 6, lua_Color( 255, 255, 255, 255 ), "faceColor" );
+ lua_Color faceColor = LUA_BINDING_ARGUMENT_WITH_DEFAULT( luaL_optcolor, 6, color_white, "faceColor" );
lua_Color edgeColor = LUA_BINDING_ARGUMENT_WITH_DEFAULT( luaL_optcolor, 7, faceColor, "edgeColor" );
debugoverlay->AddBoxOverlay2( start, mins, maxs, angles, faceColor, edgeColor, duration );
@@ -41,7 +43,7 @@ LUA_BINDING_BEGIN( DebugOverlays, AddLine, "library", "Add a line overlay to the
Vector start = LUA_BINDING_ARGUMENT( luaL_checkvector, 1, "start" );
Vector end = LUA_BINDING_ARGUMENT( luaL_checkvector, 2, "end" );
float duration = LUA_BINDING_ARGUMENT_WITH_DEFAULT( luaL_optnumber, 3, 1, "duration" );
- lua_Color color = LUA_BINDING_ARGUMENT_WITH_DEFAULT( luaL_optcolor, 4, lua_Color( 255, 255, 255, 255 ), "color" );
+ lua_Color color = LUA_BINDING_ARGUMENT_WITH_DEFAULT( luaL_optcolor, 4, color_white, "color" );
bool noDepthTest = LUA_BINDING_ARGUMENT_WITH_DEFAULT( luaL_optboolean, 5, false, "noDepthTest" );
debugoverlay->AddLineOverlayAlpha( start, end, color.r(), color.g(), color.b(), color.a(), noDepthTest, duration );
@@ -56,7 +58,7 @@ LUA_BINDING_BEGIN( DebugOverlays, AddText, "library", "Add a text overlay to the
float duration = LUA_BINDING_ARGUMENT_WITH_DEFAULT( luaL_optnumber, 3, 1, "duration" );
bool viewCheck = LUA_BINDING_ARGUMENT_WITH_DEFAULT( luaL_optboolean, 4, false, "viewCheck" );
int lineOffset = LUA_BINDING_ARGUMENT_WITH_DEFAULT( luaL_optnumber, 5, 64, "lineOffset" );
- lua_Color color = LUA_BINDING_ARGUMENT_WITH_DEFAULT( luaL_optcolor, 6, lua_Color( 255, 255, 255, 255 ), "color" );
+ lua_Color color = LUA_BINDING_ARGUMENT_WITH_DEFAULT( luaL_optcolor, 6, color_white, "color" );
if ( viewCheck )
DevWarning( "DebugOverlays.AddText: viewCheck argument (4) is not yet implemented.\n" );
@@ -72,7 +74,7 @@ LUA_BINDING_BEGIN( DebugOverlays, AddScreenText, "library", "Add a screen text o
float y = LUA_BINDING_ARGUMENT( luaL_checknumber, 2, "y" );
const char *text = LUA_BINDING_ARGUMENT( luaL_checkstring, 3, "text" );
float duration = LUA_BINDING_ARGUMENT_WITH_DEFAULT( luaL_optnumber, 4, 1, "duration" );
- lua_Color color = LUA_BINDING_ARGUMENT_WITH_DEFAULT( luaL_optcolor, 5, lua_Color( 255, 255, 255, 255 ), "color" );
+ lua_Color color = LUA_BINDING_ARGUMENT_WITH_DEFAULT( luaL_optcolor, 5, color_white, "color" );
debugoverlay->AddScreenTextOverlay( x, y, duration, color.r(), color.g(), color.b(), color.a(), text );
return 0;
@@ -85,7 +87,7 @@ LUA_BINDING_BEGIN( DebugOverlays, AddEntityTextOverlay, "library", "Displays 2D
int lineOffset = LUA_BINDING_ARGUMENT( luaL_checknumber, 2, "lineOffset" );
const char *text = LUA_BINDING_ARGUMENT( luaL_checkstring, 3, "text" );
float duration = LUA_BINDING_ARGUMENT_WITH_DEFAULT( luaL_optnumber, 4, 1, "duration" );
- lua_Color color = LUA_BINDING_ARGUMENT_WITH_DEFAULT( luaL_optcolor, 5, lua_Color( 255, 255, 255, 255 ), "color" );
+ lua_Color color = LUA_BINDING_ARGUMENT_WITH_DEFAULT( luaL_optcolor, 5, color_white, "color" );
debugoverlay->AddEntityTextOverlay( entity->entindex(), lineOffset, duration, color.r(), color.g(), color.b(), color.a(), "%s", text );
return 0;
@@ -100,7 +102,7 @@ LUA_BINDING_BEGIN( DebugOverlays, AddSweptBox, "library", "Add a swept box overl
Vector maxs = LUA_BINDING_ARGUMENT( luaL_checkvector, 4, "maxs" );
QAngle angles = LUA_BINDING_ARGUMENT( luaL_checkangle, 5, "angles" );
float duration = LUA_BINDING_ARGUMENT_WITH_DEFAULT( luaL_optnumber, 6, 1, "duration" );
- lua_Color color = LUA_BINDING_ARGUMENT_WITH_DEFAULT( luaL_optcolor, 7, lua_Color( 255, 255, 255, 255 ), "color" );
+ lua_Color color = LUA_BINDING_ARGUMENT_WITH_DEFAULT( luaL_optcolor, 7, color_white, "color" );
debugoverlay->AddSweptBoxOverlay( start, end, mins, maxs, angles, color.r(), color.g(), color.b(), color.a(), duration );
return 0;
@@ -113,7 +115,7 @@ LUA_BINDING_BEGIN( DebugOverlays, AddTriangle, "library", "Add a triangle overla
Vector p2 = LUA_BINDING_ARGUMENT( luaL_checkvector, 2, "p2" );
Vector p3 = LUA_BINDING_ARGUMENT( luaL_checkvector, 3, "p3" );
float duration = LUA_BINDING_ARGUMENT_WITH_DEFAULT( luaL_optnumber, 4, 1, "duration" );
- lua_Color color = LUA_BINDING_ARGUMENT_WITH_DEFAULT( luaL_optcolor, 5, lua_Color( 255, 255, 255, 255 ), "color" );
+ lua_Color color = LUA_BINDING_ARGUMENT_WITH_DEFAULT( luaL_optcolor, 5, color_white, "color" );
bool noDepthTest = LUA_BINDING_ARGUMENT_WITH_DEFAULT( luaL_optboolean, 6, false, "noDepthTest" );
debugoverlay->AddTriangleOverlay( p1, p2, p3, color.r(), color.g(), color.b(), color.a(), noDepthTest, duration );
diff --git a/src/public/lColor.cpp b/src/public/lColor.cpp
index eed1f6fee4..9785e98d3a 100644
--- a/src/public/lColor.cpp
+++ b/src/public/lColor.cpp
@@ -33,10 +33,10 @@ LUALIB_API bool lua_iscolor( lua_State *L, int narg )
lua_getfield( L, -1, "__type" );
if ( lua_isstring( L, -1 ) && !strcmp( lua_tostring( L, -1 ), LUA_COLORMETANAME ) )
{
- lua_pop( L, 2 ); // Pop the string and the metatable
+ lua_pop( L, 2 ); // Pop the string and the metatable
return true;
}
- lua_pop( L, 2 ); // Pop the string and the metatable
+ lua_pop( L, 2 ); // Pop the string and the metatable
}
return false;
@@ -62,7 +62,7 @@ LUA_API void lua_pushcolor( lua_State *L, Color &clr )
LUALIB_API lua_Color &luaL_checkcolor( lua_State *L, int narg )
{
- if ( lua_isuserdata(L, narg) )
+ if ( lua_isuserdata( L, narg ) )
{
lua_Color *d = ( lua_Color * )luaL_checkudata( L, narg, LUA_COLORMETANAME );
return *d;
@@ -132,13 +132,13 @@ LUA_BINDING_BEGIN( Color, GetGreen, "class", "Gets the green value of the color.
LUA_BINDING_END( "integer", "The green value." )
// Experiment; Returns the pointer? Not useful in Lua. Disabled:
-//LUA_BINDING_BEGIN( Color, GetRawColor, "class", "Gets the raw color value." )
+// LUA_BINDING_BEGIN( Color, GetRawColor, "class", "Gets the raw color value." )
//{
// lua_Color color = LUA_BINDING_ARGUMENT( luaL_checkcolor, 1, "color" );
// lua_pushinteger( L, color.GetRawColor() );
// return 1;
//}
-//LUA_BINDING_END( "integer", "The raw color value." )
+// LUA_BINDING_END( "integer", "The raw color value." )
LUA_BINDING_BEGIN( Color, GetRed, "class", "Gets the red value of the color." )
{
@@ -235,13 +235,13 @@ LUA_BINDING_BEGIN( Color, __newindex, "class", "Metamethod for when the newindex
const char *field = LUA_BINDING_ARGUMENT( luaL_checkstring, 2, "field" );
if ( Q_strcmp( field, "r" ) == 0 || strcmp( field, "1" ) == 0 )
- color->SetColor( LUA_BINDING_ARGUMENT( luaL_checknumber, 3, "red" ), color->g(), color->b(), color->a() );
+ color->SetColor( luaL_checknumber( L, 3 ), color->g(), color->b(), color->a() );
else if ( Q_strcmp( field, "g" ) == 0 || strcmp( field, "2" ) == 0 )
- color->SetColor( color->r(), LUA_BINDING_ARGUMENT( luaL_checknumber, 3, "green" ), color->b(), color->a() );
+ color->SetColor( color->r(), luaL_checknumber( L, 3 ), color->b(), color->a() );
else if ( Q_strcmp( field, "b" ) == 0 || strcmp( field, "3" ) == 0 )
- color->SetColor( color->r(), color->g(), LUA_BINDING_ARGUMENT( luaL_checknumber, 3, "blue" ), color->a() );
+ color->SetColor( color->r(), color->g(), luaL_checknumber( L, 3 ), color->a() );
else if ( Q_strcmp( field, "a" ) == 0 || strcmp( field, "4" ) == 0 )
- color->SetColor( color->r(), color->g(), color->b(), LUA_BINDING_ARGUMENT( luaL_checknumber, 3, "alpha" ) );
+ color->SetColor( color->r(), color->g(), color->b(), luaL_checknumber( L, 3 ) );
else
{
luaL_error( L, "attempt to set a field in a read-only table" );
diff --git a/src/public/vgui/LISurface.cpp b/src/public/vgui/LISurface.cpp
index 60a4036ce6..f14b344780 100644
--- a/src/public/vgui/LISurface.cpp
+++ b/src/public/vgui/LISurface.cpp
@@ -261,7 +261,7 @@ LUA_BINDING_BEGIN( Surfaces, DrawPrintText, "library", "Prints text" )
surface()->DrawPrintText(
wbuf,
wcslen( wbuf ),
- LUA_BINDING_ARGUMENT_ENUM_WITH_DEFAULT( FontDrawType_t, 3, FONT_DRAW_DEFAULT, "drawType" ) );
+ LUA_BINDING_ARGUMENT_ENUM_WITH_DEFAULT( FontDrawType_t, 2, FONT_DRAW_DEFAULT, "drawType" ) );
}
return 0;
diff --git a/tools/docs-build-functions.js b/tools/docs-build-functions.js
index 569ca01f8a..b29ca1c32f 100644
--- a/tools/docs-build-functions.js
+++ b/tools/docs-build-functions.js
@@ -19,9 +19,9 @@ const filesToUpdate = getAllFilesInDirectoriesAsMap(`${outputDir}/libraries`, `$
const functionsThisRun = new Map();
const luaBindingBeginPattern = /^LUA_BINDING_BEGIN\(\s*(\w+)\s*,\s*(\w+)\s*,\s*"([^"]+)"\s*,\s*"([^"]+)"\s*(?:,\s*"([^"]+)")?\s*\)/;
-const luaBindingArgumentPattern = /LUA_BINDING_ARGUMENT(?:_WITH_EXTRA|_ENUM|_ENUM_DEFINE)?\(\s*(\w+)\s*,\s*(\d+)\s*,\s*(?:[^,]+,\s*)?"([^"]+)"\s*\)/;
-const luaBindingArgumentNillablePattern = /LUA_BINDING_ARGUMENT_NILLABLE\(\s*(\w+)\s*,\s*(\d+)\s*,\s*"([^"]+)"\s*\)/;
-const luaBindingArgumentWithDefaultPattern = /LUA_BINDING_ARGUMENT(?:_ENUM)?_WITH_DEFAULT\(\s*(\w+)\s*,\s*(\d+)\s*,\s*([^,]+)\s*,\s*"([^"]+)"\s*\)/;
+const luaBindingArgumentPattern = /LUA_BINDING_ARGUMENT(?:_WITH_EXTRA|_ENUM|_ENUM_DEFINE)?\(\s*([^\s]+)\s*,\s*(\d+)\s*,\s*(?:[^,\n]+,\s*)?"([^"]+)"\s*\)/g;
+const luaBindingArgumentNillablePattern = /LUA_BINDING_ARGUMENT_NILLABLE\(\s*(\w+)\s*,\s*(\d+)\s*,\s*"([^"]+)"\s*\)/g;
+const luaBindingArgumentWithDefaultPattern = /LUA_BINDING_ARGUMENT(?:_ENUM)?_WITH_DEFAULT\(\s*(\w+)\s*,\s*(\d+)\s*,\s*([^,\n]+)\s*,\s*"([^"]+)"\s*\)/g;
const luaBindingEndPattern = /^LUA_BINDING_END\((.*)\)$/m;
const luaBindingReturnPattern = /"([^"]+)", "([^"]+)"/g;
@@ -98,25 +98,48 @@ function writeFunctionToFile(func) {
let argumentSection = '';
const buildArguments = (args) => {
- return args.map(arg => {
- let defaults = '';
-
- if (arg.defaultValue) {
- defaults = `\n default: ${wrapQuotes(arg.defaultValue.trim())}`;
+ // Group the arguments by position
+ const groupedArgs = args.reduce((acc, arg) => {
+ if (!acc[arg.position]) {
+ acc[arg.position] = [];
}
- if (arg.isNillable) {
- defaults += '\n nillable: true';
+ acc[arg.position].push(arg);
+ return acc;
+ }, {});
+
+ // Build the yaml for each group
+ return Object.entries(groupedArgs).map(([position, args]) => {
+ let result = `- position: ${position}`;
+
+ if (args.length > 1) {
+ result += `\n types:`;
}
- return indentEachLine(`- name: ${wrapQuotes(arg.name.replace('.', '_').trim())}\n type: ${arg.type}${defaults}`, 2);
+ args.forEach(arg => {
+ let defaults = '';
+
+ if (arg.defaultValue) {
+ defaults = `\n default: ${wrapQuotes(arg.defaultValue.trim())}`;
+ }
+
+ if (arg.isNillable) {
+ defaults += `\n nillable: true`;
+ }
+
+ if (args.length > 1) {
+ result += `\n - name: ${wrapQuotes(arg.name.replace('.', '_').trim())}\n type: ${arg.type}${defaults}`;
+ } else {
+ result += `\n name: ${wrapQuotes(arg.name.replace('.', '_').trim())}\n type: ${arg.type}${defaults}`;
+ }
+ });
+
+ return result;
}).join('\n');
};
if (func.arguments) {
argumentSection = `arguments:\n${indentEachLine(buildArguments(func.arguments), 2)}`;
- } else if (func.argumentSets) {
- argumentSection = `argumentSets:\n${func.argumentSets.map(set => indentEachLine(`- arguments:\n${buildArguments(set.arguments)}`, 4)).join('\n')}`;
}
let returnSection = '';
@@ -247,15 +270,30 @@ function fromTypeChecker(typeChecker) {
case 'lua_toangle':
return 'Angle';
case 'luaL_checktrace':
+ case 'luaL_opttrace':
+ case 'lua_totrace':
return 'Trace';
case 'luaL_checkdamageinfo':
+ case 'lua_todamageinfo':
return 'DamageInfo';
case 'luaL_checkrecipientfilter':
return 'RecipientFilter';
case 'luaL_checkphysicsobject':
return 'PhysicsObject';
+ case 'luaL_checkphysicssurfaceprops':
+ case 'lua_tophysicssurfaceprops':
+ return 'PhysicsSurfacePropertiesHandle';
case 'lua_tofirebulletsinfo':
return 'FireBulletsInfo';
+ case 'luaL_checkmovehelper':
+ case 'lua_tomovehelper':
+ return 'MoveHelper';
+ case 'luaL_checkusercmd':
+ case 'lua_tousercmd':
+ return 'UserCommand';
+ case 'luaL_checknetchannel':
+ case 'lua_tonetchannel':
+ return 'NetChannelInfo';
case 'luaL_checkcolor':
case 'luaL_optcolor':
case 'lua_tocolor':
@@ -283,6 +321,17 @@ function fromTypeChecker(typeChecker) {
case 'luaL_optmovedata':
case 'lua_tomovedata':
return 'MoveData';
+ case 'luaL_checkconcommand':
+ case 'luaL_optconcommand':
+ case 'lua_toconcommand':
+ return 'ConsoleCommand';
+ case 'luaL_checkconvar':
+ case 'luaL_optconvar':
+ case 'lua_toconvar':
+ return 'ConsoleVariable';
+ case 'luaL_checksteamfriends':
+ case 'lua_tosteamfriends':
+ return 'SteamFriendsHandle';
case 'luaL_checkprojectedtexture':
case 'lua_toprojectedtexture':
return 'ProjectedTexture';
@@ -310,19 +359,59 @@ function fromTypeChecker(typeChecker) {
case 'lua_torecipientfilter':
return 'RecipientFilter';
case 'luaL_checkbf_read':
- case 'luaL_optbf_read':
case 'lua_tobf_read':
- return 'UserMessageReader';
+ return 'MessageReader';
+ case 'luaL_checkbf_write':
+ case 'lua_tobf_write':
+ return 'MessageWriter';
case 'lua_checktracestruct':
return 'Trace';
case 'luaL_checkfont':
case 'luaL_optfont':
case 'lua_tofont':
return 'FontHandle';
+ case 'luaL_checkaudiochannel':
+ case 'luaL_optaudiochannel':
+ case 'lua_toaudiochannel':
+ return 'AudioChannel';
+
+ // Panels
case 'luaL_checkpanel':
case 'luaL_optpanel':
case 'lua_topanel':
return 'Panel';
+ case 'luaL_checkbutton':
+ case 'luaL_optbutton':
+ case 'lua_tobutton':
+ return 'Button';
+ case 'luaL_checkcheckbutton':
+ case 'luaL_optcheckbutton':
+ case 'lua_tocheckbutton':
+ return 'CheckButton';
+ case 'luaL_checkeditablepanel':
+ case 'luaL_opteditablepanel':
+ case 'lua_toeditablepanel':
+ return 'EditablePanel';
+ case 'luaL_checkframe':
+ case 'luaL_optframe':
+ case 'lua_toframe':
+ return 'Frame';
+ case 'luaL_checkhtml':
+ case 'luaL_opthtml':
+ case 'lua_tohtml':
+ return 'Html';
+ case 'luaL_checklabel':
+ case 'luaL_optlabel':
+ case 'lua_tolabel':
+ return 'Label';
+ case 'luaL_checkmodelimagepanel':
+ case 'luaL_optmodelimagepanel':
+ case 'lua_tomodelimagepanel':
+ return 'ModelImagePanel';
+ case 'luaL_checktextentry':
+ case 'luaL_opttextentry':
+ case 'lua_totextentry':
+ return 'TextEntry';
// Enumerations:
case 'Activity':
@@ -332,6 +421,7 @@ function fromTypeChecker(typeChecker) {
return 'enumeration/ACTIVATION_TYPE';
case 'Alignment':
case 'vgui::Alignment':
+ case 'vgui::Label::Alignment':
return 'enumeration/PANEL_ALIGNMENT';
case 'AutoResize_e':
case 'Panel::AutoResize_e':
@@ -418,6 +508,12 @@ function fromTypeChecker(typeChecker) {
return 'enumeration/SURFACE';
case 'NETWORK_VARIABLE':
return 'enumeration/NETWORK_VARIABLE_TYPE';
+ case 'CHAT_MESSAGE_MODE':
+ return 'enumeration/CHAT_MESSAGE_MODE';
+ case 'STENCIL_OPERATION':
+ return 'enumeration/STENCIL_OPERATION';
+ case 'STENCIL_COMPARISON_FUNCTION':
+ return 'enumeration/STENCIL_COMPARISON_FUNCTION';
default:
return 'unknown';
@@ -447,15 +543,6 @@ function processBindingsInFile(file) {
const lines = fileContent.split('\n');
let currentFunction = null;
- let currentFunctionArgumentSets = [];
- let currentFunctionArgumentSet = null;
-
- const newFunctionArgumentSet = () => {
- currentFunctionArgumentSet = {
- arguments: [],
- };
- currentFunctionArgumentSets.push(currentFunctionArgumentSet);
- };
for (let i = 0; i < lines.length; i++) {
const line = lines[i];
@@ -468,116 +555,73 @@ function processBindingsInFile(file) {
concept: match[3],
description: match[4],
realm: match[5],
+ lines: '',
};
- } else if (currentFunction && (luaBindingArgumentPattern.test(line) || luaBindingArgumentNillablePattern.test(line))) {
- const isNillable = luaBindingArgumentNillablePattern.test(line);
- const match = isNillable ? line.match(luaBindingArgumentNillablePattern) : line.match(luaBindingArgumentPattern);
- const typeChecker = match[1];
- const position = parseInt(match[2]);
- const name = match[3];
-
- if (position == 1 && currentFunction.concept === 'class') {
- // Skip the first argument for classes, as it's always the class instance itself
- continue;
- }
-
- // Put the argument in the current argument set, or if that already
- // has a different type argument in the same position, create a new
- // argument set to indicate the function can be called with different
- // types in the same position.
- if (currentFunctionArgumentSet) {
- const existingArgument = currentFunctionArgumentSet.arguments.find(arg => arg.position === position);
- if (existingArgument && existingArgument.typeChecker !== typeChecker) {
- // Put this argument in a new set
- newFunctionArgumentSet();
- } else if (existingArgument) {
- // We've already pushed the argument set, so we don't need to do anything
- continue;
- }
- } else {
- newFunctionArgumentSet();
+ } else if (currentFunction && luaBindingEndPattern.test(line)) {
+ if (!currentFunction) {
+ throw new Error(`Found LUA_BINDING_END without a LUA_BINDING_BEGIN in ${file} at line ${i}`);
}
+ const match = line.match(luaBindingEndPattern);
- const type = fromTypeChecker(typeChecker);
-
- if (type === 'unknown')
- console.warn(`Unknown type checker ${typeChecker} in ${file}:${i}`);
+ currentFunction.returns = parseReturns(match[1]);
- currentFunctionArgumentSet.arguments.push({
- type: type,
- position,
- name,
- isNillable,
- });
- } else if (currentFunction && luaBindingArgumentWithDefaultPattern.test(line)) {
- const match = line.match(luaBindingArgumentWithDefaultPattern);
- const typeChecker = match[1];
- const position = parseInt(match[2]);
- const defaultValue = match[3];
- const name = match[4];
-
- if (position == 1 && currentFunction.concept === 'class') {
- // Skip the first argument for classes, as it's always the class instance itself
- continue;
+ // Some functions in shared files may specify the realm in the LUA_BINDING_BEGIN
+ if (!currentFunction.realm) {
+ currentFunction.realm = getRealmByFile(file);
}
- // Put the argument in the current argument set, or if that already
- // has a different type argument in the same position, create a new
- // argument set to indicate the function can be called with different
- // types in the same position.
- if (currentFunctionArgumentSet) {
- const existingArgument = currentFunctionArgumentSet.arguments.find(arg => arg.position === position);
- if (existingArgument && existingArgument.typeChecker !== typeChecker) {
- // Put this argument in a new set
- newFunctionArgumentSet();
- } else if (existingArgument) {
- // We've already pushed the argument set, so we don't need to do anything
- continue;
- }
- } else {
- newFunctionArgumentSet();
- }
+ // Use the regex to find the arguments in .lines. We use luaBindingArgumentPattern, luaBindingArgumentNillablePattern and luaBindingArgumentWithDefaultPattern
+ // to find the arguments
+ const arguments = [];
- const type = fromTypeChecker(typeChecker);
+ const fromTypeCheckerWithError = (typeChecker) => {
+ const type = fromTypeChecker(typeChecker);
- if (type === 'unknown')
- console.warn(`Unknown type checker ${typeChecker} in ${file}:${i}`);
+ if (type === 'unknown') {
+ console.warn(`Unknown type checker ${typeChecker} in function ${currentFunction.function} (${file}:${i})`);
+ }
- currentFunctionArgumentSet.arguments.push({
- type: type,
- position,
- name,
- defaultValue,
- });
- } else if (currentFunction && luaBindingEndPattern.test(line)) {
- if (!currentFunction) {
- throw new Error(`Found LUA_BINDING_END without a LUA_BINDING_BEGIN in ${file} at line ${i}`);
+ return type;
}
- const match = line.match(luaBindingEndPattern);
- // If there's only one set, push it to 'arguments'
- if (currentFunctionArgumentSets.length === 1) {
- currentFunction.arguments = currentFunctionArgumentSets[0].arguments;
+ let argumentMatch;
+ while ((argumentMatch = luaBindingArgumentPattern.exec(currentFunction.lines)) !== null) {
+ const type = fromTypeCheckerWithError(argumentMatch[1]);
+ arguments.push({
+ type,
+ position: parseInt(argumentMatch[2]),
+ name: argumentMatch[3],
+ });
}
- // If there are multiple sets, push them to 'argumentSets'
- if (currentFunctionArgumentSets.length > 1) {
- currentFunction.argumentSets = currentFunctionArgumentSets;
+ while ((argumentMatch = luaBindingArgumentNillablePattern.exec(currentFunction.lines)) !== null) {
+ const type = fromTypeCheckerWithError(argumentMatch[1]);
+ arguments.push({
+ type,
+ position: parseInt(argumentMatch[2]),
+ name: argumentMatch[3],
+ isNillable: true,
+ });
}
- currentFunction.returns = parseReturns(match[1]);
-
- // Some functions in shared files may specify the realm in the LUA_BINDING_BEGIN
- if (!currentFunction.realm) {
- currentFunction.realm = getRealmByFile(file);
+ while ((argumentMatch = luaBindingArgumentWithDefaultPattern.exec(currentFunction.lines)) !== null) {
+ const type = fromTypeCheckerWithError(argumentMatch[1]);
+ arguments.push({
+ type,
+ position: parseInt(argumentMatch[2]),
+ name: argumentMatch[4],
+ defaultValue: argumentMatch[3],
+ });
}
+ currentFunction.arguments = arguments;
+
writeFunctionToFile(currentFunction);
// Reset the function
currentFunction = null;
- currentFunctionArgumentSets = [];
- currentFunctionArgumentSet = null;
+ } else if (currentFunction) {
+ currentFunction.lines += line + '\n';
}
}
}
diff --git a/tools/docs-test-speedup-temp.js b/tools/docs-test-speedup-temp.js
new file mode 100644
index 0000000000..25dc6b7cfe
--- /dev/null
+++ b/tools/docs-test-speedup-temp.js
@@ -0,0 +1,58 @@
+/**
+ * Speed up the `mkdocs build` process for testing by moving all except the first 4 folders in ./docs/classes and ./docs/libraries/ to a temporary folder.
+ *
+ * This is useful for modifying and testing the templates.
+ */
+const fs = require('fs');
+const path = require('path');
+
+const quantityToKeep = 4;
+const docsDirectoriesToSpeedUp = ['classes', 'libraries'];
+const tempDir = 'temp';
+
+function speedup() {
+ for (const docsDir of docsDirectoriesToSpeedUp) {
+ const srcDir = path.join('docs', docsDir);
+ const outputDir = path.join(tempDir, docsDir);
+
+ fs.mkdirSync(outputDir, { recursive: true });
+
+ const files = fs.readdirSync(srcDir);
+
+ for (let i = 0; i < files.length; i++) {
+ const file = files[i];
+ const srcPath = path.join(srcDir, file);
+ let outputPath = path.join(outputDir, file);
+
+ if (i < quantityToKeep) {
+ continue;
+ }
+
+ fs.renameSync(srcPath, outputPath);
+ console.log(`Moving ${srcPath} to ${outputPath}`);
+ }
+ }
+}
+
+function restore() {
+ for (const docsDir of docsDirectoriesToSpeedUp) {
+ const srcDir = path.join(tempDir, docsDir);
+ const outputDir = path.join('docs', docsDir);
+
+ const files = fs.readdirSync(srcDir);
+
+ for (const file of files) {
+ const srcPath = path.join(srcDir, file);
+ let outputPath = path.join(outputDir, file);
+
+ fs.renameSync(srcPath, outputPath);
+ console.log(`Moving ${srcPath} back to ${outputPath}`);
+ }
+ }
+}
+
+if (process.argv[2] === 'restore') {
+ restore();
+} else {
+ speedup();
+}