public class GamePropertyEventArgs<T> : GamePropertyEventArgs

Public Class GamePropertyEventArgs(Of T)
	Inherits GamePropertyEventArgs

generic<typename T>
public ref class GamePropertyEventArgs : public GamePropertyEventArgs

type GamePropertyEventArgs<'T> =  
    class
        inherit GamePropertyEventArgs
    end

Type Parameters

T

The type of the game object property value.

These type of event arguments are passed to event handlers when the value of a game object property changes. This class stores the OldValue and the NewValue of the property. Event handlers of the Changing can set the CoercedValue to coerce the property to a corrected value. CoercedValue is not used in Changed events.

In detail: When the user calls a SetValue method of a GameObject the Changing event is raised (unless the new value is the same as the current property value). The OldValue of the event arguments is set to the current property value. NewValue and CoercedValue are set to the value that was specified in SetValue. The Changing event handlers can change the CoercedValue. After all Changing event handlers have been called the property value is set to the CoercedValue. After that, if the CoercedValue is different from the OldValue, the Changed event is raised. In the event arguments the OldValue is the same as in the Changing event. NewValue is set to the new property value (which is the coerced value). CoercedValue is not used in Changed events.

Important: Event handlers of the Changing and Changed events should not directly change the game object property using a SetValue method. This can result in unexpected behavior. The CoercedValue property of this event arguments can be used instead.

Reference