API Docs for: 2.7.3
Show:

UpdateNotification Class

Extends BaseComponent2D
Module: Component
Parent Module: Wanaplan

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

Constructor

UpdateNotification

(
  • core
)

Parameters:

  • core Core

    The main engine.

Methods

_showNotification

(
  • event
)
private

Show the notification with the loaded HTML data.

Parameters:

close

()

Close the notification window.

destroy

()

Inherited from BaseComponent2D:

Method called when the component is destroyed

disable

()

Inherited from BaseComponent2D:

Disables the component

enable

()

Inherited from BaseComponent2D:

Enables the component

getTargeted

(
  • vector
)
Object

Inherited from BaseComponent2D:

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

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

onContextChanged

(
  • context
)

Inherited from BaseComponent2D:

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

Parameters:

  • context String
    The new context

show

(
  • html
  • [params]
)

Display the notification.

Parameters:

  • html String

    The html string to use.

  • [params] Object optional

    A set of custom parameters.

startListening

()

Inherited from BaseComponent2D:

Calls all the event listeners.

stopListening

()

Inherited from BaseComponent2D:

Removes all the event listeners.

update

()

Inherited from BaseComponent2D:

Generic update method, called on every frame

Properties

name

String

Inherited from BaseComponent2D:

Component name

priority

Number

Inherited from BaseComponent2D:

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

structure

wnp.Structure

Inherited from BaseComponent2D:

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