Cocos2d-x  v3.11
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Groups
TMXObjectGroup Class Reference

TMXObjectGroup represents the TMX object group. More...

Inherits Ref.

Public Member Functions

const std::string & getGroupName () const
 Get the group name. More...
 
var getGroupName ()
 Get the group name. More...
 
local getGroupName ()
 Get the group name. More...
 
void setGroupName (const std::string &groupName)
 Set the group name. More...
 
var setGroupName ( var groupName)
 Set the group name. More...
 
local setGroupName ( local groupName)
 Set the group name. More...
 
Value getProperty (const std::string &propertyName) const
 Return the value for the specific property name. More...
 
local getProperty ( local propertyName)
 Return the value for the specific property name. More...
 
ValueMap getObject (const std::string &objectName) const
 Return the dictionary for the specific object name. More...
 
var getObject ( var objectName)
 Return the dictionary for the specific object name. More...
 
local getObject ( local objectName)
 Return the dictionary for the specific object name. More...
 
const Vec2getPositionOffset () const
 Gets the offset position of child objects. More...
 
void setPositionOffset (const Vec2 &offset)
 Sets the offset position of child objects. More...
 
var setPositionOffset ( var offset)
 Sets the offset position of child objects. More...
 
local setPositionOffset ( local offset)
 Sets the offset position of child objects. More...
 
const ValueMap & getProperties () const
 Gets the list of properties stored in a dictionary. More...
 
void setProperties (const ValueMap &properties)
 Sets the list of properties. More...
 
var setProperties ( var properties)
 Sets the list of properties. More...
 
local setProperties ( local properties)
 Sets the list of properties. More...
 
const ValueVector & getObjects () const
 Gets the array of the objects. More...
 
void setObjects (const ValueVector &objects)
 Sets the array of the objects. More...
 
var setObjects ( var objects)
 Sets the array of the objects. More...
 
local setObjects ( local objects)
 Sets the array of the objects. More...
 
- Public Member Functions inherited from Ref
void retain ()
 Retains the ownership. More...
 
local retain ()
 Retains the ownership. More...
 
void release ()
 Releases the ownership immediately. More...
 
Refautorelease ()
 Releases the ownership sometime soon automatically. More...
 
unsigned int getReferenceCount () const
 Returns the Ref's current reference count. More...
 
local getReferenceCount ()
 Returns the Ref's current reference count. More...
 
virtual ~Ref ()
 Destructor.
 

Additional Inherited Members

- Public Attributes inherited from Ref
unsigned int _ID
 object id, ScriptSupport need public _ID
 
local _ID
 object id, ScriptSupport need public _ID
 
int _luaID
 Lua reference id.
 
local _luaID
 Lua reference id.
 
void * _scriptObject
 scriptObject, support for swift
 
local _scriptObject
 scriptObject, support for swift
 
bool _rooted
 When true, it means that the object was already rooted.
 
local _rooted
 When true, it means that the object was already rooted.
 
bool _scriptOwned
 The life of the object is scrolled by the scripting engine. More...
 
local _scriptOwned
 The life of the object is scrolled by the scripting engine. More...
 

Detailed Description

TMXObjectGroup represents the TMX object group.

Member Function Documentation

const std::string& getGroupName ( ) const
inline

Get the group name.

The group name.

var getGroupName ( )
inline

Get the group name.

The group name.

local getGroupName ( )
inline

Get the group name.

The group name.

void setGroupName ( const std::string &  groupName)
inline

Set the group name.

A string,it is used to set the group name.

var setGroupName ( var  groupName)
inline

Set the group name.

A string,it is used to set the group name.

local setGroupName ( local  groupName)
inline

Set the group name.

A string,it is used to set the group name.

Value getProperty ( const std::string &  propertyName) const

Return the value for the specific property name.

The specific property name. Return the value for the specific property name.

local getProperty ( local  propertyName)

Return the value for the specific property name.

The specific property name. Return the value for the specific property name.

ValueMap getObject ( const std::string &  objectName) const

Return the dictionary for the specific object name.

It will return the 1st object found on the array for the given name.

Return the dictionary for the specific object name.

var getObject ( var  objectName)

Return the dictionary for the specific object name.

It will return the 1st object found on the array for the given name.

Return the dictionary for the specific object name.

local getObject ( local  objectName)

Return the dictionary for the specific object name.

It will return the 1st object found on the array for the given name.

Return the dictionary for the specific object name.

const Vec2& getPositionOffset ( ) const
inline

Gets the offset position of child objects.

The offset position of child objects.

var getPositionOffset ( )
inline

Gets the offset position of child objects.

The offset position of child objects.

local getPositionOffset ( )
inline

Gets the offset position of child objects.

The offset position of child objects.

void setPositionOffset ( const Vec2 offset)
inline

Sets the offset position of child objects.

The offset position of child objects.

var setPositionOffset ( var  offset)
inline

Sets the offset position of child objects.

The offset position of child objects.

local setPositionOffset ( local  offset)
inline

Sets the offset position of child objects.

The offset position of child objects.

const ValueMap& getProperties ( ) const
inline

Gets the list of properties stored in a dictionary.

The list of properties stored in a dictionary.

var getProperties ( )
inline

Gets the list of properties stored in a dictionary.

The list of properties stored in a dictionary.

local getProperties ( )
inline

Gets the list of properties stored in a dictionary.

The list of properties stored in a dictionary.

void setProperties ( const ValueMap &  properties)
inline

Sets the list of properties.

The list of properties.

var setProperties ( var  properties)
inline

Sets the list of properties.

The list of properties.

local setProperties ( local  properties)
inline

Sets the list of properties.

The list of properties.

const ValueVector& getObjects ( ) const
inline

Gets the array of the objects.

The array of the objects.

var getObjects ( )
inline

Gets the array of the objects.

The array of the objects.

local getObjects ( )
inline

Gets the array of the objects.

The array of the objects.

void setObjects ( const ValueVector &  objects)
inline

Sets the array of the objects.

The array of the objects.

var setObjects ( var  objects)
inline

Sets the array of the objects.

The array of the objects.

local setObjects ( local  objects)
inline

Sets the array of the objects.

The array of the objects.


The documentation for this class was generated from the following file: