Class PlayerPermissions

constructor

• new PlayerPermissions(player: Entity): PlayerPermissions

  Parameters

  • player: Entity

  Returns PlayerPermissions

Readonlyplayer

admin

• get admin(): boolean

  The player's ability to have operator-level tags.

  Only applies when Main Menu > Security > Settings > Require admin tag for operator level tags is enabled.

  Returns boolean

  Warning

  This permission is not recommended for most players, as it will allow them to have tags that can be used to grief the server.

• set admin(value: boolean): void

  Parameters

  • value: boolean

  Returns void

canBypassProtectedAreas

• get canBypassProtectedAreas(): boolean

  The player's ability to bypass all forms of spawn protection.

  Returns boolean

  Warning

  This permission is not recommended for most players, as it will allow them to have tags that can be used to grief the server.

• set canBypassProtectedAreas(value: boolean): void

  Parameters

  • value: boolean

  Returns void

canUseChatCommands

• get canUseChatCommands(): boolean

  Gets the player's ability to use most of the operator-level custom commands in the add-on.

  Returns boolean

  Warning

  This permission is not recommended for most players, as it can be used to grief the server.

• set canUseChatCommands(value: boolean): void

  Sets the player's ability to use most of the operator-level custom commands in the add-on.

  Parameters

  • value: boolean

    A boolean indicating whether the player can use the operator-level custom commands. If true, the player will be granted the "canUseChatCommands" tag. If false, the "canUseChatCommands" tag will be removed from the player.

  Returns void

  Warning

  This permission is not recommended for most players, as it can be used to grief the server.

canUseCommands

• get canUseCommands(): boolean

  Gets the player's ability to run any vanilla command in the chat with the ${r} or ${run} escape sequence.

  Returns boolean

  True if the player has the "canUseCommands" tag, otherwise false.

  Warning

  This permission is not recommended for most players, as it can be used to grief the server.

• set canUseCommands(value: boolean): void

  Sets the player's ability to run any vanilla command in the chat with the ${r} or ${run} escape sequence.

  Parameters

  • value: boolean

    A boolean indicating whether the player can run commands in the chat with the ${r} or ${run} escape sequence. If true, the player is granted the "canUseCommands" tag. If false, the "canUseCommands" tag is removed from the player.

  Returns void

  Warning

  This permission is not recommended for most players, as it can be used to grief the server.

canUseDangerousCommands

• get canUseDangerousCommands(): boolean

  Gets the player's ability to use the more dangerous operator-level custom commands in the add-on, such as \chunkban.

  Returns boolean

  Warning

  This permission is not recommended for most players, as it can be used to grief the server.

• set canUseDangerousCommands(value: boolean): void

  Sets the player's ability to use most of the operator-level custom commands in the add-on.

  Parameters

  • value: boolean

    A boolean indicating whether the player can use the operator-level custom commands. If true, the player will be granted the "canUseDangerousCommands" tag. If false, the "canUseDangerousCommands" tag will be removed from the player.

  Returns void

  Warning

  This permission is not recommended for most players, as it can be used to grief the server.

canUseScriptEval

• get canUseScriptEval(): boolean

  Gets the player's ability to run arbitrary JavaScript code in the chat with the ${se} or ${scripteval} escape sequence.

  Returns boolean

  True if the player has the "canUseScriptEval" tag, otherwise false.

  Warning

  This permission is not recommended for most players, as it can be used to grief the server.

• set canUseScriptEval(value: boolean): void

  Sets the player's ability to run arbitrary JavaScript code in the chat with the ${se} or ${scripteval} escape sequence.

  Parameters

  • value: boolean

    A boolean indicating whether the player can run arbitrary JavaScript code in the chat with the ${se} or ${scripteval} escape sequence. If true, the player is granted the "canUseScriptEval" tag. If false, the "canUseScriptEval" tag is removed from the player.

  Returns void

  Warning

  This permission is not recommended for most players, as it can be used to grief the server.

getAllChatCommands

• get getAllChatCommands(): boolean

  The player's ability to see notifications when any player runs any custom command.

  Returns boolean
• set getAllChatCommands(value: boolean): void

  Parameters

  • value: boolean

  Returns void

permissionLevel

• get permissionLevel(): number
  Unused

  The player's permission level.

  The value is stored in the player's dynamic properties as permissionLevel.

  Returns number
• set permissionLevel(permissionLevel: number): void

  Parameters

  • permissionLevel: number

  Returns void

disableAllPermissions

• disableAllPermissions(): void

  Returns void

toJSON

• toJSON(): {
      admin: boolean;
      canBypassProtectedAreas: boolean;
      canUseChatCommands: boolean;
      canUseCommands: boolean;
      canUseDangerousCommands: boolean;
      canUseScriptEval: boolean;
      getAllChatCommands: boolean;
      permissionLevel: number;
  }

  Returns {
      admin: boolean;
      canBypassProtectedAreas: boolean;
      canUseChatCommands: boolean;
      canUseCommands: boolean;
      canUseDangerousCommands: boolean;
      canUseScriptEval: boolean;
      getAllChatCommands: boolean;
      permissionLevel: number;
  }