API Docs for: 2.7.3
Show:

SA_WebService Class

Extends BaseComponent2D
Module: Component
Parent Module: Wanaplan

A web service manager responible to send saved plan on the server.

Constructor

SA_WebService

(
  • core
  • options
)

Parameters:

  • core Core

    The main engine.

  • options Object

    A dictionary that contains options.

Methods

_sendToServer

(
  • plan
  • success
  • error
)
private

Checks if the user is connected and send a plan to the server.

Parameters:

  • plan Object

    The plan to send.

  • success Function

    A function called when the process is done.

  • error Function

    A function called if an error has occured.

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:

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

onContextChanged

(
  • context
)

Inherited from BaseComponent2D:

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

Parameters:

  • context String

    The new context

save

(
  • plans
  • success
  • error
)

Save plans on the server.

Parameters:

  • plans Array

    An array of plans.

  • success Function

    A function called when the process is done.

  • error Function

    A function called if an error has occured.

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