Class: Action

Extends

• DKTools.Event

Members

_animation DKTools.Animation privatereadonly

_data * privatereadonly

_endTime Number privatereadonly

_id Number | String | * privatereadonly inherited

_manager DKTools.EventsManager privatereadonly inherited

_onFail function | null privatereadonly inherited

_onPause function | null privatereadonly inherited

_onRepeat function | null privatereadonly inherited

_onReset function | null privatereadonly inherited

_onStart function | null privatereadonly inherited

_onSuccess function | null privatereadonly inherited

_onUpdate function | null privatereadonly inherited

_remainingPauseTime Number privatereadonly inherited

_remainingRepeats Number privatereadonly inherited

_remainingTime Number privatereadonly inherited

_repeats Number privatereadonly inherited

_repeatTime Number privatereadonly inherited

_started Boolean privatereadonly inherited

_startTime Number privatereadonly

_target DKTools.Sprite | DKTools.Window | * privatereadonly inherited

_type String privatereadonly inherited

animation

Gets animation

data

Gets data of the action

endTime

Gets end time of the action

endTime

Sets end time of the action

id inherited

Gets id of the event

manager inherited

Gets manager of the event

remainingPauseTime inherited overrides

Gets remaining time of pause

remainingRepeats inherited overrides

Remaining amount of repeats

remainingTime inherited overrides

Gets remaining time of current repeat

repeats inherited

Gets amount of repeats

repeatTime inherited

Gets time of one repeat

startTime

Gets start time of the action

startTime

Sets start time of the action

target overrides

Gets the target

type inherited

Gets type of the event

Methods

DKTools.Animation.Action.Frame (object)DKTools.Animation.Action static

Creates an action to change the frame of a target Returns the action Only for sprites

Name	Type	Description
object	DKTools.Animation.Action | Object	Action or object with parameters

Version:

• 1.1.0

Returns:

Type	Description
DKTools.Animation.Action	Action

DKTools.Animation.Action.Move (object)DKTools.Animation.Action static

Creates an action to move a target Returns the action

Name	Type	Description
object	DKTools.Animation.Action | Object	Action or object with parameters

Version:

• 1.1.0

Returns:

Type	Description
DKTools.Animation.Action	Action

DKTools.Animation.Action.Opacity (object)DKTools.Animation.Action static

Creates an action to change the opacity of a target Returns the action

Name	Type	Description
object	DKTools.Animation.Action | Object	Action or object with parameters

Version:

• 1.1.0

Returns:

Type	Description
DKTools.Animation.Action	Action

DKTools.Animation.Action.Rotation (object)DKTools.Animation.Action static

Creates an action to rotate a target Returns the action

Name	Type	Description
object	DKTools.Animation.Action | Object	Action or object with parameters

Version:

• 1.1.0

Returns:

Type	Description
DKTools.Animation.Action	Action

DKTools.Animation.Action.Scale (object)DKTools.Animation.Action static

Creates an action to change the scale of a target Returns the action Only for sprites

Name	Type	Description
object	DKTools.Animation.Action | Object	Action or object with parameters

Version:

• 1.1.0

Returns:

Type	Description
DKTools.Animation.Action	Action

_callOnFailHandler (data) private inherited

Calls on failure handler

Name	Type	Description
data	*	optional Data

Version:

• 1.1.5

_callOnPauseHandler (data) private inherited

Calls on pause handler

Name	Type	Description
data	*	optional Data

Version:

• 1.1.5

_callOnRepeatHandler (data) private inherited

Calls on repeat handler

Name	Type	Description
data	*	optional Data

Version:

• 1.1.5

_callOnResetHandler (data) private inherited

Calls on reset handler

Name	Type	Description
data	*	optional Data

Version:

• 1.1.5

_callOnStartHandler (data) private inherited

Calls on start handler

Name	Type	Description
data	*	optional Data

Version:

• 1.1.5

_callOnSuccessHandler (forcedSuccess, data) private inherited

Calls on success handler

Name	Type	Default	Description
forcedSuccess	Boolean	false	optional Forced success
data	*		optional Data

Version:

• 1.1.5

_callOnUpdateHandler (data) private inherited

Calls on update handler

Name	Type	Description
data	*	optional Data

_canCallOnFailHandler ()Boolean private inherited

Returns true if can call on failure handler

Returns:

Type	Description
Boolean	Can call on failure handler

_canCallOnPauseHandler ()Boolean private inherited

Returns true if can call on pause handler

Returns:

Type	Description
Boolean	Can call on pause handler

_canCallOnRepeatHandler ()Boolean private inherited

Returns true if can call on repeat handler

Returns:

Type	Description
Boolean	Can call on repeat handler

_canCallOnResetHandler ()Boolean private inherited

Returns true if can call on reset handler

Returns:

Type	Description
Boolean	Can call on reset handler

_canCallOnStartHandler ()Boolean private inherited

Returns true if can call on start handler

Returns:

Type	Description
Boolean	Can call on start handler

_canCallOnSuccessHandler ()Boolean private inherited

Returns true if can call on success handler

Returns:

Type	Description
Boolean	Can call on success handler

_canCallOnUpdateHandler ()Boolean private inherited

Returns true if can call on update handler

Returns:

Type	Description
Boolean	Can call on update handler

_clearRemainingRepeats () private inherited

Clears the remaining time of the event repeat

_clearRemainingTime () private inherited

Clears the remaining time of the event repeat

_resetRemainingRepeats () private inherited

Resets the remaining amount of repeats of the event

_resetRemainingTime () private inherited

Resets the remaining time of the event repeat

_update (data) private inherited

Updates the event

Name	Type	Description
data	*	optional Data

_updatePause () private inherited

Updates the pause

_updateRemainingPauseTime () private inherited

Updates the remaining pause time

_updateRemainingRepeats () private inherited

Updates the remaining repeats

_updateRemainingTime () private inherited

Updates the remaining time

fail (data) inherited

Fails the events

Name	Type	Description
data	*	optional Data

Since:

• 1.1.5

finish (forcedSuccess, data) inherited

Finishes the event

Name	Type	Default	Description
forcedSuccess	Boolean	false	optional Forced successful completion of the event
data	*		optional Data

getElapsedRepeats ()Number inherited

Returns the elapsed repeats

Returns:

Type	Description
Number	Elapsed repeats

getElapsedTime ()Number inherited overrides

Returns the elapsed time

Returns:

Type	Description
Number	Elapsed time

getRemainingTime ()Number

Returns the remaining time

Returns:

Type	Description
Number	Remaining time

hasManager ()Boolean inherited

Returns true if the event has the manager

Returns:

Type	Description
Boolean	Event has the manager

hasOnFailHandler ()Boolean inherited

Returns true if the event has the on failure handler

Returns:

Type	Description
Boolean	Event has the on failure handler

hasOnPauseHandler ()Boolean inherited

Returns true if the event has the on pause handler

Returns:

Type	Description
Boolean	Event has the on pause handler

hasOnRepeatHandler ()Boolean inherited

Returns true if the event has the on repeat handler

Returns:

Type	Description
Boolean	Event has the on repeat handler

hasOnResetHandler ()Boolean inherited

Returns true if the event has the on reset handler

Returns:

Type	Description
Boolean	Event has the on reset handler

hasOnStartHandler ()Boolean inherited

Returns true if the event has the on start handler

Returns:

Type	Description
Boolean	Event has the on start handler

hasOnSuccessHandler ()Boolean inherited

Returns true if the event has the on success handler

Returns:

Type	Description
Boolean	Event has the on success handler

hasOnUpdateHandler ()Boolean inherited

Returns true if the event has the on update handler

Returns:

Type	Description
Boolean	Event has the on update handler

hasTarget ()Boolean inherited

Returns true if the event has the target

Returns:

Type	Description
Boolean	Event has the target

hasType ()Boolean inherited

Returns true if the event has the type

Returns:

Type	Description
Boolean	Event has the type

initialize (object) inherited overrides

Initializes the action

Name	Type	Description
object	Object	Parameters Name Type Description startTime Number Start time of the action endTime Number End time of the action data * Data of the action

isAnimation ()Boolean inherited

Returns true if the event is animation

Returns:

Type	Description
Boolean	Event is animation

isAnimationAction ()Boolean inherited

Returns true if the event is action of an animation

Returns:

Type	Description
Boolean	Event is action of an animation

isFinished ()Boolean inherited overrides

Returns true if the action if finished

Returns:

Type	Description
Boolean	Action if finished

isPaused ()Boolean inherited

Returns true if the event is paused

Returns:

Type	Description
Boolean	Event is paused

isStarted ()Boolean inherited

Returns true if the event is started

Returns:

Type	Description
Boolean	Event is started

isUpdated ()Boolean inherited overrides

Returns true if the action is updated

Returns:

Type	Description
Boolean	Action is updated

pause (duration) inherited

Pauses the event

Name	Type	Default	Description
duration	Number	-1	optional Duration of pause

remove ()Boolean inherited overrides

Removes the action

Returns:

Type	Description
Boolean	Event was removed

repeat () inherited overrides

Repeats the action

reset () inherited overrides

Resets the action

resume () inherited

Resumes the event

setAnimation (animation)

Sets the animation

Name	Type	Description
animation	DKTools.Animation	Animation

setManager (manager) inherited

Sets the manager

Name	Type	Description
manager	DKTools.EventsManager	Manager

setOnFailHandler (handler) inherited

Sets the on failure handler

Name	Type	Description
handler	function	Handler

setOnPauseHandler (handler) inherited

Sets the on pause handler

Name	Type	Description
handler	function	Handler

setOnRepeatHandler (handler) inherited

Sets the on repeat handler

Name	Type	Description
handler	function	Handler

setOnResetHandler (handler) inherited

Sets the on reset handler

Name	Type	Description
handler	function	Handler

setOnStartHandler (handler) inherited

Sets the on start handler

Name	Type	Description
handler	function	Handler

setOnSuccessHandler (handler) inherited

Sets the on success handler

Name	Type	Description
handler	function	Handler

setOnUpdateHandler (handler) inherited

Sets the on update handler

Name	Type	Description
handler	function	Handler

setTarget (target) inherited

Sets the target

Name	Type	Description
target	DKTools.Sprite | DKTools.Window | *	Target

stop (forcedSuccess) inherited

Stops the event

Name	Type	Default	Description
forcedSuccess	Boolean	false	optional Forced successful completion of the event

update (data) inherited

Updates the event

Name	Type	Description
data	*	optional Data