PokéRogue
    Preparing search index...
    • Takes an array of Game Objects, or any objects that have the public property depth, and then sets it to the given value. The depth property controls the rendering order of Game Objects within a Scene: objects with higher depth values are rendered on top of those with lower values.

      The optional step property is applied incrementally, multiplied by each item in the array.

      To use this with a Group: SetDepth(group.getChildren(), value, step)

      Type Parameters

      Parameters

      • items: G

        The array of items to be updated by this action.

      • value: number

        The depth value to assign to each item.

      • Optionalstep: number

        This is added to the value amount, multiplied by the iteration counter. Default 0.

      • Optionalindex: number

        An optional offset to start searching from within the items array. Default 0.

      • Optionaldirection: number

        The direction to iterate through the array. 1 is from beginning to end, -1 from end to beginning. Default 1.

      Returns G

      The array of objects that were passed to this Action.