Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This class is created by calling BeginTransientXPropertyUpdate. It exists to represent represents a “live change” being made to a property. As such, it can repeatedly be given new data, none of which will end up in the final Journal until you call Finish().

There is logic lower down in this system to limit the rate at which messages are sent to the server. This means if you are calling UpdateWithNewData every frame, remote users will not see nearly that many updates. Doing this so preserves network performance and makes it so you don’t prevents the need to limit yourself when giving changes to this object.

- Functions

Function Name

Description

UpdateWithNewData

Sends a new Transient Update updating this object’s Property to the new value.

Finish

Ends the Transient calls and Posts a final value to the journal. This object will no longer be usable once this is called.

Cancel

Cancels the Transient to make it appear like this never happened. Nothing will end up in the Journal. This object will no longer be usable once this is called.

- Sample

See: BeginTransientXPropertyUpdate