CreateCountTimer: Difference between revisions

From Onset Developer Wiki
No edit summary
No edit summary
Line 1: Line 1:
{{Info|Function|Server & Client|1.0}}
{{Info|Function|Server & Client|1.0}}


{{FuncDescription|__EDIT_ME__}}
{{FuncDescription|Creates a countdown timer.}}


{{FuncSyntax|CreateCountTimer(LuaFunction, Interval, Count [, UserArgs])}}
{{FuncSyntax|CreateCountTimer(LuaFunction, Interval, Count [, UserArgs])}}


{{FuncParameters}}
{{FuncParameters}}
{{FuncParam|LuaFunction|__EDIT_ME__}}
{{FuncParam|LuaFunction|The function to execute.}}
{{FuncParam|Interval|__EDIT_ME__}}
{{FuncParam|Interval|Interval to execute the function.}}
{{FuncParam|Count |__EDIT_ME__}}
{{FuncParam|Count|__EDIT_ME__}}
{{FuncParamOptional|UserArgs|__EDIT_ME__}}
{{FuncParamOptional|UserArgs|Arguments to pass to the function.}}


{{FuncReturnValue|__EDIT_ME__}}
{{FuncReturnValue|Returns the identifier to this timer. Use DestroyTimer to stop it.}}


== Example ==
== Example ==

Revision as of 15:08, 13 November 2019

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
    __EDIT_ME__
  • 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__