dcsext.interfaces.Observable

Implements a Observable interface.

Contents

  1. Fields
    1. observable.notify
  2. Metamethods
    1. observable:__init(logger)
  3. Methods
    1. observable:addObserver(func, obj, name)
    2. observable:removeObserver(obj)

Fields

observable.notify

If profile is set to true a different notify function will be enabled which tracks how long it takes to notify all observers. This could be beneficial when trying to debug stuttering.

Parameters

event
the event to notify observers with.

Metamethods

observable:__init(logger)

Parameters

logger
reference to dct.libs.Logger instance

Methods

observable:addObserver(func, obj, name)

Parameters

func
callback to execute when this object needs to notify observers.
obj
the object containing func.
name
a string to identify the observer, used in debug logs.

observable:removeObserver(obj)

Parameters

obj
the observer object to remove.