propertycollection - TogetherGames/Public-Corona-Lua GitHub Wiki

The PropertyCollection class contains a list of TogetherProperties and additional child PropertyCollections.

The name of this collection node.

A list of TogetherProperties.

A list of children PropertyCollections.

Creates a new PropertyCollection object

PropertyCollection:New(  )

Gets the property with the specified name if it exists, otherwise returns nil.

PropertyCollection:FindProperty( propertyName )

string propertyName

The name of the property to find

Gets the property value with the specified name if it exists, otherwise returns nil.

PropertyCollection:Get( propertyName )

string propertyName

The name of the property to find

Gets the value of the property with the specified name if it exists, otherwise this will create the new property with the default value and return that value.

PropertyCollection:GetEx( propertyName, defaultValue )

string propertyName

The name of the property to find

The value to be returned when the property is not found

Sets the value of the property with the specified name if it exists, otherwise creates it with the set value.

PropertyCollection:Set( propertyName, propertyValue )

string propertyName

The name of the property to set or create

The value to set for the property

Checks to see whether a property with the specified name exists.

PropertyCollection:HasProperty( propertyName )

string propertyName

The name of the property to check for

Returns the number of properties in the collection. This does not include children collections.

PropertyCollection:GetCount(  )

Gets the property at the specified index.

PropertyCollection:GetAt( index )

number index

The index to return from the collection