setPlayerVoiceIgnoreFrom | Multi Theft Auto: Wiki Skip to content
Multi Theft Auto: Wiki

setPlayerVoiceIgnoreFrom

Client-side
Server-side
Shared

Manual Review Required

Please finish this page using the corresponding Old Wiki article. Go to Contribution guidelines for more information.

This function allows you to mute voices for a player.

Important

This function should only be used as a low-level function for advanced users. For typical Voice scripting, please see the Voice Resource

OOP Syntax Help! I don't understand this!

  • Method:player:setVoiceIgnoreFrom(...)
  • Variable: .voiceIgnoreFrom

Syntax 

bool setPlayerVoiceIgnoreFrom ( element thePlayer, mixed ignoreFrom )
Required Arguments
  • thePlayer: The player you wish to change
  • ignoreFrom: Element or table of elements which the player should not hear voices from. Use nil if no one should be ignored.

Returns

  • bool: value

Returns true if the value was set successfully, false otherwise.

Code Examples

shared 
function voiceMuteFunction( Muter , cmd , MutedName , mutual)
  if not MutedName then
    return outputChatBox("Syntax: /".. cmd .." <player name> <mutual>", Muter)
  end
  local Muted = getPlayerFromName(MutedName)
  if not Muted then
    return outputChatBox('enter the correct player name' , Muter)
  end
  if Muted == Muter then
    return outputChatBox("You cannot mute yourself!", Muter)
  end
  if mutual then --enter any string as the second arg for making this mute mutual or enter nothing to make it one-way
    setPlayerVoiceIgnoreFrom(Muter,Muted)
    setPlayerVoiceIgnoreFrom(Muted,Muter)
  else
    setPlayerVoiceIgnoreFrom(Muter,Muted)
  end
end
addCommandHandler('voiceMute' ,voiceMuteFunction )
-- e.g. /voiceMute jacky y  (mutual)
-- e.g. /voiceMute jacky  (one-way)

See Also

Player Functions
Player Events
Reference