CreateCountTimer: Difference between revisions

From Onset Developer Wiki
No edit summary
No edit summary
Line 8: Line 8:
{{FuncParam|LuaFunction|The function to execute.}}
{{FuncParam|LuaFunction|The function to execute.}}
{{FuncParam|Interval|Interval to execute the function.}}
{{FuncParam|Interval|Interval to execute the function.}}
{{FuncParam|Count|__EDIT_ME__}}
{{FuncParam|Count|How often to execute this timer. Use [[CreateTimer]] for a non-stop version.}}
{{FuncParamOptional|UserArgs|Arguments to pass to the function.}}
{{FuncParamOptional|UserArgs|Arguments to pass to the function.}}



Revision as of 14:48, 8 July 2020

CreateCountTimer

Type: Function
Context: Server & Client
Introduced: v1.0

Description

Creates a countdown timer.

Syntax

CreateCountTimer(LuaFunction, Interval, Count [, UserArgs])

Parameters

  • LuaFunction
    The function to execute.
  • Interval
    Interval to execute the function.
  • Count
    How often to execute this timer. Use CreateTimer for a non-stop version.
  • UserArgs (optional)
    Arguments to pass to the function.

Return Value

  • Returns the identifier to this timer. Use DestroyTimer to stop it.

Example

__EDIT_ME__

See also

__EDIT_ME__