Skip to content

Commit

Permalink
Finish documenting most things :)
Browse files Browse the repository at this point in the history
  • Loading branch information
luttje committed Aug 15, 2024
1 parent 0cdca7d commit e5dde61
Show file tree
Hide file tree
Showing 794 changed files with 21,014 additions and 4,118 deletions.
24 changes: 24 additions & 0 deletions docs/classes/Button/CanBeDefaultButton.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
template: lua-class-function.html
title: CanBeDefaultButton
icon: lua-client
tags:
- lua
- client
- needs-verification
- needs-example
lua:
library: Button
function: CanBeDefaultButton
realm: client
description: "Returns whether the button can be the default button"


returns:
- type: boolean
description: "Returns whether the button can be the default button"
---

<div class="lua__search__keywords">
Button:CanBeDefaultButton &#x2013; Returns whether the button can be the default button
</div>
23 changes: 23 additions & 0 deletions docs/classes/Button/DoClick.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
template: lua-class-function.html
title: DoClick
icon: lua-client
tags:
- lua
- client
- needs-verification
- needs-example
lua:
library: Button
function: DoClick
realm: client
description: "Simulates a click on the button"


returns:

---

<div class="lua__search__keywords">
Button:DoClick &#x2013; Simulates a click on the button
</div>
25 changes: 25 additions & 0 deletions docs/classes/Button/DrawFocusBox.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
template: lua-class-function.html
title: DrawFocusBox
icon: lua-client
tags:
- lua
- client
- needs-verification
- needs-example
lua:
library: Button
function: DrawFocusBox
realm: client
description: "Draws the focus box"

arguments:
- name: "shouldDraw"
type: boolean
returns:

---

<div class="lua__search__keywords">
Button:DrawFocusBox &#x2013; Draws the focus box
</div>
23 changes: 23 additions & 0 deletions docs/classes/Button/FireActionSignal.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
template: lua-class-function.html
title: FireActionSignal
icon: lua-client
tags:
- lua
- client
- needs-verification
- needs-example
lua:
library: Button
function: FireActionSignal
realm: client
description: "Fires the action signal"


returns:

---

<div class="lua__search__keywords">
Button:FireActionSignal &#x2013; Fires the action signal
</div>
25 changes: 25 additions & 0 deletions docs/classes/Button/ForceDepressed.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
template: lua-class-function.html
title: ForceDepressed
icon: lua-client
tags:
- lua
- client
- needs-verification
- needs-example
lua:
library: Button
function: ForceDepressed
realm: client
description: "Forces the button to be depressed"

arguments:
- name: "depressed"
type: boolean
returns:

---

<div class="lua__search__keywords">
Button:ForceDepressed &#x2013; Forces the button to be depressed
</div>
24 changes: 24 additions & 0 deletions docs/classes/Button/GetButtonBackgroundColor.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
template: lua-class-function.html
title: GetButtonBackgroundColor
icon: lua-client
tags:
- lua
- client
- needs-verification
- needs-example
lua:
library: Button
function: GetButtonBackgroundColor
realm: client
description: "Returns the button's background color"


returns:
- type: Color
description: "Returns the button's background color"
---

<div class="lua__search__keywords">
Button:GetButtonBackgroundColor &#x2013; Returns the button's background color
</div>
24 changes: 24 additions & 0 deletions docs/classes/Button/GetButtonForegroundColor.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
template: lua-class-function.html
title: GetButtonForegroundColor
icon: lua-client
tags:
- lua
- client
- needs-verification
- needs-example
lua:
library: Button
function: GetButtonForegroundColor
realm: client
description: "Returns the button's foreground color"


returns:
- type: Color
description: "Returns the button's foreground color"
---

<div class="lua__search__keywords">
Button:GetButtonForegroundColor &#x2013; Returns the button's foreground color
</div>
25 changes: 25 additions & 0 deletions docs/classes/Button/GetPanelBaseClassName.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
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"
---

<div class="lua__search__keywords">
_R.Button.GetPanelBaseClassName &#x2013; Gets the base class name of the panel
</div>
25 changes: 25 additions & 0 deletions docs/classes/Button/GetPanelClassName.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
template: lua-class-function.html
title: GetPanelClassName
icon: lua-client
tags:
- lua
- client
- needs-verification
- needs-example
lua:
library: Button
function: GetPanelClassName
realm: client
description: "Gets the class name of the panel"

static: true

returns:
- type: string
description: "The class name of the panel"
---

<div class="lua__search__keywords">
_R.Button.GetPanelClassName &#x2013; Gets the class name of the panel
</div>
24 changes: 24 additions & 0 deletions docs/classes/Button/IsArmed.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
template: lua-class-function.html
title: IsArmed
icon: lua-client
tags:
- lua
- client
- needs-verification
- needs-example
lua:
library: Button
function: IsArmed
realm: client
description: "Returns whether the button is armed"


returns:
- type: boolean
description: "Returns whether the button is armed"
---

<div class="lua__search__keywords">
Button:IsArmed &#x2013; Returns whether the button is armed
</div>
24 changes: 24 additions & 0 deletions docs/classes/Button/IsBlinking.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
template: lua-class-function.html
title: IsBlinking
icon: lua-client
tags:
- lua
- client
- needs-verification
- needs-example
lua:
library: Button
function: IsBlinking
realm: client
description: "Returns whether the button is blinking"


returns:
- type: boolean
description: "Returns whether the button is blinking"
---

<div class="lua__search__keywords">
Button:IsBlinking &#x2013; Returns whether the button is blinking
</div>
24 changes: 24 additions & 0 deletions docs/classes/Button/IsDepressed.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
template: lua-class-function.html
title: IsDepressed
icon: lua-client
tags:
- lua
- client
- needs-verification
- needs-example
lua:
library: Button
function: IsDepressed
realm: client
description: "Returns whether the button is depressed"


returns:
- type: boolean
description: "Returns whether the button is depressed"
---

<div class="lua__search__keywords">
Button:IsDepressed &#x2013; Returns whether the button is depressed
</div>
24 changes: 24 additions & 0 deletions docs/classes/Button/IsDrawingFocusBox.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
template: lua-class-function.html
title: IsDrawingFocusBox
icon: lua-client
tags:
- lua
- client
- needs-verification
- needs-example
lua:
library: Button
function: IsDrawingFocusBox
realm: client
description: "Returns whether the button is drawing the focus box"


returns:
- type: boolean
description: "Returns whether the button is drawing the focus box"
---

<div class="lua__search__keywords">
Button:IsDrawingFocusBox &#x2013; Returns whether the button is drawing the focus box
</div>
26 changes: 26 additions & 0 deletions docs/classes/Button/IsMouseClickEnabled.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
template: lua-class-function.html
title: IsMouseClickEnabled
icon: lua-client
tags:
- lua
- client
- needs-verification
- needs-example
lua:
library: Button
function: IsMouseClickEnabled
realm: client
description: "Returns whether mouse clicks are enabled"

arguments:
- name: "mouseCode"
type: enumeration/BUTTON
returns:
- type: boolean
description: "Returns whether mouse clicks are enabled"
---

<div class="lua__search__keywords">
Button:IsMouseClickEnabled &#x2013; Returns whether mouse clicks are enabled
</div>
24 changes: 24 additions & 0 deletions docs/classes/Button/IsSelected.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
template: lua-class-function.html
title: IsSelected
icon: lua-client
tags:
- lua
- client
- needs-verification
- needs-example
lua:
library: Button
function: IsSelected
realm: client
description: "Returns whether the button is selected"


returns:
- type: boolean
description: "Returns whether the button is selected"
---

<div class="lua__search__keywords">
Button:IsSelected &#x2013; Returns whether the button is selected
</div>
Loading

0 comments on commit e5dde61

Please sign in to comment.