api.player

Members

`api.player.auras.get()`

api.player.auras.get(name: string, options?: AuraQueryOptions): Effect.Effect<LiveAura | null>

Name	Type	Required	Default	Description
`name`	`string`
`options`	`AuraQueryOptions`

Returns: LiveAura | null

Errors: never

`api.player.auras.getAll()`

api.player.auras.getAll(options?: AuraQueryOptions): Effect.Effect<readonly LiveAura[]>

Name	Type	Required	Default	Description
`options`	`AuraQueryOptions`

Returns: readonly LiveAura[]

Errors: never

`api.player.auras.has()`

api.player.auras.has(name: string, options?: AuraQueryOptions): Effect.Effect<boolean>

Name	Type	Required	Default	Description
`name`	`string`
`options`	`AuraQueryOptions`

Returns: boolean

Errors: never

`api.player.factions.get()`

api.player.factions.get(query: string | number): Effect.Effect<LiveFaction | null>

Name	Type	Required	Default	Description
`query`	`string` \| `number`

Returns: LiveFaction | null

Errors: never

`api.player.factions.getAll()`

api.player.factions.getAll(): Effect.Effect<readonly LiveFaction[]>

Returns: readonly LiveFaction[]

Errors: never

`api.player.get()`

api.player.get(): Effect.Effect<LivePlayer | null>

Returns: LivePlayer | null

Errors: never

`api.player.getCell()`

api.player.getCell(): Effect.Effect<string>

Returns: string

Errors: never

`api.player.getClassName()`

api.player.getClassName(): Effect.Effect<string>

Returns: string

Errors: never

`api.player.getClassRank()`

api.player.getClassRank(query?: ItemQuery): Effect.Effect<number | null>

Name	Type	Required	Default	Description
`query`	`ItemQuery`		`equipped inventory class`

Returns: number | null

Errors: never

`api.player.getGender()`

api.player.getGender(): Effect.Effect<string>

Returns: string

Errors: never

`api.player.getGold()`

api.player.getGold(): Effect.Effect<number>

Returns: number

Errors: never

`api.player.getHp()`

api.player.getHp(): Effect.Effect<number>

Returns: number

Errors: never

`api.player.getLevel()`

api.player.getLevel(): Effect.Effect<number>

Returns: number

Errors: never

`api.player.getMaxHp()`

api.player.getMaxHp(): Effect.Effect<number>

Returns: number

Errors: never

`api.player.getMaxMp()`

api.player.getMaxMp(): Effect.Effect<number>

Returns: number

Errors: never

`api.player.getMp()`

api.player.getMp(): Effect.Effect<number>

Returns: number

Errors: never

`api.player.getPad()`

api.player.getPad(): Effect.Effect<string>

Returns: string

Errors: never

`api.player.getPosition()`

api.player.getPosition(): Effect.Effect<Position>

Returns: Position

Errors: never

`api.player.getState()`

api.player.getState(): Effect.Effect<EntityState>

Returns: EntityState

Errors: never

`api.player.goToPlayer()`

api.player.goToPlayer(name: string): Effect.Effect<void>

Name	Type	Required	Default	Description
`name`	`string`

Returns: void

Errors: never

`api.player.hasActiveBoost()`

api.player.hasActiveBoost(boostType: BoostType): Effect.Effect<boolean>

Name	Type	Required	Default	Description
`boostType`	`BoostType`

Returns: boolean

Errors: never

`api.player.isAfk()`

api.player.isAfk(): Effect.Effect<boolean>

Returns: boolean

Errors: never

`api.player.isAlive()`

api.player.isAlive(): Effect.Effect<boolean>

Returns: boolean

Errors: never

`api.player.isMember()`

api.player.isMember(): Effect.Effect<boolean>

Returns: boolean

Errors: never

`api.player.isReady()`

Returns whether projections are complete and the account, map, and player are loaded. Use before actions that require a fully loaded player.

api.player.isReady(): Effect.Effect<boolean>

Returns: boolean

Errors: never

`api.player.joinMap()`

api.player.joinMap(target: string, options?: CellPositionOptions): Effect.Effect<boolean>

Name	Type	Required	Default	Description
`target`	`string`
`options`	`CellPositionOptions`

Returns: boolean

Errors: never

`api.player.jumpToCell()`

api.player.jumpToCell(cell: string, pad?: string): Effect.Effect<boolean>

Name	Type	Required	Default	Description
`cell`	`string`
`pad`	`string`

Returns: boolean

Errors: never

`api.player.outfits.equip()`

api.player.outfits.equip(name: string, keepColors?: boolean): Effect.Effect<boolean>

Name	Type	Required	Default	Description
`name`	`string`
`keepColors`	`boolean`		`false`	Whether to preserve the current colors.

Returns: boolean

Errors: never

`api.player.outfits.get()`

api.player.outfits.get(name: string): Effect.Effect<LiveOutfit | null>

Name	Type	Required	Default	Description
`name`	`string`

Returns: LiveOutfit | null

Errors: never

`api.player.outfits.getAll()`

api.player.outfits.getAll(): Effect.Effect<readonly LiveOutfit[]>

Returns: readonly LiveOutfit[]

Errors: never

`api.player.outfits.wear()`

api.player.outfits.wear(name: string, keepColors?: boolean): Effect.Effect<boolean>

Name	Type	Required	Default	Description
`name`	`string`
`keepColors`	`boolean`		`false`	Whether to preserve the current colors.

Returns: boolean

Errors: never

`api.player.rest()`

api.player.rest(options?: RestOptions): Effect.Effect<boolean>

Name	Type	Required	Default	Description
`options`	`RestOptions`		`{}`

Returns: boolean

Errors: never

`api.player.walkTo()`

api.player.walkTo(position: Position, options?: WalkToOptions): Effect.Effect<boolean>

Name	Type	Required	Default	Description
`position`	`Position`
`options`	`WalkToOptions`

Returns: boolean

Errors: never