Function SetFogStateRect

  • Sets target player's fog of war data in the specified rectangle.

    Individual player's fog state is a reflection of player's map exploration progress: which areas were explored or still hidden; which are fogged (not visible); which are visible. What is visible in game is a combination of personal fog state & fog modifiers.

    Parameters

    • forWhichPlayer: Player<PlayerEventMap>

      Target player.

    • whichState: HandleHolder<"fogstate">

      Change fog to this type. See fogstate for type explanation.

    • where: HandleHolder<"rect">

      Target rectangle area.

    • useSharedVision: boolean

      If true, apply new state to player and whoever player shares their vision. If false, apply only to player themself.

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc