GameProperty(T) Structure

GamePropertyT Structure

Represents a property of a GameObject

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

Syntax

C++

Copy

public struct GameProperty<T> : IGameProperty, 
	INamedObject, IEquatable<GameProperty<T>>

Public Structure GameProperty(Of T)
	Implements IGameProperty, INamedObject, IEquatable(Of GameProperty(Of T))

generic<typename T>
public value class GameProperty : IGameProperty, 
	INamedObject, IEquatable<GameProperty<T>>

[<SealedAttribute>]
type GameProperty<'T> =  
    struct
        interface IGameProperty
        interface INamedObject
        interface IEquatable<GameProperty<'T>>
    end

Type Parameters

T: The type of the property value.

The GamePropertyT type exposes the following members.

Methods

	Name	Description
	AsAnimatable	Returns an IAnimatablePropertyT that can be used to animate this GamePropertyT.
	Equals(Object)	Determines whether the specified Object is equal to this instance. (Overrides ValueTypeEquals(Object).)
	Equals(GamePropertyT)	Indicates whether the current object is equal to another object of the same type.
	GetHashCode	Returns a hash code for this instance. (Overrides ValueTypeGetHashCode.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	Parse	Parses the specified string and updates the Value.
	Reset	Removes any local values and sets the property to its default value.
	ToString	Returns the fully qualified type name of this instance. (Inherited from ValueType.)

Top

Operators

	Name	Description
	Equality	Compares two GamePropertyTs to determine whether they are the same.
	(GamePropertyT to T)	Returns the value of the specified GamePropertyT.
	Inequality	Compares two GamePropertyTs to determine whether they are different.

Top

Properties

	Name	Description
	Change	Event handler that automatically changes the value of the property.
	HasLocalValue	Gets a value indicating whether this property has a local value.
	Metadata	Gets the property metadata.
	Name	Gets the name.
	Owner	Gets the game object that owns this property.
	Value	Gets or sets the value.

Top

Events

	Name	Description
	Changed	Occurs when the Value changed.
	Changing	Occurs when the Value is about to change.

Top

Explicit Interface Implementations

	Name	Description
	IGamePropertyMetadata	Gets the property metadata.
	IGamePropertyValue	Gets or sets the value.

Top

Remarks

Animation: Game objects and their game object properties can be animated using the DigitalRune Animation system. In order to animate a specific property AsAnimatable needs to be called. This method returns an IAnimatablePropertyT for the given property which can be passed to the animation system.

Reference

DigitalRune.Game Namespace