Squirrel/Server/Functions/Messages/ClearMessages

This function clears all the GTA messages currently on screen. This can be used for one player or for all players.

Syntax

ClearMessages can take 2 different lists of parameters. These are:

bool ClearMessages()

bool ClearMessages( Player plr )

Arguments

• plr - The pointer to the player whose messages should be cleared

Example 1

 
function onPlayerCommand( player, cmd, text )
{
	if ( cmd == "clearmsg" )
	{
		ClearMessages( );
	}
}
 

This command will clear all GTA messages for all players.

Example 2

 
function onPlayerCommand( player, cmd, text )
{
	if ( cmd == "clearmsg" )
	{
		ClearMessages( player );
	}
}
 

This command will clear all GTA messages for the command user.

Notes

The call onPlayerCommand was used in in this example. More info about this in the corresponding page.

Related Functions

• BigMessage
• ClearMessages
• Message
• MessageAllExcept
• MessagePlayer
• PagerMessage
• SendPlayerMessage
• SmallMessage