IsPlayerMuted: Difference between revisions

Latest revision as of 22:42, 6 September 2024

Use this function to check if a player has been muted.

bool isPlayerMuted ( player thePlayer )

OOP Syntax Help! I don't understand this!

Method: player:isMuted(...)

Variable: .muted

Counterpart: setPlayerMuted

Returns true if the player is muted and false otherwise.

someguy = getPlayerFromName ( "someGuy" )
if isPlayerMuted ( someguy ) then
   outputChatBox ( "It seems Someguy can't speak." )
end

@@ Line 1: / Line 1: @@
 __NOTOC__
-==Description==
+{{Server function}}
-This function returns a true or false if a player has been muted.
+Use this function to check if a player has been muted.
 ==Syntax==
+  <syntaxhighlight lang="lua">bool isPlayerMuted ( player thePlayer )</syntaxhighlight>
-  bool [[isPlayerMuted]] ( [[player]] player )
+{{OOP||[[player]]:isMuted|muted|setPlayerMuted}}
 ===Required Arguments===
+*'''thePlayer:''' The [[player]] you are checking.
-*'''player''': The [[player]] you are checking.
+===Returns===
+Returns ''true'' if the player is muted and ''false'' otherwise.
 ==Example==
- if ( [[isPlayerMuted]] ( [[findPlayer]] ( "Someguy" ) ) then
+<syntaxhighlight lang="lua">
-    [[serverChat]] ( "It seems Someguy can't speak to you." )
+someguy = getPlayerFromName ( "someGuy" )
- end
+if isPlayerMuted ( someguy ) then
+    outputChatBox ( "It seems Someguy can't speak." )
+end
+</syntaxhighlight>
+==See Also==
+{{Player functions|server}}