Skip to content
On this page

Athena.systems.loginFlow

Interfaces

Functions

add

Usage

Athena.systems.loginFlow.add(name, weight, callback): boolean

Adds a flow option to the login flow.

Parameters

NameType
namestring
weightnumber
callback(player: Player) => void

Returns

boolean

Defined in

server/systems/loginFlow.ts:32


getFlow

Usage

Athena.systems.loginFlow.getFlow(player): Object

Return the flow that a player is currently utilizing.

Parameters

NameTypeDescription
playerPlayerAn alt:V Player Entity

Returns

Object

NameType
flowFlowInfo[]
indexnumber

Defined in

server/systems/loginFlow.ts:105


getWeightedFlow

Usage

Athena.systems.loginFlow.getWeightedFlow(): FlowInfo[]

Returns all currently registered flow information, their weight, name, and callbacks.

Returns

FlowInfo[]

Defined in

server/systems/loginFlow.ts:91


goToEnd

Usage

Athena.systems.loginFlow.goToEnd(player): void

Go straight to the final section of login flow. Which is a character select.

Export

Parameters

NameType
playerPlayer

Returns

void

Defined in

server/systems/loginFlow.ts:178


next

Usage

Athena.systems.loginFlow.next(player): any

Invokes the next flow for an individual player. If the array index exceeds the total amount of available registered flows. It will spawn the player.

Parameters

NameTypeDescription
playerPlayerAn alt:V Player Entity

Returns

any

Defined in

server/systems/loginFlow.ts:149


override

Usage

Athena.systems.loginFlow.override(functionName, callback): any

Used to override login flow functions.

Parameters

NameType
functionName"add"
callback(name: string, weight: number, callback: (player: Player) => void) => boolean

Returns

any

Defined in

server/systems/loginFlow.ts:200

Usage

Athena.systems.loginFlow.override(functionName, callback): any

Used to override login flow functions.

Parameters

NameType
functionName"remove"
callback(name: string) => boolean

Returns

any

Defined in

server/systems/loginFlow.ts:201

Usage

Athena.systems.loginFlow.override(functionName, callback): any

Used to override login flow functions.

Parameters

NameType
functionName"getWeightedFlow"
callback() => FlowInfo[]

Returns

any

Defined in

server/systems/loginFlow.ts:202

Usage

Athena.systems.loginFlow.override(functionName, callback): any

Used to override login flow functions.

Parameters

NameType
functionName"getFlow"
callback(player: Player) => { flow: FlowInfo[] ; index: number }

Returns

any

Defined in

server/systems/loginFlow.ts:203

Usage

Athena.systems.loginFlow.override(functionName, callback): any

Used to override login flow functions.

Parameters

NameType
functionName"register"
callback(player: Player) => any

Returns

any

Defined in

server/systems/loginFlow.ts:204

Usage

Athena.systems.loginFlow.override(functionName, callback): any

Used to override login flow functions.

Parameters

NameType
functionName"unregister"
callback(player: Player) => any

Returns

any

Defined in

server/systems/loginFlow.ts:205

Usage

Athena.systems.loginFlow.override(functionName, callback): any

Used to override login flow functions.

Parameters

NameType
functionName"next"
callback(player: Player) => any

Returns

any

Defined in

server/systems/loginFlow.ts:206


register

Usage

Athena.systems.loginFlow.register(player): any

Registers a player to start a login flow. Invokes the first callable function in the weighted flow.

Parameters

NameTypeDescription
playerPlayerAn alt:V Player Entity

Returns

any

Defined in

server/systems/loginFlow.ts:119


remove

Usage

Athena.systems.loginFlow.remove(name): boolean

Removes weighted flow info by name.

Parameters

NameType
namestring

Returns

boolean

Defined in

server/systems/loginFlow.ts:71


unregister

Usage

Athena.systems.loginFlow.unregister(player): any

Unregister player flow information.

Parameters

NameTypeDescription
playerPlayerAn alt:V Player Entity

Returns

any

Defined in

server/systems/loginFlow.ts:134

Created by Stuyk | Est. 2020