phaser - v4.0.0-rc.4
    Preparing search index...

    Type Alias CreateFromObjectLayerConfig

    type CreateFromObjectLayerConfig = {
        classType?: Function;
        container?: GameObjects.Container;
        frame?: string | number;
        gid?: number;
        id?: number;
        ignoreTileset?: boolean;
        key?: string | Textures.Texture;
        name?: string;
        scene?: Scene;
        type?: string;
    }
    Index

    Properties

    classType? container? frame? gid? id? ignoreTileset? key? name? scene? type?

    Properties

    classType?: Function

    A custom class type to convert the objects in to. The default is Phaser.GameObjects.Sprite. A custom class should resemble Sprite or Image; see Phaser.Types.Tilemaps.CreateFromObjectsClassTypeConstructor.

    container?: GameObjects.Container

    Optional Container to which the Game Objects are added.

    frame?: string | number

    Optional name or index of the frame within the Texture. If omitted, the tileset index is used, assuming that spritesheet frames exactly match tileset indices & geometries -- if available.

    gid?: number

    An Object GID to convert.

    id?: number

    A unique Object ID to convert.

    ignoreTileset?: boolean

    By default, gid-based objects copy properties and respect the type of the tile at that gid and treat the object as an override. If this is true, they don't, and use only the fields set on the object itself.

    key?: string | Textures.Texture

    Optional key of a Texture to be used, as stored in the Texture Manager, or a Texture instance. If omitted, the object's gid's tileset key is used if available.

    name?: string

    An Object Name to convert.

    scene?: Scene

    A Scene reference, passed to the Game Objects constructors.

    type?: string

    An Object Type to convert.

    Settings

    Member Visibility

    On This Page

    Properties