public enum NullWorldCellError
Specifies the error that causes a World Cell to be null, when using one of the World Cell retrieval methods on the World, or when accessing the WorldCellPlayerIsIn in an CellPlayerIsInChangedEventArgs object.
| Name | Value | Description |
|---|---|---|
| None | 0 | Indicates there is no error, which means the World Cell was retrieved. |
| CellOutOfBounds | 1 | Indicates that the Endless Grid Cell used to retrieve the World Cell was out of bounds. This can only happen if one or more axes are not set to repeating/endless. |
| CellDisabled | 2 | Indicates there is no error, which means the World Cell was retrieved. |
| CellHasNoUsers | 3 | Indicates that the World Cell could not be retrieved because there are no users of that World Cell. The Active Grid automatically updates the World on which cells it is making use of. If not using an Active Grid, you will need to manually add and remove users for Cells, or make use of World Regions. |
| DesyncedFromWorld | 4 | Indicates that World Cell could not be retrieved because the Active Grid has been desynced from the World. This error is only used with CellPlayerIsInChangedEventArgs objects. |
| PlayerOutsideOfZone | 5 | Indicates that World Cell could not be retrieved because the Player is outside the boundaries of the indicated Zone, and thus not in any Cells. |
| NotAllWorldCellsActivated | 6 |
Indicates that the World Cell could not be retrieved because the World has not loaded
all World Cells.
This may happen in two scenarios.
The first is if you are attempting to retrieve the World Cell before SAM has been initialized via the SAMInitializer component. The second is if the World is currently performing an update, during the update the cell you are trying to access may have already been removed from SAM (even though the chunks may still be in the scene), or the cell may not have had a chance to load yet. You can use the World's IsZoneGroupingUpdatingCells method to determine if this is the case. |
| WorldUpdating | 7 | Indicates that the World Cell might not have been retrieved because the World is in the middle of an update, and the World Cell may have already been removed from the World's internal collection of Cells (even though its asset chunks are still present in the scene), or it may have yet to be added to the collection. |