This shows you the differences between two versions of the page.
Both sides previous revision Previous revision | |||
lua:cancelfunction [2014/12/27 07:15] vodur |
— (current) | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | ====== cancel ====== | ||
- | |||
- | Syntax 1: cancel() \\ | ||
- | Cancels any delayed functions linked to the game object invoking the cancel that have no tag set. | ||
- | |||
- | Syntax 2: cancel("<nowiki>*</nowiki>") \\ | ||
- | Cancels any and all delayed functions linked to the game object invoking the cancel. | ||
- | |||
- | Syntax 3: cancel(tag[string]) \\ | ||
- | Cancels any delayed functions linked to the game object invoking the cancel whose tag matches the tag argument. | ||
- | |||
- | Example1: | ||
- | |||
- | <code lua> | ||
- | function do_stuff() | ||
- | goto(31404) | ||
- | mdo("dance") | ||
- | goto(10204) | ||
- | end | ||
- | |||
- | delay(10, do_stuff) cancel() -- do_stuff will never run | ||
- | </code> | ||
- | |||
- | Example2: | ||
- | |||
- | <code lua> | ||
- | function do_stuff() | ||
- | goto(31404) | ||
- | mdo("dance") | ||
- | goto(10204) | ||
- | end | ||
- | |||
- | delay(10, do_stuff, "stuff") -- Give the delay a "stuff" tag so we can target it with cancel | ||
- | cancel("*") -- cancel all delays no matter what | ||
- | </code> | ||
- | |||
- | Example3: | ||
- | |||
- | <code lua> | ||
- | function do_stuff() | ||
- | goto(31404) | ||
- | mdo("dance") | ||
- | goto(10204) | ||
- | end | ||
- | |||
- | delay(10, do_stuff, "stuff") -- Give the delay a "stuff" tag so we can target it with cancel | ||
- | cancel("stuff") -- do_stuff will never run | ||
- | </code> | ||
- | |||
- | See [[:lua:delayfunction|delay]] | ||