Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
www committed Nov 11, 2024
1 parent f7d9241 commit c799548
Showing 1 changed file with 16 additions and 16 deletions.
32 changes: 16 additions & 16 deletions docs/src/user/templating/2-plugins.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Utilities for asynchronous operations and timing
### sleep

```lua
function sleep(duration: f64) -> f64
function sleep(duration: f64): f64
```

Sleep for a given duration.
Expand Down Expand Up @@ -93,7 +93,7 @@ This plugin allows interoperability with AntiRaid and controlled interaction wit
### array_metatable

```lua
function array_metatable() -> table
function array_metatable(): table
```

Returns the array metatable.
Expand All @@ -105,7 +105,7 @@ Returns the array metatable.
### null

```lua
function null() -> null
function null(): null
```

Returns the null value.
Expand All @@ -117,7 +117,7 @@ Returns the null value.
### memusage

```lua
function memusage() -> f64
function memusage(): f64
```

Returns the current memory usage of the Lua VM.
Expand All @@ -129,7 +129,7 @@ Returns the current memory usage of the Lua VM.
### guild_id

```lua
function guild_id() -> string
function guild_id(): string
```

Returns the current guild ID of the Lua VM.
Expand All @@ -141,7 +141,7 @@ Returns the current guild ID of the Lua VM.
### gettemplatedata

```lua
function gettemplatedata(token: string) -> TemplateData?
function gettemplatedata(token: string): TemplateData?
```

Returns the data associated with a template token.
Expand All @@ -158,7 +158,7 @@ Returns the data associated with a template token.
### current_user

```lua
function current_user() -> serenity::model::user::User
function current_user(): serenity::model::user::User
```

Returns the current user of the Lua VM.
Expand Down Expand Up @@ -244,7 +244,7 @@ Captcha configuration. See examples for the arguments
### new

```lua
function new(config: CaptchaConfig) -> {u8}
function new(config: CaptchaConfig): {u8}
```

Creates a new CAPTCHA with the given configuration.
Expand Down Expand Up @@ -330,7 +330,7 @@ function KvExecutor:get(key: string)
### KvExecutor:getrecord

```lua
function KvExecutor:getrecord(key: string) -> KvRecord
function KvExecutor:getrecord(key: string): KvRecord
```

#### Parameters
Expand Down Expand Up @@ -369,7 +369,7 @@ function KvExecutor:delete(key: string)
### new

```lua
function new(token: string) -> KvExecutor
function new(token: string): KvExecutor
```

#### Parameters
Expand Down Expand Up @@ -473,7 +473,7 @@ Permission is the primitive permission type used by AntiRaid. See https://github
### permission_from_string

```lua
function permission_from_string(perm_string: string) -> Permission
function permission_from_string(perm_string: string): Permission
```

Returns a Permission object from a string.
Expand All @@ -490,7 +490,7 @@ Returns a Permission object from a string.
### permission_to_string

```lua
function permission_to_string(permission: Permission) -> string
function permission_to_string(permission: Permission): string
```

Returns a string from a Permission object.
Expand All @@ -507,7 +507,7 @@ Returns a string from a Permission object.
### has_perm

```lua
function has_perm(permissions: {Permission}, permission: Permission) -> boolean
function has_perm(permissions: {Permission}, permission: Permission): boolean
```

Checks if a list of permissions in Permission object form contains a specific permission.
Expand All @@ -525,7 +525,7 @@ Checks if a list of permissions in Permission object form contains a specific pe
### has_perm_str

```lua
function has_perm_str(permissions: {string}, permission: string) -> boolean
function has_perm_str(permissions: {string}, permission: string): boolean
```

Checks if a list of permissions in canonical string form contains a specific permission.
Expand All @@ -543,7 +543,7 @@ Checks if a list of permissions in canonical string form contains a specific per
### check_perms_single

```lua
function check_perms_single(check: PermissionCheck, member_native_perms: Permissions, member_kittycat_perms: {Permission}) -> LuaPermissionResult
function check_perms_single(check: PermissionCheck, member_native_perms: Permissions, member_kittycat_perms: {Permission}): LuaPermissionResult
```

Checks if a single permission check passes.
Expand All @@ -562,7 +562,7 @@ Checks if a single permission check passes.
### eval_checks

```lua
function eval_checks(checks: {PermissionCheck}, member_native_perms: Permissions, member_kittycat_perms: {Permission}) -> LuaPermissionResult
function eval_checks(checks: {PermissionCheck}, member_native_perms: Permissions, member_kittycat_perms: {Permission}): LuaPermissionResult
```

Evaluates a list of permission checks.
Expand Down

0 comments on commit c799548

Please sign in to comment.