Options
All
  • Public
  • Public/Protected
  • All
Menu

Player class, handling all the Player actions.

Hierarchy

  • Player

Index

Constructors

constructor

  • new Player(x: number, y: number, angle: number, gameHUD: any, weapon?: Weapon, walkSpeed?: number): Player
  • Parameters

    • x: number

      Player postition on the x-axis

    • y: number

      Player postition on the y-axis

    • angle: number

      Starting angle/direction in radians

    • gameHUD: any
    • Optional weapon: Weapon

      What weapon we're holding

    • Optional walkSpeed: number

      Rate at which we're moving

    Returns Player

Properties

Private gameHUD

gameHUD: GameHUD

Private health

health: number

Private lastPaces

lastPaces: number

Tied to this.paces. Used to determine whether we've moved.

Private paces

paces: number

How far we've moved. This is used for the weapon bobbing animation.

Private playerInfo

playerInfo: PlayerInfo

Further meta informations about ourselves in the network context (what's our player name and id). Note that enemies have this information aswell.

Private position

position: Vec2D

Where we are on a 2d plane

Private screenWidth

screenWidth: number

Used for determining screen width in mouselook code

Private walkTimer

walkTimer: number

Timer for walking sounds.

Static Private Readonly DEATH_SOUND_VOLUME

DEATH_SOUND_VOLUME: 0.5 = 0.5

Volume of audio clip of when we're shot dead

Static Private Readonly DEFAULT_SCREEN_WIDTH

DEFAULT_SCREEN_WIDTH: 1920 = 1920

Static Readonly DEFAULT_WALK_SPEED

DEFAULT_WALK_SPEED: 2 = 2

How fast we're moving

Static Readonly MAX_HEALTH

MAX_HEALTH: 150 = 150

Maximum player life

Accessors

getDirection

  • get getDirection(): number

getPaces

  • get getPaces(): number

getPlayerInfo

getPosition

  • get getPosition(): Vec2D

getWalkSpeed

  • get getWalkSpeed(): number

getWeapon

isDead

  • get isDead(): boolean

setPlayerInfo

setPosition

  • set setPosition(p: Vec2D): void

Methods

Private die

  • die(): void

hasMoved

  • hasMoved(): boolean
  • Check if player has moved in last tick. Used to prevent weapon bob.

    Returns boolean

    True if player has moved.

rotate

  • rotate(angle: number): void
  • Rotates Player: Simulates head turning. Wraps infinitely.

    Parameters

    • angle: number

      Delta angle by how much the player rotates.

    Returns void

setDead

  • setDead(dead: boolean): void

setScreenWidth

  • setScreenWidth(width: number): void

update

  • update(controls: Controls, map: Map2D, seconds: number, sendCallback: any): void
  • Handles all the movement actions of the Player and communicates to the server and plays sounds as needed.

    Parameters

    • controls: Controls

      Controls interface between user and player.

    • map: Map2D

      {@link Map} that the player is in.

    • seconds: number

      Seconds that have passed.

    • sendCallback: any

    Returns void

walk

  • walk(distance: number, map: Map2D, direction: number): void
  • The Player walks distance on WorldMap

    Parameters

    • distance: number

      how far the player walks

    • map: Map2D

      {@link Map}

    • direction: number

      which direction to walk

    Returns void

Generated using TypeDoc