Skip to main content

class LightshipMapsSystem

(Niantic.Lightship.Maps.Core.LightshipMapsSystem)

Overview​

class LightshipMapsSystem {
    public:
        // properties
    
        ILightshipMapsSystem?? Instance;

        // methods
    
        static ILightshipMapsSystem Initialize(
            string dataDirectory,
            string lightshipApiKey,
            string gameName = null,
            string labelLanguage = null,
            Version clientVersion = null
        );
    };

Detailed Documentation​

Properties​

Instance​

ILightshipMapsSystem?? Instance

An instance of the ILightshipMapsSystem singleton. NOTE: The Initialize method needs to be called first.

    Parameters:

    LightshipMapsSystemNotInitializedException - Thrown if this property is accessed before calling Initialize

Methods​

Initialize​

static ILightshipMapsSystem Initialize(
        string dataDirectory,
        string lightshipApiKey,
        string gameName = null,
        string labelLanguage = null,
        Version clientVersion = null
    )

Initializes the map tile system. This should be called once at startup.

    Parameters:

    dataDirectory - A local directory where cached map tile data will be stored.

    lightshipApiKey - An API key associated with this project's Lightship account.

    gameName - The name of this game or app, which should match its maptile URL. For projects that haven't been assigned a static maptile URL yet, omit this parameter to use the default.

    labelLanguage - An optional ISO 639-1 language code specifying which language will be returned from label strings, if available.

    clientVersion - An optional semantic versioning style build number with major, minor, and patch versions (eg 1.2.3)

    LightshipMapsSystemAlreadyInitializedException - Thrown if this method is called after LightshipMapsSystem has already been initialized. This guarantees that there is only one instance of this singleton class.