Squirrel/Client/Functions/Messages/PagerMessage

From Liberty Unleashed Wiki
(Difference between revisions)
Jump to: navigation, search
 
(One intermediate revision by one user not shown)
Line 1: Line 1:
 
{{Squirrel/Title|PagerMessage}}
 
{{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 the client.
  
 
== Syntax ==
 
== Syntax ==
Line 19: Line 19:
  
 
== Example ==
 
== Example ==
 +
<code lang="squirrel">
  
{{Squirrel/NeedsExample}}
+
function onClientCommand( szCommand, szText )
Explanation for the example
+
{
 +
if ( szCommand == "pager" )
 +
{
 +
if ( szText ) PagerMessage( pPlayer, szText, 140, 1, 2 );
 +
}
 +
 +
return 1;
 +
}
  
<code lang="squirrel">
 
-- Todo
 
 
</code>
 
</code>
  
 
=== Notes ===
 
=== Notes ===
  
-- List of used functions and other notes here.
+
The call [[Squirrel/Client/Events/Player/onClientCommand|onClientCommand]] was used in in this example. More info about this in the corresponding page.
  
 
== Related Functions ==
 
== Related Functions ==
  
 
{{Squirrel/Client/Functions/Messages}}
 
{{Squirrel/Client/Functions/Messages}}

Latest revision as of 11:57, 28 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 the client.

[edit] Syntax

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

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.

[edit] Example

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

[edit] Notes

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

[edit] Related Functions

Personal tools
Namespaces

Variants
Actions
Navigation
scripting
Toolbox