public sealed class CellPlayerIsInChangedEventArgs : EventArgs
Event Args for CellPlayerIsInChanged event (an event of the Active Grid class).
Name | Type | Description |
---|---|---|
CausedByDesync | bool |
Gets a value indicating whether this event was triggered by the Active Grid desyncing
from a World. When this is true, the WorldCellPlayerIsIn will be null
and EndlessGridCellPlayerIsIn/StreamableGridCellPlayerIsIn values will be invalid.
Basically, you should think of the Cell the player is in as no cell in this case.
|
EndlessGridCellPlayerIsIn | Cell |
Gets the cell the player is in as projected on an Endless Grid of cells. |
GroupingIndex | int |
The index grouping that this event is firing for. You can use this to filter out events for groupings you do not care about. |
ReasonForNullWorldCell | string |
When WorldCellPlayerIsIn is null, this property can be used to get the reason for why it is null, which can be useful for debugging purposes. |
StreamableGridCellPlayerIsIn | Cell |
Gets the cell the player is in as it lies on the Streamable Grid associated with the World. |
World | World |
Gets the World associated with the Active Grid this event was triggered on, if one exists. |
WorldCellPlayerIsIn | WorldCell |
Gets the World Cell the player is Currently in, if one exists. A World Cell exists only when the World has objects loaded for that cell. |