Squirrel/Server/Functions/Messages/BigMessage

Latest revision as of 14:09, 10 August 2013

This function sends a big GTA announcement message to a player or all the players in the game.

[edit] Syntax

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

bool BigMessage( string text, int time, int type )

bool BigMessage( Player plr, string text, int time, int type )

[edit] Arguments

• text - This is the message to send to players
• time - This is how long the message will stay on screen
• type - The type of the announcement message
• plr - The pointer to the player who should get the message

[edit] Example 1

 
function onPlayerCommand( player, cmd, text )
{
	if ( cmd == "bigmessage" )
	{
		if ( text ) BigMessage( text, 5000, 1 );
	}
}
 

This command will send a big message to all players for 5 seconds, with style 1 using the text specified.

[edit] Example 2

 
function onPlayerCommand( player, cmd, text )
{
	if ( cmd == "bigmessage2" )
	{
		if ( text ) BigMessage( player, text, 5000, 1 );
	}
}
 

This command will send a big message to the command user for 5 seconds, with style 1 using the text specified.

[edit] Notes

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

[edit] Notable

 BigMessage( player, "~w~ Welcome To The ~b~ Server.", 5000, 1 ); 

[edit] Related Functions

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