Server management: BanAPI

Ban player

Ban player using Player object

BanAPI.banByObject(player, [reason])

API version: 1.0.0

• Parameter:

• player: Player object - LXL PlayerAPI's Player object
• reason: String - Reason of ban, optional

Example:

const api = require('./MixerAPI.js')

mc.regPlayerCmd('ban', 'Ban any player', function(player, args){
  let gameTag = args[0] //You can use XUID as well
  let reason = args[1] //Optional, if == null, won't display ban reason for banned player
  let playerObject = mc.getPlayer(gameTag)
  api.BanAPI.banByObject(playerObject, reason)
})

---

Ban player using GameTag or XUID

BanAPI.banByGametag(gameTag, [reason])

API version: 1.0.0

• Parameter:

• gameTag: String - Player's gametag or XUID
• reason: String - Reason of ban, optional

Example:

const api = require('./MixerAPI.js')

mc.regPlayerCmd('ban', 'Ban any player', function(player, args){
  let gameTag = args[0] //You can use XUID as well
  let reason = args[1] //Optional, if == null, won't display ban reason for banned player
  api.BanAPI.banByGametag(gameTag, [reason])
})

---

Unban player

Unban player using Player object

BanAPI.unbanByObject(player)

API version: 1.0.0

• Parameter:

• player: Player object - LXL PlayerAPI's Player object

Example:

const api = require('./MixerAPI.js')

mc.regPlayerCmd('unban', 'Unban any player', function(player, args){
  let gameTag = args[0] //You can use XUID as well
  let playerObject = mc.getPlayer(gameTag)
  api.BanAPI.unbanByObject(playerObject)
})

---

Unban player using GameTag or XUID

BanAPI.unbanByGametag(gameTag)

API version: 1.0.0

• Parameter:

• gameTag: String - Player's gametag or XUID

Example:

const api = require('./MixerAPI.js')

mc.regPlayerCmd('unban', 'Unban any player', function(player, args){
  let gameTag = args[0] //You can use XUID as well
  api.BanAPI.unbanByGametag(gameTag)
})