WanaPlan

API Docs for: 2.7.0
Show:

UpdateNotification

Extends BaseComponent2D
Module: Component
Parent Module: Wanaplan

Summary

This component is responsible to display notifications about news and updates.

Constructor

UpdateNotification

Syntax

UpdateNotification

(
  • core
)

Summary

Parameters:

  • core Core

    The main engine.

Methods

_showNotification

Syntax

_showNotification

(
  • event
)
private

Summary

Show the notification with the loaded HTML data.

Parameters:

  • event Event

    The event.

close

Syntax

close

()

Summary

Close the notification window.

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

Initialize the component and add an entry into the option menu.

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

show

Syntax

show

(
  • html
  • [params]
)

Summary

Display the notification.

Parameters:

  • html String

    The html string to use.

  • [params] Object optional

    A set of custom parameters.

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