ReportAbuse

LocalUserSecurity

This member cannot be used in scripts, but is usable in the command bar.

Unsafe

For thread safety, this property is not safe to read in an unsynchronized thread.

Function of:

Description:

This function attempts to report the given Player|player for the given reason. Since this item is protected, attempting to use it in a Script or LocalScript will cause an error.

The game uses this function internally when a player interact’s with the game’s default report system. Players should use this system to report players for offensive or inappropriate behavior that does not abide by Roblox’s Terms of Service Agreement and Community Rules.

Parameters

Name	Type	Default	Description
Name player	Type Player	Default	Summary The `Player\|player` being reported
Name reason	Type string	Default	Summary The reason for reporting the player
Name optionalMessage	Type string	Default	Summary An optional message providing more details about the reported abuse

Returns

Return Type	Summary
Return Type void	Summary No return

Code Samples

Report Abuse Demo

This example demonstrates that the Players/ReportAbuse function executes without error if using the Command Bar or a Plugin and errors if executed in a Script or LocalScript.

When executed in the Command Bar, this code reports the recipient Player for the specified reason along with an optional explanatory message.

			
				Report Abuse Demo

				Expected Output
			
				Expand
				
			-- Command bar
game.Players:ReportAbuse(recipient, reason, "Player did a bad thing!") -- Submits a report against the recipient

-- LocalScript
local player = game.Players:ReportAbuse("Hello World", recipient) -- Errors
		
				Copy Code
			
				Light Theme

ReportAbuse

Parameters

player

reason

optionalMessage

Returns

void

Code Samples

Report Abuse Demo