Template:VisuMZ Visual Fogs Plugin Commands

From Yanfly.moe Wiki
Jump to navigation Jump to search

The following are Plugin Commands that come with this plugin. They can be accessed through the Plugin Command event command.

---

Fog Plugin Commands

---

VisualFogs Preview1.gif

VisualFogs Command1.png

Fog: Add/Change Settings
- Add/Change settings for target fog.
- Does not alter the map editor's fog.

  Required:

    ID:
    - What is the ID of this fog to be added/changed?

    Filename:
    - What is the filename of the fog?

  Optional Settings:

    Scrolling:

      Map Lock?:
      - Lock the fog to the map's scrolling?
      - Automatically enable if the filename starts with "!"

      Loop Horizontally?:
      - Loop the fog horizontally?
      - Does not work with Map Lock enabled.

        Scroll:
        - What is the horizontal scroll speed?
        - Use a negative value to invert the direction.

      Loop Vertically?:
      - Loop the fog vertically?
      - Does not work with Map Lock enabled.

        Scroll:
        - What is the vertical scroll speed?
        - Use a negative value to invert the direction.

    Appearance:

      Opacity:
      - What is the opacity level for this fog?
      - You may use JavaScript code.

      Blend Mode:
      - What kind of blend mode do you wish to apply to the fog?
      - You may use JavaScript code.
        - Normal
        - Additive
        - Multiply
        - Screen

      Hue:
      - Do you wish to adjust this fog's hue?
      - You may use JavaScript code.

      Hue Shift:
      - How much do you want the hue to shift each frame?
      - You may use JavaScript code.

      Color Tone:
      - What tone do you want for the fog?
      - Format: [Red, Green, Blue, Gray]

    Location:

      Regions:
      - Which regions will show this fog?
      - Does not work with 0. Leave empty to ignore.

      Terrain Tags:
      - Which terrain tags will show this fog?
      - Does not work with 0. Leave empty to ignore.

      Tile Blur:
      - What's the blur level you wish to use for tiles?
      - You may use JavaScript code.

      Tile Spill:
      - What's the spill amount you wish to use for tiles?
      - You may use JavaScript code.

    Vignette:

      Type:
      - What vignette do you want to use for this fog?
      - This will override location settings.

      Custom:
      - Do you wish to use a custom vignette instead?
      - Automatically changes the type to "Custom".

---

VisualFogs Preview3.gif

VisualFogs Command2.png

Fog: Fade Opacity
- Fades the target fog(s) opacity to a different value.

  ID(s):
  - Target which fog(s)?
  - Cannot target the map editor's fog.

  Target Opacity:
  - What opacity level to this value (0-255).
  - You may use JavaScript code to determine the value.

  Duration:
  - How many frames should this change take?
  - You may use JavaScript code to determine the value.

---

VisualFogs Command3.png

Fog: Remove
- Removes target fog(s).

  ID(s):
  - Remove which fog(s)?
  - Cannot remove the map editor's fog.

---