Squirrel/Server/Functions/Messages/ClearMessages

Latest revision as of 11:00, 11 October 2010

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

[edit] Syntax

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

bool ClearMessages()

bool ClearMessages( Player plr )

[edit] Arguments

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

[edit] Example 1

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

This command will clear all GTA messages for all players.

[edit] Example 2

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

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

[edit] Notes

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

[edit] Related Functions

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