SmallMessage

From Liberty Unleashed Wiki
Jump to: navigation, search
Home   |   Squirrel Scripting   |   Server Functions   |   Server Events   |   Client Functions   |   Client Events

This function sends a small GTA style text to a player or all the players in the game.

Syntax

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

  1. bool SmallMessage( string text, int time, int type )
  1. bool SmallMessage( 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

  1.  
  2. function onPlayerCommand( player, cmd, text )
  3. {
  4. if ( cmd == "smallmsg" )
  5. {
  6. if ( text ) SmallMessage( text, 5000, 1 );
  7. }
  8. }
  9.  

This command will show a small message, with type 0, lasting 5 seconds, showing the specified text, for all players.

Example 2

  1.  
  2. function onPlayerCommand( player, cmd, text )
  3. {
  4. if ( cmd == "smallmsg" )
  5. {
  6. if ( text ) SmallMessage( player, text, 5000, 1 );
  7. }
  8. }
  9.  

This command will show a small message, with type 0, lasting 5 seconds, showing the specified text, for the command user.

Notes

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

Related Functions

Personal tools
Namespaces

Variants
Actions
Navigation
scripting
Toolbox