GamePropertyCollection Structure

Manages a collection of game object properties.

Namespace: DigitalRune.Game
Assembly: DigitalRune.Game (in DigitalRune.Game.dll) Version: 1.4.0.0 (1.4.0.14427)

Syntax

C++

Copy

public struct GamePropertyCollection : IEnumerable<IGameProperty>, 
	IEnumerable, IEquatable<GamePropertyCollection>

Public Structure GamePropertyCollection
	Implements IEnumerable(Of IGameProperty), IEnumerable, 
	IEquatable(Of GamePropertyCollection)

public value class GamePropertyCollection : IEnumerable<IGameProperty^>, 
	IEnumerable, IEquatable<GamePropertyCollection>

[<SealedAttribute>]
type GamePropertyCollection =  
    struct
        interface IEnumerable<IGameProperty>
        interface IEnumerable
        interface IEquatable<GamePropertyCollection>
    end

The GamePropertyCollection type exposes the following members.

Methods

	Name	Description
	AddT(Int32)	Adds a property with the given ID.
	AddT(String)	Adds a property with with the given name.
	AddT(GamePropertyMetadataT)	Adds a property for the given metadata.
	Equals(Object)	Determines whether the specified Object is equal to this instance. (Overrides ValueTypeEquals(Object).)
	Equals(GamePropertyCollection)	Indicates whether the current object is equal to another object of the same type.
	GetT(Int32)	Gets the property with the given ID.
	GetT(String)	Gets the property with the given name.
	GetT(GamePropertyMetadataT)	Gets the property for the given metadata.
	GetEnumerator	Returns an enumerator that iterates through the collection.
	GetHashCode	Returns a hash code for this instance. (Overrides ValueTypeGetHashCode.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	Remove(Int32)	Removes the property with the given ID.
	Remove(IGamePropertyMetadata)	Removes the property for the given metadata.
	RemoveT(String)	Removes the property with the given name.
	ToString	Returns the fully qualified type name of this instance. (Inherited from ValueType.)

Top

Operators

	Name	Description
	Equality	Compares two GamePropertyCollections to determine whether they are the same.
	Inequality	Compares two GamePropertyCollections to determine whether they are different.

Top

Extension Methods

	Name	Description
	DoIGameProperty(ActionIGameProperty)	Overloaded. Performs the given action on each element in a sequence when it is enumerated. (Defined by LinqHelper.)
	DoIGameProperty(ActionIGameProperty, Int32)	Overloaded. Performs the given action on each element (incorporating its index) in a sequence when it is enumerated. (Defined by LinqHelper.)
	ForEachIGameProperty(ActionIGameProperty)	Overloaded. Immediately performs the given action on each element in a sequence. (Defined by LinqHelper.)
	ForEachIGameProperty(ActionIGameProperty, Int32)	Overloaded. Immediately performs the given action on each element (incorporating its index) in a sequence. (Defined by LinqHelper.)
	IndexOfIGameProperty	Returns the index of the first element in a sequence that satisfies the specified condition. (Defined by LinqHelper.)

Top

Properties

	Name	Description
	Owner	Gets the game object that owns this collection.

Top

Explicit Interface Implementations

	Name	Description
	IEnumerableGetEnumerator	Returns an enumerator that iterates through the collection.

Top

Remarks

This collection implements IEnumerableT, but enumerating the collection allocates heap memory (garbage!) and should only be used in game editors and not in performance critical paths of a game.

Reference

DigitalRune.Game Namespace