API Docs for:
Show:

Component_Handler Class

Module: ui

The base class for all handler-components. A handler-component is used to handle condition- or event-based processes of a In-Game UI object like executing bindings or triggering actions.

A handler is only executed if all assigned conditions and events are true.

Methods

checkCondition

(
  • object
  • condition
)
Boolean static

Checks if the condition is true for the specified game object.

Parameters:

  • object gs.Object_Base

    The game object.

  • condition Object

    The condition-object.

Returns:

Boolean:

If true the condition is true. Otherwise false.

checkCondition

(
  • condition
)
Boolean

Checks if the specified condition is true.

Parameters:

  • condition Object

    The condition-object.

Returns:

Boolean:

If true the condition is true. Otherwise false.

checkConditions

(
  • conditions
)
Boolean

Checks if the specified conditions are true.

Parameters:

  • conditions Object

    An array of condition-objects.

Returns:

Boolean:

If true all conditions are true. Otherwise false.

checkEvent

(
  • event
  • [binding=null]
)
Boolean

Checks if the specified event is true.

Parameters:

  • event Object

    The event to check for.

  • [binding=null] Object optional

    binding An optional binding-object necessary for some event-types.

Returns:

Boolean:

If true the event is true. Otherwise false.

checkObject

(
  • object
)
Boolean

Checks if all events and conditions defined for the handler are true. If that check returns true the handler must be executed.

Parameters:

  • object Object

    The game object to check.

Returns:

Boolean:

If true the handler must be executed. Otherwise false.

Properties

mouseEntered

Boolean protected

mouseLeaved

Boolean protected