WorldSyncedToChangedEventArgs Class

public sealed class WorldSyncedToChangedEventArgs : EventArgs

Event Args for a WorldSyncedToChanged event (an event of the Active Grid class).

This is fired when the Active Grid is first initialized and syncs to a World, or when you manually change the World via the API. In addition to containing references to the old and new World, it also contains the starting world cells for the player, for each layer on the new world. Using this in conjuction with the CellPlayerIsInChanged event will allow you to fully track which cell the player is in for one or all layers.

Please note, any reference values stored in this event are immedidately nulled out after all listeners have been notified of the event, therefore, if you wish to reference the objects after your listener method has been called, you will need to save a reference to the object(s) yourself.

Properties

Name Type Description
NewWorld World

Gets the new World that the Active Grid is now synced to. If this is null, you should not try to use the GetWorldCellPlayerIsStartingIn and GetEndlessGridCellPlayerIsStartingIn methods, as they will not be set.

OldWorld World

Gets the old World that the Active Grid was synced to.

SyncedGroupingInfo ReadOnlyList<SyncedGroupingInfo>

Provides information about each Active Grid Grouping Synced to the New World. If New World is null (which can happen when the event is fired for a desync operation), this will return null, so you sould check if New World is null before iterating over this collection!