WanaPlan

API Docs for: 2.7.0
Show:

MobileInputComponent

Extends BaseComponent2D
Module: Component
Parent Module: Wanaplan

Summary

This component is responsible for configuring the correct input mode on mobile devices. It checks the user's input method (touch or mouse). If mouse is detected nothing is done and the component is removed. Otherwise, touch screen support is enabled.

Constructor

MobileInputComponent

Syntax

MobileInputComponent

(
  • core
)

Summary

Parameters:

  • core Core

    The main engine.

Methods

_bindListeners

Syntax

_bindListeners

()

Summary

Binds the listeners for input events

_onInputChanged

Syntax

_onInputChanged

(
  • event
)

Summary

Called when an input event is detected. It disables the input method that is not necessary (touch or mouse). Triggered on window events touchstart, mousemove, pointerdown, or MSPointerDown

Parameters:

  • event Event

    The event object.

_unbindListeners.

Syntax

_unbindListeners.

()

Summary

Unbinds the listeners for input events

destroy

Inherited from BaseComponent2D

Syntax

destroy

()

Summary

Destroys the component and removes all listeners.

disable

Inherited from BaseComponent2D:

Syntax

disable

()

Summary

Disables the component

enable

Inherited from BaseComponent2D:

Syntax

enable

()

Summary

Enables the component

getTargeted

Inherited from BaseComponent2D:

Syntax

getTargeted

(
  • vector
)
Object

Summary

Finds out if the given position is over an element handled by the component

Parameters:

  • vector Vector

    A position, usually the cursor's one.

Returns:

Object:

The targeted element, or null if nothing is found.

initialize

Inherited from BaseComponent2D:

Syntax

initialize

()

Summary

Method called when Wanaplan is initialized. You don't need to call this method manually.

onContextChanged

Inherited from BaseComponent2D:

Syntax

onContextChanged

(
  • context
)

Summary

Method called when the context is switched (2D -> 3D or 3D -> 2D)

Parameters:

  • context String
    The new context

removeInputSupport

Syntax

removeInputSupport

(
  • type
)

Summary

Removes support of an input method (touch or mouse).

Parameters:

  • type String

    The type of input method to remove (touch or mouse).

startListening

Inherited from BaseComponent2D:

Syntax

startListening

()

Summary

Calls all the event listeners.

stopListening

Inherited from BaseComponent2D:

Syntax

stopListening

()

Summary

Removes all the event listeners.

update

Inherited from BaseComponent2D:

Syntax

update

()

Summary

Generic update method, called on every frame

Properties

name

Inherited from BaseComponent2D:

Syntax

name

String

Summary

Component name

priority

Inherited from BaseComponent2D:

Syntax

priority

Number

Summary

Priority of the component in the "update" and "draw" routines

structure

Inherited from BaseComponent2D:

Syntax

structure

wnp.Structure

Summary

Structure file instance (shortcut to wanaplan.structure). This is the base object where the whole plan is saved