LogoAntiRaid

@antiraid-ext/lockdowns/lockdownset

API reference for @antiraid-ext/lockdowns/lockdownset

@antiraid-ext/lockdowns/lockdownset

Types

LockdownSet

Represents a list of lockdowns

Raw Type
--- Represents a list of lockdowns
type LockdownSet = {
	--- The current list of lockdowns
	lockdowns: {mode.Lockdown},

	--- Lockdown settings right now
	settings: settingsmanager.LockdownSettings,

	--- The current guild data
	guild_data: guilddata.GuildData,

	--- Applies a lockdown mode with a reason
	apply: (mode: mode.LockdownMode, reason: string) -> mode.Lockdown,

	--- Removes a lockdown by ID
	remove: (id: string) -> mode.Lockdown,

	--- Removes all lockdowns in order of specificity
	removeall: () -> (),

	--- Run the autofixer for a lockdown mode
	autofix: (mode: mode.LockdownMode) -> ()
}
PropTypeDescription
apply
(mode: mode.LockdownMode, reason: string) -> mode.Lockdown
Applies a lockdown mode with a reason
remove
Removes a lockdown by ID
removeall
() -> ()
Removes all lockdowns in order of specificity
autofix
(mode: mode.LockdownMode) -> ()
Run the autofixer for a lockdown mode
lockdowns
The current list of lockdowns
settings
Lockdown settings right now
guild_data
The current guild data

Functions

LockdownSet

Creates a new LockdownSet

Function Signature
--- Creates a new LockdownSet
function LockdownSet(ctx: Primitives.TemplateContext) -> LockdownSet end

Arguments

ctx

Primitives.TemplateContext

Returns

ret1

LockdownSet

Last updated on