Squirrel/Server/Functions/Messages/BigMessage
From Liberty Unleashed Wiki
(Difference between revisions)
(New page: __NOTOC__ This function sends a big GTA announcement message to a player or all the players in the game. == Syntax == ''BigMessage'' can take 2 different lists of parameters. These are: ...) |
|||
Line 16: | Line 16: | ||
* '''plr''' - The pointer to the player who should get the message | * '''plr''' - The pointer to the player who should get the message | ||
− | == Example == | + | == Example 1 == |
− | |||
<code lang="squirrel"> | <code lang="squirrel"> | ||
− | + | function onPlayerCommand( player, cmd, text ) | |
+ | { | ||
+ | if ( cmd == "bigmessage" ) | ||
+ | { | ||
+ | if ( text ) BigMessage( text, 5000, 1 ); | ||
+ | } | ||
+ | } | ||
</code> | </code> | ||
+ | |||
+ | This command will send a big message to all players for 5 seconds, with style 1 using the text specified. | ||
+ | |||
+ | == Example 2 == | ||
+ | |||
+ | <code lang="squirrel"> | ||
+ | function onPlayerCommand( player, cmd, text ) | ||
+ | { | ||
+ | if ( cmd == "bigmessage2" ) | ||
+ | { | ||
+ | if ( text ) BigMessage( player, text, 5000, 1 ); | ||
+ | } | ||
+ | } | ||
+ | </code> | ||
+ | |||
+ | This command will send a big message to the command user for 5 seconds, with style 1 using the text specified. | ||
=== Notes === | === Notes === | ||
− | + | The call [[Squirrel/Server/Events/Player/onPlayerCommand|onPlayerCommand]] was used in in this example. More info about this in the corresponding page. | |
== Related Functions == | == Related Functions == | ||
{{Squirrel/Server/Functions/Messages}} | {{Squirrel/Server/Functions/Messages}} |
Revision as of 01:44, 8 March 2010
This function sends a big GTA announcement message to a player or all the players in the game.
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 )
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
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.
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.
Notes
The call onPlayerCommand was used in in this example. More info about this in the corresponding page.