GameEventCollection Structure

Manages a collection of game object events.

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

Syntax

C++

Copy

public struct GameEventCollection : IEnumerable<IGameEvent>, 
	IEnumerable, IEquatable<GameEventCollection>

Public Structure GameEventCollection
	Implements IEnumerable(Of IGameEvent), IEnumerable, 
	IEquatable(Of GameEventCollection)

public value class GameEventCollection : IEnumerable<IGameEvent^>, 
	IEnumerable, IEquatable<GameEventCollection>

[<SealedAttribute>]
type GameEventCollection =  
    struct
        interface IEnumerable<IGameEvent>
        interface IEnumerable
        interface IEquatable<GameEventCollection>
    end

The GameEventCollection type exposes the following members.

Methods

	Name	Description
	AddT(Int32)	Adds an event with the given ID.
	AddT(String)	Adds an event with the given name.
	AddT(GameEventMetadataT)	Adds an event for the given metadata.
	Equals(Object)	Determines whether the specified Object is equal to this instance. (Overrides ValueTypeEquals(Object).)
	Equals(GameEventCollection)	Indicates whether the current object is equal to another object of the same type.
	GetT(Int32)	Gets the event with the given ID.
	GetT(String)	Gets the event with the given name.
	GetT(GameEventMetadataT)	Gets the event 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 event with the given ID.
	Remove(IGameEventMetadata)	Removes the event for the given metadata.
	RemoveT(String)	Removes the event with the given name.
	ToString	Returns the fully qualified type name of this instance. (Inherited from ValueType.)

Top

Operators

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

Top

Extension Methods

	Name	Description
	DoIGameEvent(ActionIGameEvent)	Overloaded. Performs the given action on each element in a sequence when it is enumerated. (Defined by LinqHelper.)
	DoIGameEvent(ActionIGameEvent, Int32)	Overloaded. Performs the given action on each element (incorporating its index) in a sequence when it is enumerated. (Defined by LinqHelper.)
	ForEachIGameEvent(ActionIGameEvent)	Overloaded. Immediately performs the given action on each element in a sequence. (Defined by LinqHelper.)
	ForEachIGameEvent(ActionIGameEvent, Int32)	Overloaded. Immediately performs the given action on each element (incorporating its index) in a sequence. (Defined by LinqHelper.)
	IndexOfIGameEvent	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