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

    ListCompositor

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    The manager that owns this RenderNode.

    name: string

    The name of the RenderNode.

    Methods

    • By default this is an empty method hook that you can override and use in your own custom render nodes.

      This method is called at the start of the run method. Don't forget to call it in your custom method.

      Parameters

      Returns void

    • By default this is an empty method hook that you can override and use in your own custom render nodes.

      This method is called at the end of the run method. Don't forget to call it in your custom method.

      Parameters

      Returns void

    • Render each child in the display list.

      This allocates a new DisplayContext if a child's blend mode is different from the previous child. This will start a new batch if one is in progress.

      Parameters

      • displayContext: DrawingContext

        The context currently in use.

      • children: GameObject[]

        The list of children to render.

      • OptionalparentTransformMatrix: TransformMatrix

        This transform matrix is defined if the game object is nested

      • OptionalrenderStep: number

        Which step of the rendering process is this? This is the index of the currently running function in a list of functions. Default 0.

      Returns void

    • Run the RenderNode. This is a stub method that should be overridden by the specific implementation.

      This method may be wrapped by setDebug.

      Parameters

      • ...args: any[]

        Arguments to pass to the node. These will vary depending on the node.

      Returns void

    • Set whether the node should report debug information. It wraps the run method with additional debug information.

      Parameters

      • debug: boolean

        Whether to report debug information.

      Returns void