Cocos2D JavaScript (edge) API Documentation

Class: Plist

Module
Global
Defined In
libs/Plist.js
Extends
BObject
An object representation of an XML Property List file

Public Properties

Property Defined By
Expand data data : Object
The unserialized data inside the Plist file
Plist
Expand id id : Integer <read-only>
Unique ID for this object
BObject

Public Methods

Method Defined By
Expand Plist new Plist (opts:Options{[file:String],[data:String]}) : Plist <constructor>
An object representation of an XML Property List file

Arguments

  1. opts : Options
    Options

Named Arguments

opts

  • file : String (Optional)
    The path to a .plist file
  • data : String (Optional)
    The contents of a .plist file

Returns

  • Plist
    New instance of Plist
 Plist
Expand bindTo bindTo (key:String,target:BOject,[targetKey:String],[noNotify:Boolean]) : void
Bind the value of a property on this object to that of another object so they always have the same value. Setting the value on either object will update the other too.

Arguments

  1. key : String
    Name of the property on this object that should be bound
  2. target : BOject
    Object to bind to
  3. targetKey : String (Optional)
    Key on the target object to bind to
  4. noNotify : Boolean (Optional)
    Set to true to prevent this object's property triggering a 'changed' event when adding the binding

Returns

  • void
 BObject
Expand changed changed (key:*) : void

Arguments

  1. key :

Returns

  • void
 BObject
Expand get get (key:String) : *
Get a property from the object. Always use this instead of trying to access the property directly. This will ensure all bindings, setters and getters work correctly.

Arguments

  1. key : String
    Name of property to get or dot (.) separated path to a property

Returns

  • *
    Value of the property
 BObject
Expand set set (key:String,value:*) : void
Set a property on the object. Always use this instead of trying to access the property directly. This will ensure all bindings, setters and getters work correctly.

Arguments

  1. key : String
    Name of property to get
  2. value : *
    New value for the property

Returns

  • void
 BObject
Expand setValues setValues (kvp:Object) : void
Set multiple propertys in one go

Arguments

  1. kvp : Object
    An Object where the key is a property name and the value is the value to assign to the property

Returns

  • void
 BObject
Expand unbind unbind (key:String) : void
Remove binding from a property which set setup using BObject#bindTo.

Arguments

  1. key : String
    Name of the property on this object to unbind

Returns

  • void
 BObject
Expand unbindAll unbindAll () : void
Remove all bindings on this object

Returns

  • void
 BObject

Private Members

This class has no private members.