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

    Class Bob

    A Bob Game Object.

    A Bob belongs to a Blitter Game Object. The Blitter is responsible for managing and rendering this object.

    A Bob has a position, alpha value and a frame from a texture that it uses to render with. You can also toggle the flipped and visible state of the Bob. The Frame the Bob uses to render can be changed dynamically, but it must be a Frame within the Texture used by the parent Blitter.

    Bob positions are relative to the Blitter parent. So if you move the Blitter parent, all Bob children will have their positions impacted by this change as well.

    You can manipulate Bob objects directly from your game code, but the creation and destruction of them should be handled via the Blitter parent.

    Index

    Constructors

    constructor

    Properties

    alpha data flipX flipY frame parent tint visible x y

    Methods

    destroy reset resetFlip setAlpha setFlip setFlipX setFlipY setFrame setPosition setTint setVisible

    Constructors

    • Parameters

      • blitter: Blitter

        The parent Blitter object is responsible for updating this Bob.

      • x: number

        The horizontal position of this Game Object in the world, relative to the parent Blitter position.

      • y: number

        The vertical position of this Game Object in the world, relative to the parent Blitter position.

      • frame: string | number

        The Frame this Bob will render with, as defined in the Texture the parent Blitter is using.

      • visible: boolean

        Should the Bob render visible or not to start with?

      Returns Bob

    Properties

    alpha: number

    The alpha value of the Bob, between 0 and 1.

    A Bob with alpha 0 will skip rendering.

    data: object

    A blank object which can be used to store data related to this Bob in.

    flipX: boolean

    The horizontally flipped state of the Bob. A Bob that is flipped horizontally will render inversed on the horizontal axis. Flipping always takes place from the middle of the texture.

    flipY: boolean

    The vertically flipped state of the Bob. A Bob that is flipped vertically will render inversed on the vertical axis (i.e. upside down) Flipping always takes place from the middle of the texture.

    frame: Frame

    The frame that the Bob uses to render with. To change the frame use the Bob.setFrame method.

    parent: Blitter

    The Blitter object that this Bob belongs to.

    tint: number

    The tint value of this Bob.

    visible: boolean

    The visible state of the Bob.

    An invisible Bob will skip rendering.

    x: number

    The x position of this Bob, relative to the x position of the Blitter.

    y: number

    The y position of this Bob, relative to the y position of the Blitter.

    Methods

    • Destroys this Bob instance. Removes itself from the Blitter and clears the parent, frame and data properties.

      Returns void

    • Resets this Bob.

      Changes the position to the values given, and optionally changes the frame.

      Also resets the flipX and flipY values, sets alpha back to 1 and visible to true.

      Parameters

      • x: number

        The x position of the Bob. Bob coordinate are relative to the position of the Blitter object.

      • y: number

        The y position of the Bob. Bob coordinate are relative to the position of the Blitter object.

      • Optionalframe: string | number | Frame

        The Frame the Bob will use. It must be part of the Texture the parent Blitter object is using.

      Returns this

    • Resets the horizontal and vertical flipped state of this Bob back to their default un-flipped state.

      Returns this

    • Set the Alpha level of this Bob. The alpha controls the opacity of the Game Object as it renders. Alpha values are provided as a float between 0, fully transparent, and 1, fully opaque.

      A Bob with alpha 0 will skip rendering.

      Parameters

      • value: number

        The alpha value used for this Bob. Between 0 and 1.

      Returns this

    • Sets the horizontal and vertical flipped state of this Bob.

      Parameters

      • x: boolean

        The horizontal flipped state. false for no flip, or true to be flipped.

      • y: boolean

        The horizontal flipped state. false for no flip, or true to be flipped.

      Returns this

    • Sets the horizontal flipped state of this Bob.

      Parameters

      • value: boolean

        The flipped state. false for no flip, or true to be flipped.

      Returns this

    • Sets the vertical flipped state of this Bob.

      Parameters

      • value: boolean

        The flipped state. false for no flip, or true to be flipped.

      Returns this

    • Changes the Texture Frame being used by this Bob. The frame must be part of the Texture the parent Blitter is using. If no value is given it will use the default frame of the Blitter parent.

      Parameters

      • Optionalframe: string | number | Frame

        The frame to be used during rendering.

      Returns this

    • Changes the position of this Bob to the values given.

      Parameters

      • x: number

        The x position of the Bob. Bob coordinate are relative to the position of the Blitter object.

      • y: number

        The y position of the Bob. Bob coordinate are relative to the position of the Blitter object.

      Returns this

    • Sets the tint of this Bob.

      Parameters

      • value: number

        The tint value used for this Bob. Between 0 and 0xffffff.

      Returns this

    • Sets the visibility of this Bob.

      An invisible Bob will skip rendering.

      Parameters

      • value: boolean

        The visible state of the Game Object.

      Returns this

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods