Squirrel/Functions/Timers/NewTimer

From Liberty Unleashed Wiki
(Difference between revisions)
Jump to: navigation, search
(Example)
(Notes)
Line 14: Line 14:
  
 
== Example1 ==
 
== Example1 ==
 +
 +
This will start a timer saying ''BOO!'' 3 times every 5 seconds when a player joins
 +
 +
<code lang="squirrel">
 +
function onPlayerJoin( player )
 +
{
 +
    NewTimer( "MessagePlayer", 5000, 3, "BOO!", player );
 +
}
 +
</code>
 +
 +
== Example2 ==
  
 
This will start a timer saying ''BOO!'' 3 times every 5 seconds when a player joins
 
This will start a timer saying ''BOO!'' 3 times every 5 seconds when a player joins

Revision as of 14:13, 10 August 2013

Home   |   Squirrel Scripting   |   Server Functions   |   Server Events   |   Client Functions   |   Client Events

This function creates a new timer.

Syntax

  1. Timer NewTimer( string function, int interval, int repeat, args... )

Arguments

  • function - This is the function the timer will call
  • interval - The interval the timer will fire at in milliseconds
  • repeat - How many times the function will repeat (0 is infinate)
  • args - Any arguments you want to pass to the function when called

Example1

This will start a timer saying BOO! 3 times every 5 seconds when a player joins

  1.  
  2. function onPlayerJoin( player )
  3. {
  4. NewTimer( "MessagePlayer", 5000, 3, "BOO!", player );
  5. }
  6.  

Example2

This will start a timer saying BOO! 3 times every 5 seconds when a player joins

  1.  
  2. function onPlayerJoin( player )
  3. {
  4. NewTimer( "MessagePlayer", 5000, 3, "BOO!", player );
  5. }
  6.  

Notes

The function MessagePlayer and call onPlayerJoin were used in in this example. More info about them in corresponding pages.

Related Functions

Personal tools
Namespaces

Variants
Actions
Navigation
scripting
Toolbox