Hierarchy

  • IWorldRendererEvents

Methods

  • Called when calculating creatures in the viewport

    Returns

    False if the player should not see the creature or undefined to use the default logic

    Parameters

    • creature: default

      The creature object

    • tile: default

      The tile the creature is on

    Returns undefined | boolean

  • Called when calculating npcs in the viewport

    Returns

    False if the player should not see the npc or undefined to use the default logic

    Parameters

    Returns undefined | boolean

  • Called when rendering creatures in the viewport

    Returns

    The batch layer the creature should render in or undefined to use the default logic

    Parameters

    Returns undefined | SpriteBatchLayer

  • Called when initializing each sprite batch layer.

    Returns

    The number of sprites that can be rendered at one time on this layer

    Parameters

    • maxSprites: number

      The default number of sprites that can be rendered at one time on this layer

    • layer: SpriteBatchLayer

      The SpriteBatchLayer that is being initialized

    Returns number

  • Caller after post processing the world render

    Returns void

  • Caller after rendering the world

    Parameters

    • tileScale: number

      The tile scale

    • viewWidth: number

      The width of the view port

    • viewHeight: number

      The height of the view port

    Returns void

  • Caller before post processing the world render

    Returns void

  • Called before rendering the world

    Parameters

    • tileScale: number

      The tile scale

    • viewWidth: number

      The width of the view port

    • viewHeight: number

      The height of the view port

    • timeStamp: number

      The animation frame timestamp

    Returns void

  • Called when rendering the overlay

    Parameters

    • spriteBatch: default

      The overlay sprite batch

    Returns void

  • Called when different object types are rendered

    Returns

    A bitwise list of render flags or undefined to use the default logic

    Returns undefined | RenderFlag

  • Called when the zoom level is changed.

    Parameters

    • zoom: number
    • oldZoom: number

    Returns any

Generated using TypeDoc