Skip to main content

interface ILightshipMapsSystem

(Niantic.Lightship.Maps.Core.ILightshipMapsSystem)

Overview​

This interface is the primary entrypoint into the Maps SDK's Maps.Core library. The LightshipMapsSystem class is meant to be a singleton, and is typically initialized once when a game or game session is starting and shut down when it finishes, although it may be shut down and re-initialized during a game session in special cases where disabling this system or performing a full, forced refresh is required.

    interface ILightshipMapsSystem: IDisposable {
        // properties
    
        bool IsIdle;

        // methods
    
        IMapView CreateMapView();
        void Shutdown();
    };

Detailed Documentation​

This interface is the primary entrypoint into the Maps SDK's Maps.Core library. The LightshipMapsSystem class is meant to be a singleton, and is typically initialized once when a game or game session is starting and shut down when it finishes, although it may be shut down and re-initialized during a game session in special cases where disabling this system or performing a full, forced refresh is required.

Properties​

IsIdle​

bool IsIdle

True if there are no pending MapTile fetch requests.

Methods​

CreateMapView​

IMapView CreateMapView()

Creates a new IMapView, which represents a viewable area of the map.

    Returns:

    A new IMapView

Shutdown​

void Shutdown()

Shuts the maptile system down. This should be called once at shutdown to release all resources and join any running threads. Note: This method is equivalent to Dispose(). Calling either one is sufficient, and both can be called safely.