Player API

Omegga.getPlayer(target) returns an OmeggaPlayer. The same methods are available as statics on the Player global when all you have is a uuid.

`OmeggaPlayer`

Property	Type	Description
`name`	`string`	player name
`displayName`	`string`	player display name
`id`	`string`	player uuid
`controller`	`string`	player controller id
`state`	`string`	player state id

`getOmegga`

getOmegga(): OmeggaLike

Returns omegga

`clone`

clone(): OmeggaPlayer

Clone a player

`raw`

raw(): [string, string, string, string, string]

Get raw player info (to feed into a constructor)

`isHost`

isHost(): boolean

True if the player is the host

`clearBricks`

clearBricks(quiet?: boolean): void

Clear player’s bricks

Param	Type	Description
`quiet`	`boolean`	clear bricks quietly

`getRoles`

getRoles(): readonly string[]

Get player’s roles, if any

`getPermissions`

getPermissions(): Record<string, boolean>

Get player’s permissions in a map like {"Bricks.ClearOwn": true, ...}

Returns permissions map

`getNameColor`

getNameColor(): string

Get player’s name color

Returns 6 character hex string

`getPawn`

getPawn(): Promise<string | null>

Get the player’s pawn; null when the player has no pawn

Returns pawn

`getPosition`

getPosition(): Promise<[number, number, number] | null>

Get player’s position; null when the player has no pawn

Returns [x, y, z] coordinates

`getGhostBrick`

getGhostBrick(): Promise< | { targetGrid: string; location: number[]; orientation: string; } | undefined >

Gets a user’s ghost brick info (by uuid, name, controller, or player object)

Returns ghost brick data

`getPaint`

getPaint(): Promise< | { materialIndex: string; materialAlpha: string; material: string; color: number[]; } | undefined >

gets a user’s paint tool properties

`isCrouched`

isCrouched(pawn?: string): Promise<boolean>

gets whether or not the player is crouching

`isDead`

isDead(pawn?: string): Promise<boolean>

gets whether or not the player is dead

`getTemplateBounds`

getTemplateBounds(): Promise<BrickBounds | undefined>

Gets the bounds of the template in the user’s clipboard (bounds of original selection box)

Returns template bounds

`getTemplateBoundsData`

getTemplateBoundsData(): Promise<ReadSaveObject | undefined>

Get bricks inside template bounds

Returns BRS JS Save Data

`loadDataAtGhostBrick`

loadDataAtGhostBrick(saveData: WriteSaveObject, options?: { rotate?: boolean; offX?: number; offY?: number; offZ?: number; quiet?: boolean; }): Promise<void>

Load bricks at ghost brick location

Param	Type	Description
`saveData`	`WriteSaveObject`	save data to load
`options`	`{ rotate?: boolean; offX?: number; offY?: number; offZ?: number; quiet?: boolean; }`

`loadBricks`

loadBricks(saveName: string): void

Load bricks on this player’s clipboard

Param	Type	Description
`saveName`	`string`	Save to load

`loadSaveData`

loadSaveData(saveData: WriteSaveObject, options?: { rotate?: boolean; offX?: number; offY?: number; offZ?: number; quiet?: boolean; }): Promise<void>

Load bricks on this player’s clipboard passing save data

Param	Type	Description
`saveData`	`WriteSaveObject`	save data to load
`options`	`{ rotate?: boolean; offX?: number; offY?: number; offZ?: number; quiet?: boolean; }`

`kill`

kill(): void

Kills this player

`damage`

damage(amount: number): void

Damages a player

Param	Type	Description
`amount`	`number`	Amount to damage

`heal`

heal(amount: number): void

Heal this player

Param	Type	Description
`amount`	`number`	to heal

`giveItem`

giveItem(item: WeaponClass): void

Gives a player an item

Param	Type	Description
`item`	`WeaponClass`	Item name (Weapon_Bow)

`takeItem`

takeItem(item: WeaponClass): void

Removes an item from a player’s inventory

Param	Type	Description
`item`	`WeaponClass`	Item name (Weapon_Bow)

`setTeam`

setTeam(teamIndex: number): void

Changes a player’s team

Param	Type	Description
`teamIndex`	`number`	Team index

`setMinigame`

setMinigame(index: number): void

Changes a player’s minigame

Param	Type	Description
`index`	`number`	Minigame index

`setScore`

setScore(minigameIndex: number, score: number): void

Changes a player’s score

Param	Type	Description
`minigameIndex`	`number`	minigame index
`score`	`number`	Score

`getScore`

getScore(minigameIndex: number): Promise<number>

Fetch a player’s score

Param	Type	Description
`minigameIndex`	`number`	minigame index

`setLeaderboard`

setLeaderboard(key: string, value: number): void

Set leaderboard value

Param	Type	Description
`key`	`string`	leaderboard key (Score, Kills, Deaths, CorrectGuesses)
`value`	`number`	leaderboard value

`getLeaderboard`

getLeaderboard(key: string): Promise<number | null>

Get leaderboard value

Param	Type	Description
`key`	`string`	leaderboard key (Score, Kills, Deaths, CorrectGuesses)

Returns leaderboard value

_{Declared in src/plugin.ts.}

`StaticPlayer`