Difference between revisions of "SetPlayerVoiceIgnoreFrom"

From Multi Theft Auto: Wiki
(Example)
 
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
{{Server function}}__NOTOC__  
 
{{Server function}}__NOTOC__  
{{Needs Example}}
 
 
 
This function allows you to mute voices for a player.
 
This function allows you to mute voices for a player.
 
{{Important Note|This function should only be used as a low-level function for advanced users.  For typical Voice scripting, please see the [[Resource:Voice|Voice Resource]]}}
 
{{Important Note|This function should only be used as a low-level function for advanced users.  For typical Voice scripting, please see the [[Resource:Voice|Voice Resource]]}}
Line 19: Line 17:
  
 
==Example==  
 
==Example==  
 +
By this example mute a player voice to yourself so you won't hear him
 +
( '''note:''' use setPlayerVoiceMuted function if you are using the voice resource more information at https://wiki.multitheftauto.com/wiki/Resource:Voice )
 
<section name="Server" class="server" show="true">
 
<section name="Server" class="server" show="true">
 
<syntaxhighlight lang="lua">
 
<syntaxhighlight lang="lua">
 +
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)
 
</syntaxhighlight>
 
</syntaxhighlight>
 
</section>
 
</section>

Latest revision as of 23:09, 28 October 2019

This function allows you to mute voices for a player.

[[{{{image}}}|link=]] Important Note: This function should only be used as a low-level function for advanced users. For typical Voice scripting, please see the Voice Resource

Syntax

bool setPlayerVoiceIgnoreFrom ( element thePlayer, mixed ignoreFrom )

OOP Syntax Help! I don't understand this!

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

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

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

Example

By this example mute a player voice to yourself so you won't hear him ( note: use setPlayerVoiceMuted function if you are using the voice resource more information at https://wiki.multitheftauto.com/wiki/Resource:Voice )

Click to collapse [-]
Server
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

BETA: FROM VERSION 1.5.7 r19626 ONWARDS
BETA: FROM VERSION 1.5.7 r19626 ONWARDS