Class Game

Class for handling user game event

Hierarchy

  • Game

Constructors

constructor

Properties

chat game

Accessors

NotFound created_at currentCard currentPlayerIsAuthor currentPositionId gameID isCurrentChatTurn isGameCreator players playersOrderIds state translatedStatus uid winner

Methods

_isPlayerTurn addUserToBannedList endGame getAllPlayerUserObject getCreatorUser getCurrentPlayerUserData getElapsedTime getNextPosition isPlayerGotBanned joinGame leaveGameForUser removeUserFromArray reversePlayersOrder sendToSpecificPlayerList setCreatorId setWinner startGame updateCardAndPosition updatePosition

Constructors

constructor

  • Game class constructor

    Parameters

    • gameData: {
          allPlayers: {}[];
          bannedPlayers: {}[];
          cards: {}[];
          playerOrders: {}[];
      } & {}

      Game document by specific user

    • chat: Chat

      Chat message instance

    Returns Game

Properties

Private chat

chat: Chat

Chat message instance

Private game

game: {
    allPlayers: {}[];
    bannedPlayers: {}[];
    cards: {}[];
    playerOrders: {}[];
} & {}

Game document by specific user

Type declaration

  • allPlayers: {}[]
  • bannedPlayers: {}[]
  • cards: {}[]
  • playerOrders: {}[]

Type declaration

    Accessors

    NotFound

    • get NotFound(): boolean

    • Get if this game is not found

      Returns boolean

    created_at

    • get created_at(): Date

    • Get this game a time when it's created

      Returns Date

    currentCard

    • get currentCard(): null | string

    • Get current card of this game

      Returns null | string

    currentPlayerIsAuthor

    • get currentPlayerIsAuthor(): boolean

    • Get if current player is an author of this game

      Returns boolean

    currentPositionId

    • get currentPositionId(): null | number

    • Get this game current position id

      Returns null | number

    gameID

    • get gameID(): string

    • Get this game session human readable id

      Returns string

    isCurrentChatTurn

    • get isCurrentChatTurn(): boolean

    • Get if current chatter is it turn to play

      Returns boolean

    isGameCreator

    • get isGameCreator(): boolean

    • Get if current chatter is game creator or not

      Returns boolean

    players

    playersOrderIds

    • get playersOrderIds(): number[]

    • Get list of all players order id

      Returns number[]

    state

    • get state(): {
          ENDED: boolean;
          PLAYING: boolean;
          WAITING: boolean;
      }

    • Get this game current state

      Returns {
          ENDED: boolean;
          PLAYING: boolean;
          WAITING: boolean;
      }

      • ENDED: boolean
      • PLAYING: boolean
      • WAITING: boolean

    translatedStatus

    • get translatedStatus(): "Menunggu Pemain" | "Sedang Bermain" | "Selesai Bermain" | "N/A"

    • Get this game human readable status

      Returns "Menunggu Pemain" | "Sedang Bermain" | "Selesai Bermain" | "N/A"

    uid

    winner

    • get winner(): null | number

    • Get this game winner player id if there is a winner

      Returns null | number

    Methods

    Private _isPlayerTurn

    • _isPlayerTurn(user): boolean

    • Abstract function that used for checking specific player is it turn or not

      Parameters

      • user: {}

        The specific player

        Returns boolean

        Boolean that indicate is player turn or not

      addUserToBannedList

      • Function for adding user on banned player array

        Parameters

        • id: number

          Specific user id

        Returns Promise<void>

      endGame

      • Function for end current game

        Returns Promise<void>

      getAllPlayerUserObject

      • Get all player user document

        Returns Promise<(null | {})[]>

      getCreatorUser

      • Get user document that created this game

        Returns Promise<null | {}>

      getCurrentPlayerUserData

      • Get current player user document

        Returns Promise<null | {}>

      getElapsedTime

      • Function for retrieve elapsed since game started and ended

        Returns string

        Human readable elapsed time

      getNextPosition

      • Function that will retrieve user next position

        Parameters

        • increment: number = 1

          What is N-Position next player (default 1)

        Returns undefined | {}

        User specific id document

      isPlayerGotBanned

      • Function for retrieve if given player was already banned

        Parameters

        • id: number

          Specific user id

        Returns boolean

        True or false boolean

      joinGame

      • Function for joining current game

        Returns Promise<void>

      leaveGameForUser

      • Function for updating user gameProperty for not joining game session anymore

        Parameters

        • id: number

          Specific user id

        Returns Promise<void>

      removeUserFromArray

      • Function for removing user from player array (leaving, get kicked)

        Parameters

        • id: number

          Specific user id

        Returns Promise<void>

      reversePlayersOrder

      • Function for reversing players order (uno reverse card)

        Returns Promise<void>

      sendToSpecificPlayerList

      • Send message or message with image caption to desired players list

        Parameters

        • message: MessageContent | MessageSendOptions

          Text that will sended

        • players: {}[]

          Desired player list

        • Optional image: MessageMedia

          Image that will send (optional)

        Returns Promise<void>

      setCreatorId

      • Function for set game creator

        Parameters

        • id: number

        Returns Promise<void>

      setWinner

      • Function for set game winner

        Parameters

        • id: number

        Returns Promise<void>

      startGame

      • Function for starting current game

        Returns Promise<void>

      updateCardAndPosition

      • Function for updating game current card and current position

        Parameters

        • card: allCard

          Valid given card

        • position: number

          User specific id

        Returns Promise<void>

      updatePosition

      • Function for updating game current position

        Parameters

        • position: number

          User specific id

        Returns Promise<void>

      Settings

      Member Visibility

      Theme

      On This Page

      Generated using TypeDoc