Interface SubjectEvent

Provides information about an event that has happened to a Subject. A SubjectEvent has a name, a value, and can identify which Subject broadcast the event.

See Subject for more extensive documentation.

interface SubjectEvent {
    getName(opt_localized?): string;
    getSubject(): Subject;
    getValue(): any;
    nameEquals(name): boolean;
    toStringShort(): string;
}

Hierarchy (view full)

Implemented by

Methods

getName getSubject getValue nameEquals toStringShort

Methods

getName

  • getName(opt_localized?): string

  • Name of this SubjectEvent, either the language-independent name for scripting purposes or the localized name for display to user.

    The language-independent name should be the same as the English version but capitalized and with spaces and dashes replaced by underscore, see Util.toName and nameEquals.

    Parameters

    • Optional opt_localized: boolean

      true means return the localized version of the name; default is false which means return the language independent name.

    Returns string

    name of this object

getSubject

getValue

  • getValue(): any

  • Returns the value of this SubjectEvent, or undefined if there is no assigned value.

    Returns any

    the value of this SubjectEvent

nameEquals

  • nameEquals(name): boolean

  • Whether this SubjectEvent has the given name, adjusting for the transformation to a language-independent form of the name, as is done by Util.toName.

    Parameters

    • name: string

      the English or language-independent version of the name

    Returns boolean

    whether this SubjectEvent has the given name (adjusted to language-independent form)

toStringShort

  • toStringShort(): string

  • Returns a minimal string representation of this object, usually giving just identity information like the class name and name of the object.

    For an object whose main purpose is to represent another Printable object, it is recommended to include the result of calling toStringShort on that other object. For example, calling toStringShort() on a DisplayShape might return something like this:

    DisplayShape{polygon:Polygon{'chain3'}}

    Returns string

    a minimal string representation of this object.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc