Skip to content

Player interactions: ChatAPI

Mixer edited this page Oct 12, 2021 · 4 revisions

Mute player

Mute player using Player object

ChatAPI.mute(player)

API version: 1.0.0

  • Parameter:
  • player: Player object - LXL PlayerAPI's Player object
Example:
const api = require('./MixerAPI.js')

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

Mute player using GameTag or XUID

ChatAPI.muteByGametag(gameTag)

API version: 1.0.0

  • Parameter:
  • gameTag: String - Player's gametag or XUID
Example:
const api = require('./MixerAPI.js')

mc.regPlayerCmd('mute', 'Mute any player', function(player, args){
  let gameTag = args[0] //You can use XUID as well
  api.ChatAPI.muteByGametag(gameTag)
})

Unmute player

Unmute player using Player object

ChatAPI.unmuteByObject(player)

API version: 1.0.0

  • Parameter:
  • player: Player object - LXL PlayerAPI's Player object
Example:
const api = require('./MixerAPI.js')

mc.regPlayerCmd('unmute', 'Unmute any player', function(player, args){
  let gameTag = args[0] //You can use XUID as well
  let playerObject = mc.getPlayer(gameTag)
  api.ChatAPI.unmuteByObject(playerObject)
})

Unmute player using GameTag or XUID

ChatAPI.unmuteByGametag(player)

API version: 1.0.0

  • Parameter:
  • player: Player object - LXL PlayerAPI's Player object
Example:
const api = require('./MixerAPI.js')

mc.regPlayerCmd('unmute', 'Unmute any player', function(player, args){
  let gameTag = args[0] //You can use XUID as well
  api.ChatAPI.unmuteByGametag(gameTag)
})