Squirrel/Server/Functions/Messages/PagerMessage

From Liberty Unleashed Wiki
(Difference between revisions)
Jump to: navigation, search
(Example)
 
Line 1: Line 1:
__NOTOC__
+
{{Squirrel/Title|PagerMessage}}
 
{{Squirrel/LUOnly}}
 
{{Squirrel/LUOnly}}
 
This function shows a GTA pager message to one player or all the players ingame.
 
This function shows a GTA pager message to one player or all the players ingame.

Latest revision as of 11:01, 11 October 2010

Home   |   Squirrel Scripting   |   Server Functions   |   Server Events   |   Client Functions   |   Client Events
LU This function works in Liberty Unleashed only.

This function shows a GTA pager message to one player or all the players ingame.

[edit] Syntax

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

  1. bool PagerMessage( string text, int speed, int something2, int sound )
  1. bool PagerMessage( Player plr, string text, int speed, int something2, int sound3 )

On the speed setting, the lower the number, the faster the message scrolls across, 140 is a good setting.

For sound, the options available are 0, 1 and 2.

[edit] Arguments

  • text - This is the message to be sent via the pager
  • speed - This is how quick the message is scrolled across.
  • something2 - Unknown
  • sound - This is what ring tone the pager plays.
  • plr - The pointer of the player the message is meant to

[edit] Example

  1.  
  2. function onPlayerCommand( pPlayer, szCommand, szText )
  3. {
  4. if ( szCommand == "pager" )
  5. {
  6. if ( szText ) PagerMessage( pPlayer, szText, 140, 1, 2 );
  7. }
  8. return 1;
  9. }
  10.  

[edit] Notes

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

[edit] Related Functions

Personal tools
Namespaces

Variants
Actions
Navigation
scripting
Toolbox