skeldjs
    Preparing search index...

    Class Player<RoomType>

    Represents the player of a client connected to the room.

    See PlayerEvents for events to listen to.

    Type Parameters

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    characterControl: undefined | PlayerControl<RoomType>

    This player's player control component.

    clientId: number

    This player's server-unique client ID.

    friendCode: string = ""

    The player's innersloth friend code.

    inScene: boolean

    Whether or not this player is in the game scene.

    isReady: boolean

    Whether or not this player is readied up to start the game.

    platform: PlatformSpecificData = ...

    The platform that the player is playing on.

    playerLevel: number = 0

    The level/rank of the player.

    puid: string = ""

    The player's unique global UUID.

    The actual instance of this player's role manager, see PlayerInfo.roleType to know which role this is.

    room: RoomType

    The room that this player object belongs to.

    The message stream to be sent on fixed update.

    username: string

    The player's login name, not necessarily the display name, see PlayerInfo.

    Methods

    • Type Parameters

      • EventName extends
            | "component.spawn"
            | "component.despawn"
            | "player.checkcolor"
            | "player.checkmurder"
            | "player.checkname"
            | "player.checkprotect"
            | "player.completetask"
            | "player.die"
            | "player.usemovingplatform"
            | "player.murder"
            | "player.protect"
            | "player.removeprotection"
            | "player.reportbody"
            | "player.revertshapeshift"
            | "player.chat"
            | "player.quickchat"
            | "player.setcolor"
            | "player.sethat"
            | "player.setlevel"
            | "player.setname"
            | "player.setnameplate"
            | "player.setpet"
            | "player.setrole"
            | "player.setskin"
            | "player.setstartcounter"
            | "player.setvisor"
            | "player.shapeshift"
            | "player.startmeeting"
            | "player.syncsettings"
            | "player.entervent"
            | "player.exitvent"
            | "player.climbladder"
            | "player.move"
            | "player.snapto"
            | "player.ready"
            | "player.join"
            | "player.leave"
            | "player.setauthoritative"
            | "player.scenechange"
            | "player.spawn"

      Parameters

      Returns void

    • Type Parameters

      Parameters

      • event: string
      • listener: Listener<K>

      Returns void

    • Type Parameters

      • EventName extends
            | "component.spawn"
            | "component.despawn"
            | "player.checkcolor"
            | "player.checkmurder"
            | "player.checkname"
            | "player.checkprotect"
            | "player.completetask"
            | "player.die"
            | "player.usemovingplatform"
            | "player.murder"
            | "player.protect"
            | "player.removeprotection"
            | "player.reportbody"
            | "player.revertshapeshift"
            | "player.chat"
            | "player.quickchat"
            | "player.setcolor"
            | "player.sethat"
            | "player.setlevel"
            | "player.setname"
            | "player.setnameplate"
            | "player.setpet"
            | "player.setrole"
            | "player.setskin"
            | "player.setstartcounter"
            | "player.setvisor"
            | "player.shapeshift"
            | "player.startmeeting"
            | "player.syncsettings"
            | "player.entervent"
            | "player.exitvent"
            | "player.climbladder"
            | "player.move"
            | "player.snapto"
            | "player.ready"
            | "player.join"
            | "player.leave"
            | "player.setauthoritative"
            | "player.scenechange"
            | "player.spawn"

      Parameters

      Returns () => void

    • Type Parameters

      Parameters

      • event: string
      • listener: Listener<K>

      Returns () => void

    • Type Parameters

      • EventName extends
            | "component.spawn"
            | "component.despawn"
            | "player.checkcolor"
            | "player.checkmurder"
            | "player.checkname"
            | "player.checkprotect"
            | "player.completetask"
            | "player.die"
            | "player.usemovingplatform"
            | "player.murder"
            | "player.protect"
            | "player.removeprotection"
            | "player.reportbody"
            | "player.revertshapeshift"
            | "player.chat"
            | "player.quickchat"
            | "player.setcolor"
            | "player.sethat"
            | "player.setlevel"
            | "player.setname"
            | "player.setnameplate"
            | "player.setpet"
            | "player.setrole"
            | "player.setskin"
            | "player.setstartcounter"
            | "player.setvisor"
            | "player.shapeshift"
            | "player.startmeeting"
            | "player.syncsettings"
            | "player.entervent"
            | "player.exitvent"
            | "player.climbladder"
            | "player.move"
            | "player.snapto"
            | "player.ready"
            | "player.join"
            | "player.leave"
            | "player.setauthoritative"
            | "player.scenechange"
            | "player.spawn"

      Parameters

      Returns () => void

    • Type Parameters

      Parameters

      • event: string
      • listener: Listener<K>

      Returns () => void

    • Type Parameters

      • EventName extends
            | "component.spawn"
            | "component.despawn"
            | "player.checkcolor"
            | "player.checkmurder"
            | "player.checkname"
            | "player.checkprotect"
            | "player.completetask"
            | "player.die"
            | "player.usemovingplatform"
            | "player.murder"
            | "player.protect"
            | "player.removeprotection"
            | "player.reportbody"
            | "player.revertshapeshift"
            | "player.chat"
            | "player.quickchat"
            | "player.setcolor"
            | "player.sethat"
            | "player.setlevel"
            | "player.setname"
            | "player.setnameplate"
            | "player.setpet"
            | "player.setrole"
            | "player.setskin"
            | "player.setstartcounter"
            | "player.setvisor"
            | "player.shapeshift"
            | "player.startmeeting"
            | "player.syncsettings"
            | "player.entervent"
            | "player.exitvent"
            | "player.climbladder"
            | "player.move"
            | "player.snapto"
            | "player.ready"
            | "player.join"
            | "player.leave"
            | "player.setauthoritative"
            | "player.scenechange"
            | "player.spawn"

      Parameters

      Returns Promise<PlayerEvents<RoomType>[EventName]>

    • Parameters

      • event: string

      Returns Promise<BasicEvent>

    • Type Parameters

      • EventName extends
            | "component.spawn"
            | "component.despawn"
            | "player.checkcolor"
            | "player.checkmurder"
            | "player.checkname"
            | "player.checkprotect"
            | "player.completetask"
            | "player.die"
            | "player.usemovingplatform"
            | "player.murder"
            | "player.protect"
            | "player.removeprotection"
            | "player.reportbody"
            | "player.revertshapeshift"
            | "player.chat"
            | "player.quickchat"
            | "player.setcolor"
            | "player.sethat"
            | "player.setlevel"
            | "player.setname"
            | "player.setnameplate"
            | "player.setpet"
            | "player.setrole"
            | "player.setskin"
            | "player.setstartcounter"
            | "player.setvisor"
            | "player.shapeshift"
            | "player.startmeeting"
            | "player.syncsettings"
            | "player.entervent"
            | "player.exitvent"
            | "player.climbladder"
            | "player.move"
            | "player.snapto"
            | "player.ready"
            | "player.join"
            | "player.leave"
            | "player.setauthoritative"
            | "player.scenechange"
            | "player.spawn"

      Parameters

      Returns Promise<PlayerEvents<RoomType>[EventName]>

    • Type Parameters

      Parameters

      • event: string
      • filter: (ev: K) => boolean | Promise<boolean>

      Returns Promise<BasicEvent>