Class EntityTameMountComponent

Hierarchy (View Summary)

EntityComponent
- EntityTameMountComponent

Index

Constructors

Properties

entity isTamed isTamedToPlayer isValid tamedToPlayer? tamedToPlayerId? typeId

Methods

tame tameToPlayer

Constructors

`Private`constructor

new EntityTameMountComponent(): EntityTameMountComponent
Returns EntityTameMountComponent
Overrides EntityComponent.constructor

Properties

`Readonly`entity

entity: Entity

Throws

This property can throw errors.

InvalidEntityError

World Ready

This property can't be read in early-execution mode.

`Readonly`isTamed

isTamed: boolean

Throws

This property can throw errors.

World Ready

This property can't be read in early-execution mode.

`Readonly`isTamedToPlayer

isTamedToPlayer: boolean

Throws

This property can throw errors.

World Ready

This property can't be read in early-execution mode.

`Readonly`isValid

isValid: boolean

`Optional` `Readonly`tamedToPlayer

tamedToPlayer?: Player

Throws

This property can throw errors.

World Ready

This property can't be read in early-execution mode.

`Optional` `Readonly`tamedToPlayerId

tamedToPlayerId?: string

Throws

This property can throw errors.

World Ready

This property can't be read in early-execution mode.

`Readonly`typeId

typeId: string

Methods

tame

tame(showParticles: boolean): void
Parameters
- showParticles: boolean
Returns void
Remarks
Write Privilege
This function can't be called in read-only mode.

Throws
This function can throw errors.

World Ready
This function can't be called in early-execution mode.

tameToPlayer

tameToPlayer(showParticles: boolean, player: Player): boolean
Parameters
- showParticles: boolean
- player: Player
Returns boolean
Remarks
Write Privilege
This function can't be called in read-only mode.

Throws
This function can throw errors.

World Ready
This function can't be called in early-execution mode.