WanaPlan

API Docs for: 2.7.0
Show:

MobileComponent

Extends BaseComponent2D
Module: Component
Parent Module: Wanaplan

Summary

This component is responsible for configuring Wanaplan on mobile devices. It adapts graphics, adds a mobile stylesheet and removes some unecessary components.

Constructor

MobileComponent

Syntax

MobileComponent

(
  • core
  • forceNoDirty
)

Summary

Parameters:

  • core Core

    The main engine.

  • forceNoDirty Boolean

    If true, forces this component to be clean.

Methods

_toggleMenu

Syntax

_toggleMenu

()

Summary

Toggle the visibility of the left menu. Triggered on event wnp.mobile.toggleMenu

destroy

Inherited from BaseComponent2D:

Syntax

destroy

()

Summary

Method called when the component is destroyed

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

Disables/Removes some unecessary components and applies the mobile configuration.

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

onCoreInitialized

Syntax

onCoreInitialized

(
  • event
)

Summary

Applies configuration for mobile (graphics, performances). This method is called after all components are initialized. Triggered on event wnp.core.initialized

Parameters:

  • event Event

    The event object.

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

Events

wnp.menu.top.sub.add

Syntax

wnp.menu.top.sub.add

Summary

Fired to add a menu item into the sub menu.

wnp.menu.top.sub.replace

Syntax

wnp.menu.top.sub.replace

Summary

Fired to replace a sub menu item.

wnp.mobile.toggleMenu

Syntax

wnp.mobile.toggleMenu

Summary

Fired to show/hide the left menu on mobile devices