WanaPlan

API Docs for: 2.7.0
Show:

SA_WebService

Extends BaseComponent2D
Module: Component
Parent Module: Wanaplan

Summary

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

Constructor

SA_WebService

Syntax

SA_WebService

(
  • core
  • options
)

Summary

Parameters:

  • core Core

    The main engine.

  • options Object

    A dictionary that contains options.

Methods

_sendToServer

Syntax

_sendToServer

(
  • plan
  • success
  • error
)
private

Summary

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:

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

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

save

Syntax

save

(
  • plans
  • success
  • error
)

Summary

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:

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