SetPlayerMuted: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
m (Removed useless note, added info about the core purpose of this function) |
||
(4 intermediate revisions by 4 users not shown) | |||
Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
{{Server function}} | {{Server function}} | ||
Use this function to mute or unmute the player. | Use this function to mute or unmute the player. Muted player won't be able to say anything in chat. | ||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua">bool setPlayerMuted ( player thePlayer, bool state )</syntaxhighlight> | <syntaxhighlight lang="lua">bool setPlayerMuted ( player thePlayer, bool state )</syntaxhighlight> | ||
{{OOP||[[player]]:setMuted|muted|isPlayerMuted}} | |||
===Required Arguments=== | ===Required Arguments=== | ||
*'''thePlayer:''' The [[player]] you are muting or unmuting. | *'''thePlayer:''' The [[player]] you are muting or unmuting. | ||
Line 21: | Line 21: | ||
if victimName then | if victimName then | ||
-- get the victim player element from their name | -- get the victim player element from their name | ||
local victim = | local victim = getPlayerFromName(victimName) | ||
-- if the player exists | -- if the player exists | ||
if victim then | if victim then |
Latest revision as of 15:19, 24 June 2023
Use this function to mute or unmute the player. Muted player won't be able to say anything in chat.
Syntax
bool setPlayerMuted ( player thePlayer, bool state )
OOP Syntax Help! I don't understand this!
- Method: player:setMuted(...)
- Variable: .muted
- Counterpart: isPlayerMuted
Required Arguments
- thePlayer: The player you are muting or unmuting.
- state: Use true to mute and false to unmute the player.
Returns
Returns true if the player was successfully muted or unmuted, false otherwise.
Example
This adds a /mute command that can be used to mute a player.
-- create the function function mutePlayer(player,command,victimName) -- if the player has specified a victim name to mute if victimName then -- get the victim player element from their name local victim = getPlayerFromName(victimName) -- if the player exists if victim then -- if they arent already muted if ( not isPlayerMuted(victim) ) then -- mute them and output a message to the chat setPlayerMuted(victim, true) outputChatBox("You have been muted.",victim) end else outputChatBox("Could not find player with name: "..tostring(victimName),player) end else outputChatBox("Usage: /mute <player name>",player) end end -- add the /mute command addCommandHandler("mute",mutePlayer)
See Also
- forcePlayerMap
- getAlivePlayers
- getDeadPlayers
- getPlayerACInfo
- getPlayerAnnounceValue
- getPlayerBlurLevel
- getPlayerCount
- getPlayerFromName
- getPlayerIdleTime
- getPlayerIP
- getPlayerMoney
- getPlayerName
- getPlayerNametagColor
- getPlayerNametagText
- getPlayerPing
- getPlayerScriptDebugLevel
- getPlayerSerial
- getPlayerTeam
- getPlayerVersion
- getPlayerWantedLevel
- getRandomPlayer
- givePlayerMoney
- isPlayerMapForced
- isPlayerMuted
- isPlayerNametagShowing
- isVoiceEnabled
- redirectPlayer
- resendPlayerACInfo
- resendPlayerModInfo
- setPlayerAnnounceValue
- setPlayerBlurLevel
- setPlayerHudComponentVisible
- setPlayerMoney
- setPlayerMuted
- setPlayerName
- setPlayerNametagColor
- setPlayerNametagShowing
- setPlayerNametagText
- setPlayerScriptDebugLevel
- setPlayerTeam
- setPlayerVoiceBroadcastTo
- setPlayerVoiceIgnoreFrom
- setPlayerWantedLevel
- spawnPlayer
- takePlayerMoney
- takePlayerScreenShot