gameforge - v0.1.12
    Preparing search index...

    Class ArrayResource

    A resource that contains a number of sources.

    PIXI

    Hierarchy (View Summary)

    Index

    Constructors

    • Parameters

      • source: number | any[]

        Number of items in array or the collection of image URLs to use. Can also be resources, image elements, canvas, etc.

      • Optionaloptions: ISize

        Options to apply to PIXI.autoDetectResource

        • height: number
        • width: number

      Returns ArrayResource

    Properties

    _height: number

    Internal height of the resource.

    _width: number

    Internal width of the resource.

    baseTexture: BaseTexture

    Bound baseTexture, there can only be one.

    destroyed: boolean

    If resource has been destroyed.

    false
    
    internal: boolean

    true if resource is created by BaseTexture useful for doing cleanup with BaseTexture destroy and not cleaning up resources that were created externally.

    itemDirtyIds: number[]

    Dirty IDs for each part.

    Collection of partial baseTextures that correspond to resources.

    length: number

    Number of elements in array.

    src: string

    The url of the resource

    Accessors

    • get height(): number

      The height of the resource.

      Returns number

    • get valid(): boolean

      Has been validated

      Returns boolean

    • get width(): number

      The width of the resource.

      Returns number

    Methods

    • Set a baseTexture by ID, ArrayResource just takes resource from it, nothing more

      Parameters

      • baseTexture: BaseTexture
      • index: number

        Zero-based index of resource to set

      Returns this

      • Instance for chaining
    • Set a resource by ID

      Parameters

      • resource: Resource
      • index: number

        Zero-based index of resource to set

      Returns this

      • Instance for chaining
    • Call when destroying resource, unbind any BaseTexture object before calling this method, as reference counts are maintained internally.

      Returns void

    • Destroy this BaseImageResource.

      Returns void

    • Used from ArrayResource and CubeResource constructors.

      Parameters

      • resources: any[]

        Can be resources, image elements, canvas, etc. , length should be same as constructor length

      • Optionaloptions: IAutoDetectOptions

        Detect options for resources

      Returns void

    • Trigger a resize event

      Parameters

      • width: number

        X dimension

      • height: number

        Y dimension

      Returns void

    • Set the style, optional to override

      Parameters

      Returns boolean

      • true is success
    • Unset the parent base texture.

      Parameters

      Returns void

    • Has been updated trigger event.

      Returns void

    • Abstract, used to auto-detect resource type.

      Parameters

      • _source: unknown

        The source object

      • Optional_extension: string

        The extension of source, if set

      Returns boolean