API Documentation for: 0.11.8
Show:

platypus.components.XHR Class

This component provides component-based XHR communication with a server.

Methods

'request'

(
  • message
)

Defined in 'request':60

On receiving this message, this component makes a request from the server using the provided information. Note that properties set here will reset the properties set by this component's JSON definition.

Parameters:

  • message Object
    • method String

      XHR method to use: must be "GET" or "POST".

    • path String

      The path to the server resource.

    • [responseType="text"] String optional

      Response type expected.

    • [data] Object optional

      An object of string key/value pairs to be transmitted to the server.

    • onload Function

      A function that should be run on receiving a response from the server. This defaults to triggering a "response" message containing the responseText value.

addEventListener

(
  • event
  • callback
)
Function private
This method adds an event listener to the entity.

Parameters:

  • event String
    The event that this component should listen for.
  • callback Function
    The handler for the event.

Returns:

Function: handler A reference to the bound handler.

addMethod

(
  • name
  • func
)
private
This method adds a method to the entity.

Parameters:

  • name String
    The name of the method. For example, if name is "turnYellow", the method is accessible on the entity as entity.turnYellow().
  • func Function
    The function describing the method.

destroy

() private

Inherited from platypus.Component: destroy:54

This method cleans up listeners and methods that this component added to the entity. It should never be called by the component itself. Call this.owner.removeComponent(this) instead.

getAssetList

(
  • definition
  • properties
  • defaultProperties
)
Array
This method can be overwritten to provide the list of assets this component requires. This method is invoked when the list of game scenes is created to determine assets for each scene.

Parameters:

  • definition Object
    The definition for the component.
  • properties Object
    The properties of the Entity.
  • defaultProperties Object
    The default properties of the Entity.

Returns:

Array: A list of the necessary assets to load.

getLateAssetList

(
  • data
)
Array
This method can be overwritten to provide the list of assets this component requires. This method is invoked when the list of game scenes is created to determine assets for each scene.

Parameters:

  • data Object
    Scene data that affects the list of assets.

Returns:

Array: A list of the necessary assets to load.

removeEventListener

(
  • event
  • callback
)
private
This method removes an event listener from the entity.

Parameters:

  • event String
    The event for which to remove a listener.
  • callback Function
    The listener to remove. If not supplied, all event listeners for the provided event are removed.

removeEventListeners

(
  • [listeners]
)
private
This method removes multiple event listeners from the entity.

Parameters:

  • [listeners] Array optional
    The list of listeners to remove. If not supplied, all event listeners are removed.

removeMethod

(
  • name
)
private
This method removes a method from the entity.

Parameters:

  • name String
    The name of the method to be removed.

toJSON

() Object

Inherited from platypus.Component: toJSON:45

Available since 0.11.0

Returns a JSON object describing the component.

Returns:

Object: Returns a JSON definition that can be used to recreate the component.

toString

() String
Returns a string describing the component.

Returns:

String: Returns the component type as a string of the form "[Component ComponentType]".

Properties

method

String

Defined in method:18

Sets the XHR method to use.

Default: "GET"

path

String

Defined in path:27

Sets the path to connect to the server.

Default: ""

responseType

String

Defined in responseType:36

Sets the XHR response type.

Default: "text"

withCredentials

Boolean

Defined in withCredentials:45

Whether cookies should be retained on cross-domain calls.

Default: false

Events

'response'

Defined in 'response':109

This message is triggered on receiving a response from the server (if "onload" is not set by the original "request" message).

Event Payload:

  • message String

    The message contains the responseText returned by the server.