Skip to content

_Framework.ScrollComponent.Task (runtime)

Live 11 — Live Object Model & framework reference (descriptions and signatures).

Module constants

  • KILLED = 0
  • PAUSED = 2
  • RUNNING = 1

Functions

const(value)

depends(**dependencies)

find_if(predicate, seq)

generator(orig)

invfade(f, *a, **k)

linear(f, min, max, *a, **k)

linear_fn(minv, maxv, val)

loop(*tasks)

nop(*a, **k)

old_div(a, b)

parallel(*tasks)

remove_if(predicate, lst)

repeat(task)

run(func, *a, **k)

sequence(*tasks)

sinusoid(f, min=0.0, max=1.0, *a, **k)

totask(task)

Classes

class DelayTask(Task)

Properties

  • is_killed
  • is_paused
  • is_running
  • parent_task
  • state

Methods

__init__(self, duration=None, *a, **k)

Initialize self. See help(type(self)) for accurate signature.

_set_parent(self, manager)
_task_equivalent(self, other)
add_next(self, task)
clear(self)
do_restart(self)
do_update(self, delta)
kill(self)
pause(self)
restart(self)
resume(self)
toggle_pause(self)
update(self, timer)

Attributes

  • duration = 1 - int([x]) -> integer

class FadeTask(Task)

Properties

  • is_killed
  • is_paused
  • is_running
  • parent_task
  • state

Methods

__init__(self, func=<function FadeTask.<lambda> at 0x162c881e0>, duration=1.0, loop=False, init=False, *a, **k)

Initialize self. See help(type(self)) for accurate signature.

_set_parent(self, manager)
_task_equivalent(self, other)
add_next(self, task)
clear(self)
do_restart(self)
do_update(self, delta)
kill(self)
pause(self)
restart(self)
resume(self)
toggle_pause(self)
update(self, timer)

class FuncTask(Task)

Properties

  • func
  • is_killed
  • is_paused
  • is_running
  • parent_task
  • state

Methods

__init__(self, func=None, equivalent=None, *a, **k)

Initialize self. See help(type(self)) for accurate signature.

_get_func(self)
_set_func(self, func)
_set_parent(self, manager)
_task_equivalent(self, other)
add_next(self, task)
clear(self)
do_restart(self)
do_update(self, timer)
kill(self)
pause(self)
restart(self)
resume(self)
toggle_pause(self)
update(self, timer)

class GeneratorTask(Task)

Properties

  • generator
  • is_killed
  • is_paused
  • is_running
  • parent_task
  • state

Methods

Param()
__init__(self, generator=None, equivalent=None, *a, **k)

Initialize self. See help(type(self)) for accurate signature.

_get_generator(self)
_set_generator(self, generator)
_set_parent(self, manager)
_task_equivalent(self, other)
add_next(self, task)
clear(self)
do_restart(self)
do_update(self, delta)
kill(self)
pause(self)
restart(self)
resume(self)
toggle_pause(self)
update(self, timer)

class SequenceTask(Task)

Properties

  • is_killed
  • is_paused
  • is_running
  • parent_task
  • state

Methods

__init__(self, tasks=[], *a, **k)

Initialize self. See help(type(self)) for accurate signature.

_advance_sequence(self)
_set_parent(self, manager)
_task_equivalent(self, other)
add_next(self, task)
clear(self)
do_restart(self)
do_update(self, delta)
kill(self)
pause(self)
restart(self)
resume(self)
toggle_pause(self)
update(self, timer)

class Task

Properties

  • is_killed
  • is_paused
  • is_running
  • parent_task
  • state

Methods

__init__(self, *a, **k)

Initialize self. See help(type(self)) for accurate signature.

_set_parent(self, manager)
_task_equivalent(self, other)
add_next(self, task)
clear(self)
do_restart(self)
do_update(self, timer)
kill(self)
pause(self)
restart(self)
resume(self)
toggle_pause(self)
update(self, timer)

class TaskError(Exception)

Common base class for all non-exit exceptions.

Methods

__init__(self, /, *args, **kwargs)

Initialize self. See help(type(self)) for accurate signature.

with_traceback(...)

Exception.with_traceback(tb) -- set self.traceback to tb and return self.

Attributes

  • args = <attribute 'args' of 'BaseException' objects>

class TaskGroup(Task)

Properties

  • count
  • is_killed
  • is_paused
  • is_running
  • parent_task
  • state

Methods

__init__(self, tasks=[], auto_kill=None, auto_remove=None, loop=None, *a, **k)

Initialize self. See help(type(self)) for accurate signature.

_set_parent(self, manager)
_task_equivalent(self, other)
add(self, task)
add_next(self, task)
clear(self)
do_restart(self)
do_update(self, timer, log_message=None, traceback=None)
find(self, task)
kill(self)
pause(self)
remove(self, task)
restart(self)
resume(self)
toggle_pause(self)
update(self, timer)

Attributes

  • auto_kill = True - bool(x) -> bool
  • auto_remove = True - bool(x) -> bool
  • loop = False - bool(x) -> bool

class TimedCallbackTask(SequenceTask)

Properties

  • is_killed
  • is_paused
  • is_running
  • parent_task
  • state

Methods

__init__(self, tasks=[], *a, **k)

Initialize self. See help(type(self)) for accurate signature.

_advance_sequence(self)
_call(self, _time_expired)
_callback(*a, **k)
_set_parent(self, manager)
_task_equivalent(self, other)
add_next(self, task)
cancel(self)
clear(self)
do_restart(self)
do_update(self, delta)
kill(self)
pause(self)
restart(self)
resume(self)
start(self, duration, callback)
toggle_pause(self)
update(self, timer)

class TimerTask(WaitTask)

Properties

  • is_killed
  • is_paused
  • is_running
  • parent_task
  • state

Methods

__init__(self, duration=None, *a, **k)

Initialize self. See help(type(self)) for accurate signature.

_set_parent(self, manager)
_task_equivalent(self, other)
add_next(self, task)
clear(self)
do_restart(self)
do_update(self, timer)
kill(self)
on_finish(self)
on_tick(self)
pause(self)
restart(self)
resume(self)
toggle_pause(self)
update(self, timer)

Attributes

  • duration = 1.0 - Convert a string or number to a floating point number, if possible.

class WaitTask(Task)

Properties

  • is_killed
  • is_paused
  • is_running
  • parent_task
  • state

Methods

__init__(self, duration=None, *a, **k)

Initialize self. See help(type(self)) for accurate signature.

_set_parent(self, manager)
_task_equivalent(self, other)
add_next(self, task)
clear(self)
do_restart(self)
do_update(self, delta)
kill(self)
pause(self)
restart(self)
resume(self)
toggle_pause(self)
update(self, timer)

Attributes

  • duration = 1.0 - Convert a string or number to a floating point number, if possible.

class WrapperTask(Task)

Properties

  • is_killed
  • is_paused
  • is_running
  • parent_task
  • state

Methods

__init__(self, wrapped_task=None, *a, **k)

Initialize self. See help(type(self)) for accurate signature.

_set_parent(self, manager)
_task_equivalent(self, other)
add_next(self, task)
clear(self)
do_restart(self)
do_update(self, timer)
kill(self)
pause(self)
restart(self)
resume(self)
toggle_pause(self)
update(self, delta)

class delay(Task)

Properties

  • is_killed
  • is_paused
  • is_running
  • parent_task
  • state

Methods

__init__(self, duration=None, *a, **k)

Initialize self. See help(type(self)) for accurate signature.

_set_parent(self, manager)
_task_equivalent(self, other)
add_next(self, task)
clear(self)
do_restart(self)
do_update(self, delta)
kill(self)
pause(self)
restart(self)
resume(self)
toggle_pause(self)
update(self, timer)

Attributes

  • duration = 1 - int([x]) -> integer

class fade(Task)

Properties

  • is_killed
  • is_paused
  • is_running
  • parent_task
  • state

Methods

__init__(self, func=<function FadeTask.<lambda> at 0x162c881e0>, duration=1.0, loop=False, init=False, *a, **k)

Initialize self. See help(type(self)) for accurate signature.

_set_parent(self, manager)
_task_equivalent(self, other)
add_next(self, task)
clear(self)
do_restart(self)
do_update(self, delta)
kill(self)
pause(self)
restart(self)
resume(self)
toggle_pause(self)
update(self, timer)

class wait(Task)

Properties

  • is_killed
  • is_paused
  • is_running
  • parent_task
  • state

Methods

__init__(self, duration=None, *a, **k)

Initialize self. See help(type(self)) for accurate signature.

_set_parent(self, manager)
_task_equivalent(self, other)
add_next(self, task)
clear(self)
do_restart(self)
do_update(self, delta)
kill(self)
pause(self)
restart(self)
resume(self)
toggle_pause(self)
update(self, timer)

Attributes

  • duration = 1.0 - Convert a string or number to a floating point number, if possible.