Interface MapTextureProvider

The base class for specialized Texture providers. Can be accessed through Texture.control.

interface MapTextureProvider {
    location: LocationAsset;
    onFailed: event0<void>;
    onReady: event0<void>;
    getAspect(): number;
    getHeight(): number;
    getLoadStatus(): LoadStatus;
    getTypeName(): string;
    getWidth(): number;
    isOfType(type: string): boolean;
    isSame(other: ScriptObject): boolean;
}

Hierarchy (view full)

Properties

location onFailed onReady

Methods

getAspect getHeight getLoadStatus getTypeName getWidth isOfType isSame

Properties

location

location: LocationAsset

The location asset associated with the MapTextureProvider.

ReadonlyonFailed

onFailed: event0<void>

A function that gets called when location data fails to download.

ReadonlyonReady

onReady: event0<void>

A function that gets called when location data is downloaded.

Methods

getAspect

  • getAspect(): number

  • Returns the texture's aspect ratio, which is calculated as width / height.

    Returns number

getHeight

getLoadStatus

getTypeName

getWidth

  • getWidth(): number

  • Returns the width of the texture in pixels.

    Returns number

isOfType

  • isOfType(type): boolean

  • Returns true if the object matches or derives from the passed in type.

    Parameters

    • type: string

    Returns boolean

isSame

  • isSame(other): boolean

  • Returns true if this object is the same as other. Useful for checking if two references point to the same thing.

    Parameters

    Returns boolean

Settings

Member Visibility

On This Page

Properties
Methods