Class Player

Hierarchy

Entity
- Player

Index

Methods

animation

animation(animationType: entityAnimationType): void
Parameters
- animationType: entityAnimationType
Returns void

Inherited from Entity.animation

camera

camera(): void
Returns void

Inherited from Entity.camera

killClient

killClient(deathMessage: Text | textInput): void
Parameters
- deathMessage: Text | textInput
Returns void

Inherited from Entity.killClient

observe

observe(observable: "position", callback: ((position: {
    pitch: number;
    x: number;
    y: number;
    yaw: number;
    z: number;
}) => void)): void
Parameters
- observable: "position"
- callback: ((position: {
      pitch: number;
      x: number;
      y: number;
      yaw: number;
      z: number;
  }) => void)
  - - (position: {
          pitch: number;
          x: number;
          y: number;
          yaw: number;
          z: number;
      }): void
    - Parameters
      
      position: {
          pitch: number;
          x: number;
          y: number;
          yaw: number;
          z: number;
      }
      
      pitch: number
      
      x: number
      
      y: number
      
      yaw: number
      
      z: number
      
      Returns void
Returns void

Inherited from Entity.observe

on

on(event: "leftClick", callback: (() => void)): void
Parameters
- event: "leftClick"
- callback: (() => void)
  - - (): void
    - Returns void
Returns void

Inherited from Entity.on
on(event: "rightClick", callback: ((clickInfo: {
    isMainHand: boolean;
    position: {
        x: number;
        y: number;
        z: number;
    };
}) => void)): void
Parameters
- event: "rightClick"
- callback: ((clickInfo: {
      isMainHand: boolean;
      position: {
          x: number;
          y: number;
          z: number;
      };
  }) => void)
  - - (clickInfo: {
          isMainHand: boolean;
          position: {
              x: number;
              y: number;
              z: number;
          };
      }): void
    - Parameters
      
      clickInfo: {
          isMainHand: boolean;
          position: {
              x: number;
              y: number;
              z: number;
          };
      }
      
      isMainHand: boolean
      
      position: {
          x: number;
          y: number;
          z: number;
      }
      
      x: number
      
      y: number
      
      z: number
      
      Returns void
Returns void

Inherited from Entity.on

once

once(event: "leftClick", callback: (() => void)): void
Parameters
- event: "leftClick"
- callback: (() => void)
  - - (): void
    - Returns void
Returns void

Inherited from Entity.once
once(event: "rightClick", callback: ((clickInfo: {
    isMainHand: boolean;
    position: {
        x: number;
        y: number;
        z: number;
    };
}) => void)): void
Parameters
- event: "rightClick"
- callback: ((clickInfo: {
      isMainHand: boolean;
      position: {
          x: number;
          y: number;
          z: number;
      };
  }) => void)
  - - (clickInfo: {
          isMainHand: boolean;
          position: {
              x: number;
              y: number;
              z: number;
          };
      }): void
    - Parameters
      
      clickInfo: {
          isMainHand: boolean;
          position: {
              x: number;
              y: number;
              z: number;
          };
      }
      
      isMainHand: boolean
      
      position: {
          x: number;
          y: number;
          z: number;
      }
      
      x: number
      
      y: number
      
      z: number
      
      Returns void
Returns void

Inherited from Entity.once

remove

remove(): void
Returns void

Inherited from Entity.remove

removeAllListeners

removeAllListeners(event?: "leftClick" | "rightClick"): void
Parameters
- Optional event: "leftClick" | "rightClick"
Returns void

Inherited from Entity.removeAllListeners

sound

sound(soundInfo: {
    channel: soundChannel;
    pitch: number;
    sound: soundName;
    volume: number;
}): void
Parameters
- soundInfo: {
      channel: soundChannel;
      pitch: number;
      sound: soundName;
      volume: number;
  }
  - channel: soundChannel
  - pitch: number
  - sound: soundName
  - volume: number
Returns void

Inherited from Entity.sound

Properties

`Readonly` client

client: Client

gamemode

gamemode: gamemode

`Readonly` id

id: number

`Readonly` living

living: boolean

name

name: string

position

position: {
    pitch: number;
    x: number;
    y: number;
    yaw: number;
    z: number;
}

Type declaration

pitch: number
x: number
y: number
yaw: number
z: number

`Readonly` server

server: Server

`Readonly` type

type: entityName

uuid

uuid: string

`Optional` `Readonly` tabItem

tabItem?: TabItem

Constructors

constructor

new Player(client: Client, type: entityName, id: number, position: {
    x: number;
    y: number;
    z: number;
    pitch?: number;
    yaw?: number;
}, sendPacket: ((packetName: string, packet: object) => void), extraInfo?: {
    gamemode?: gamemode;
    name?: string;
    tabItem?: TabItem;
    uuid?: string;
}, overwrites?: undefined, whenDone?: ((instance: Player) => void)): Player
Parameters
- client: Client
- type: entityName
- id: number
- position: {
      x: number;
      y: number;
      z: number;
      pitch?: number;
      yaw?: number;
  }
  - x: number
  - y: number
  - z: number
  - Optional pitch?: number
  - Optional yaw?: number
- sendPacket: ((packetName: string, packet: object) => void)
  - - (packetName: string, packet: object): void
    - Parameters
      
      packetName: string
      
      packet: object
      
      Returns void
- Optional extraInfo: {
      gamemode?: gamemode;
      name?: string;
      tabItem?: TabItem;
      uuid?: string;
  }
  - Optional gamemode?: gamemode
  - Optional name?: string
  - Optional tabItem?: TabItem
  - Optional uuid?: string
- Optional overwrites: undefined
- Optional whenDone: ((instance: Player) => void)
  - - (instance: Player): void
    - Parameters
      
      instance: Player
      
      Returns void
Returns Player

Overrides Entity.constructor

Class Player

Hierarchy

Index

Methods

Properties

Constructors

Methods

animation

Parameters

animationType: entityAnimationType

Returns void

camera

Returns void

killClient

Parameters

deathMessage: Text | textInput

Returns void

observe

Parameters

observable: "position"

callback: ((position: { pitch: number; x: number; y: number; yaw: number; z: number; }) => void)

Parameters

position: { pitch: number; x: number; y: number; yaw: number; z: number; }

pitch: number

x: number

y: number

yaw: number

z: number

Returns void

Returns void

on

Parameters

event: "leftClick"

callback: (() => void)

Returns void

Returns void

Parameters

event: "rightClick"

callback: ((clickInfo: { isMainHand: boolean; position: { x: number; y: number; z: number; }; }) => void)

Parameters

clickInfo: { isMainHand: boolean; position: { x: number; y: number; z: number; }; }

isMainHand: boolean

position: { x: number; y: number; z: number; }

x: number

y: number

z: number

Returns void

Returns void

once

Parameters

event: "leftClick"

callback: (() => void)

Returns void

Returns void

Parameters

event: "rightClick"

callback: ((clickInfo: { isMainHand: boolean; position: { x: number; y: number; z: number; }; }) => void)

Parameters

clickInfo: { isMainHand: boolean; position: { x: number; y: number; z: number; }; }

isMainHand: boolean

position: { x: number; y: number; z: number; }

x: number

y: number

z: number

Returns void

Returns void

remove

Returns void

removeAllListeners

Parameters

Optional event: "leftClick" | "rightClick"

Returns void

sound

Parameters

soundInfo: { channel: soundChannel; pitch: number; sound: soundName; volume: number; }

channel: soundChannel

pitch: number

sound: soundName

volume: number

Returns void

callback: ((position: {
pitch: number;
x: number;
y: number;
yaw: number;
z: number;
}) => void)

position: {
pitch: number;
x: number;
y: number;
yaw: number;
z: number;
}

callback: ((clickInfo: {
isMainHand: boolean;
position: {
x: number;
y: number;
z: number;
};
}) => void)

clickInfo: {
isMainHand: boolean;
position: {
x: number;
y: number;
z: number;
};
}

position: {
x: number;
y: number;
z: number;
}

callback: ((clickInfo: {
isMainHand: boolean;
position: {
x: number;
y: number;
z: number;
};
}) => void)

clickInfo: {
isMainHand: boolean;
position: {
x: number;
y: number;
z: number;
};
}

position: {
x: number;
y: number;
z: number;
}

`Optional` event: "leftClick" | "rightClick"

soundInfo: {
channel: soundChannel;
pitch: number;
sound: soundName;
volume: number;
}

`Readonly` client

`Readonly` id

`Readonly` living

`Readonly` server

`Readonly` type

`Optional` `Readonly` tabItem

position: {
x: number;
y: number;
z: number;
pitch?: number;
yaw?: number;
}

`Optional` pitch?: number

`Optional` yaw?: number

`Optional` extraInfo: {
gamemode?: gamemode;
name?: string;
tabItem?: TabItem;
uuid?: string;
}

`Optional` gamemode?: gamemode

`Optional` name?: string

`Optional` tabItem?: TabItem

`Optional` uuid?: string

`Optional` overwrites: undefined

`Optional` whenDone: ((instance: Player) => void)