Irina: /* Light-Related Sub Settings */

2022-03-24T15:09:44Z

‎Light-Related Sub Settings

Irina: /* Light-Related Sub Settings */

2022-03-12T03:04:10Z

‎Light-Related Sub Settings

Irina: /* Spawn Light Plugin Commands */

2022-03-12T03:02:44Z

‎Spawn Light Plugin Commands

Irina: /* Conical Offset Plugin Commands */

2022-03-12T02:59:52Z

‎Conical Offset Plugin Commands

Irina: /* Conical Light Plugin Commands */

2022-03-12T02:59:46Z

‎Conical Light Plugin Commands

Irina: /* Radial Light Plugin Commands */

2022-03-12T02:59:26Z

‎Radial Light Plugin Commands

Irina: /* Battle Light Plugin Commands */

2022-03-12T02:59:13Z

‎Battle Light Plugin Commands

Irina: /* Overlay Plugin Commands */

2022-03-12T02:58:56Z

‎Overlay Plugin Commands

Irina: Created page with "VisuMZ Lighting Effects Plugin Commands The following are Plugin Commands that come with this plugin. They can be accesse..."

2022-03-12T02:33:01Z

Created page with "<noinclude>VisuMZ Lighting Effects Plugin Commands</noinclude> The following are Plugin Commands that come with this plugin. They can be accesse..."

New page

<noinclude>[[Category:Display templates|VisuMZ Lighting Effects Plugin Commands]]</noinclude>
The following are Plugin Commands that come with this plugin. They can be
accessed through the Plugin Command event command.

---

=== Overlay Plugin Commands ===

---

<pre>
OVERLAY: Change to Preset Color
- Change current darkness overlay to a preset color and opacity level.

Color:
- Pick a preset color.
- This will also come with predetermined opacity values.

Duration:
- What is the duration of the color change?
</pre>

---

<pre>
OVERLAY: Change to Custom Color
- Change current darkness overlay to a custom color.

Color:
- Custom color.
- This uses #rrggbb format.
- Check your color here: https://htmlcolorcodes.com/

Opacity:
- Opacity level of the color.
- Value between 0-255.
- Transparent: 0. Opaque: 255.

Duration:
- What is the duration of the color change?
</pre>

---

=== Battle Light Plugin Commands ===

---

<pre>
BATTLE LIGHT: Change Actor(s) Settings
- Change the battle-radial light settings for target(s).

Actor ID(s):
- Target actor(s) you want to change light settings for.
- You may use JavaScript code.

Settings:
- Change the radial light settings for the target(s).

Behavior:
- Change the behaviors for this radial light.

Auto-Calc Radius:
- Automatically calculates the radius size based on sprite's width/height.
</pre>

---

<pre>
BATTLE LIGHT: Change Enemy(s) Settings
- Change the battle-radial light settings for target(s).

Enemy Index(es):
- Select enemy troop index(es) to change light settings for.
- You may use JavaScript code.

Settings:
- Change the radial light settings for the target(s).

Behavior:
- Change the behaviors for this radial light.

Auto-Calc Radius:
- Automatically calculates the radius size based on sprite's width/height.
</pre>

---

=== Radial Light Plugin Commands ===

---

<pre>
RADIAL LIGHT: Change Player Settings
- Change the radial light settings for the player.

Settings:
- Change the radial light settings for the player.
- See "Radial Light Settings" section below.

Behavior:
- Change the behaviors for this radial light.
- See "Behavior" section below.
</pre>

---

<pre>
RADIAL LIGHT: Change Follower Settings
- Change the radial light settings for followers.

Settings:
- Change the radial light settings for all followers.
- See "Radial Light Settings" section below.

Behavior:
- Change the behaviors for this radial light.
- See "Behavior" section below.
</pre>

---

<pre>
RADIAL LIGHT: Change Event(s) Settings
- Change the radial light settings for target event(s).

Event ID(s):
- Target event(s) to have their light settings changed.
- Use 0 for "this event".
- You may use JavaScript code.

Settings:
- Change the radial light settings for target event(s).
- See "Radial Light Settings" section below.

Behavior:
- Change the behaviors for this radial light.
- See "Behavior" section below.
</pre>

---

<pre>
RADIAL LIGHT: Change Boat Settings
- Change the radial light settings for the boat vehicle.

Boarded:

Radial Light:
- Changed radial light settings for this vehicle.

Changed Behavior:
- What are the changed behavioral settings for these radial lights?

Unboarded:

Radial Light:
- Changed radial light settings for this vehicle.

Changed Behavior:
- What are the changed behavioral settings for these radial lights?
</pre>

---

<pre>
RADIAL LIGHT: Change Ship Settings
- Change the radial light settings for the ship vehicle.

Boarded:

Radial Light:
- Changed radial light settings for this vehicle.

Changed Behavior:
- What are the changed behavioral settings for these radial lights?

Unboarded:

Radial Light:
- Changed radial light settings for this vehicle.

Changed Behavior:
- What are the changed behavioral settings for these radial lights?
</pre>

---

<pre>
RADIAL LIGHT: Change Airship Settings
- Change the radial light settings for the airship vehicle.

Boarded:

Radial Light:
- Changed radial light settings for this vehicle.

Changed Behavior:
- What are the changed behavioral settings for these radial lights?

Unboarded:

Radial Light:
- Changed radial light settings for this vehicle.

Changed Behavior:
- What are the changed behavioral settings for these radial lights?
</pre>

---

=== Conical Light Plugin Commands ===

---

<pre>
CONICAL LIGHT: Change Player Settings
- Change the conical light settings for the player.

Settings:
- Change the conical light settings for the player.
- See "Conical Light Settings" section below.

Behavior:
- Change the behaviors for this conical light.
- See "Behavior" section below.

---

CONICAL LIGHT: Change Follower Settings
- Change the conical light settings for followers.

Settings:
- Change the conical light settings for all followers.
- See "Conical Light Settings" section below.

Behavior:
- Change the behaviors for this conical light.
- See "Behavior" section below.
</pre>

---

<pre>
CONICAL LIGHT: Change Event(s) Settings
- Change the conical light settings for target event(s).

Event ID(s):
- Target event(s) to have their light settings changed.
- Use 0 for "this event".
- You may use JavaScript code.

Settings:
- Change the conical light settings for target event(s).
- See "Conical Light Settings" section below.

Behavior:
- Change the behaviors for this conical light.
- See "Behavior" section below.
</pre>

---

<pre>
CONICAL LIGHT: Change Boat Settings
- Change the conical light settings for the boat vehicle.

Boarded:

Conical Light:
- Changed conical light settings for this vehicle.

Changed Behavior:
- What are the changed behavioral settings for these conical lights?

Unboarded:

Conical Light:
- Changed conical light settings for this vehicle.

Changed Behavior:
- What are the changed behavioral settings for these conical lights?
</pre>

---

<pre>
CONICAL LIGHT: Change Ship Settings
- Change the conical light settings for the ship vehicle.

Boarded:

Conical Light:
- Changed conical light settings for this vehicle.

Changed Behavior:
- What are the changed behavioral settings for these conical lights?

Unboarded:

Conical Light:
- Changed conical light settings for this vehicle.

Changed Behavior:
- What are the changed behavioral settings for these conical lights?
</pre>

---

<pre>
CONICAL LIGHT: Change Airship Settings
- Change the conical light settings for the airship vehicle.

Boarded:

Conical Light:
- Changed conical light settings for this vehicle.

Changed Behavior:
- What are the changed behavioral settings for these conical lights?

Unboarded:

Conical Light:
- Changed conical light settings for this vehicle.

Changed Behavior:
- What are the changed behavioral settings for these radial lights?
</pre>

---

=== Conical Offset Plugin Commands ===

---

<pre>
CONICAL OFFSET: Change Actor(s) Settings
- Change the conical light hand offset for target actor(s).

Actor ID(s):
- Target actor(s) you want to change offset settings for.
- You may use JavaScript code.

Enable:
- Change the offset settings for the target(s).

Hand Position Offsets:
- Change target(s)'s offsets used for hand positions.

VS8 Dash Offsets:
- Change target(s)'s offsets used for hand positions for VS8 sprites
while dashing.

VS8 Jump Offsets:
- Change target(s)'s offsets used for hand positions for VS8 sprites
while jumping.
</pre>

---

<pre>
CONICAL OFFSET: Change Event(s) Settings
- Change the conical light hand offset for target event(s).

Event ID(s):
- Target event(s) you want to change offset settings for.
- Use 0 for "this event".
- You may use JavaScript code.

Enable:
- Change the offset settings for the target(s).

Hand Position Offsets:
- Change target(s)'s offsets used for hand positions.

VS8 Dash Offsets:
- Change target(s)'s offsets used for hand positions for VS8 sprites
while dashing.

VS8 Jump Offsets:
- Change target(s)'s offsets used for hand positions for VS8 sprites
while jumping.
</pre>

---

<pre>
CONICAL LIGHT: Change Ship Settings
- Change the conical light hand offset for the Ship vehicle.

Boarded:

Changed Offsets:
- Changed offsets used for the "hand" positions of this vehicle.

Unboarded:

Changed Offsets:
- Changed offsets used for the "hand" positions of this vehicle.
</pre>

---

<pre>
CONICAL LIGHT: Change Airship Settings
- Change the conical light hand offset for the airship vehicle.

Boarded:

Changed Offsets:
- Changed offsets used for the "hand" positions of this vehicle.

Unboarded:

Changed Offsets:
- Changed offsets used for the "hand" positions of this vehicle.
</pre>

---

<pre>
CONICAL LIGHT: Change Boat Settings
- Change the conical light hand offset for the boat vehicle.

Boarded:

Changed Offsets:
- Changed offsets used for the "hand" positions of this vehicle.

Unboarded:

Changed Offsets:
- Changed offsets used for the "hand" positions of this vehicle.
</pre>

---

=== Spawn Light Plugin Commands ===

---

<pre>
SPAWN LIGHT: Create Light(s) at Map X/Y
- Map only!
- Create new light spawn(s) locked to the map.
- Use tile coordinates for X and Y.

Light Settings:

Settings:
- Change the radial light settings for the light spawn(s).

Bheavior:
- Change the behaviors for the light spawn(s).

Coordinates X/Y:

Origin X:
Origin Y:
- What is the origin X/Y position?
- You may use JavaScript code.

Spawn Settings:

JS: Trajectory:
- Code used to determine the trajectory of these lights.
- These will revolve around the origin X/Y position.

Initial Time:
- What is the initial time value for this light spawn(s)?
- You may use JavaScript code.

Total Spawns:
- How many light spawns should there be?
- Minimum value: 1.
- You may use JavaScript code.

Time Increment:
- What is the time increment between spawns?

Expiration Timer:
- After how many frames will light spawn(s) expire?
- Use 0 for no expiration.
- You may use JavaScript code.
</pre>

---

<pre>
SPAWN LIGHT: Create Light(s) at Screen X/Y
- Map only!
- Create new light spawn(s) locked to the screen.
- The light spawn(s) is unaffected by map scrolling.

Light Settings:

Settings:
- Change the radial light settings for the light spawn(s).

Bheavior:
- Change the behaviors for the light spawn(s).

Coordinates X/Y:

Origin X:
Origin Y:
- What is the origin X/Y position?
- You may use JavaScript code.

Spawn Settings:

JS: Trajectory:
- Code used to determine the trajectory of these lights.
- These will revolve around the origin X/Y position.

Initial Time:
- What is the initial time value for this light spawn(s)?
- You may use JavaScript code.

Total Spawns:
- How many light spawns should there be?
- Minimum value: 1.
- You may use JavaScript code.

Time Increment:
- What is the time increment between spawns?

Expiration Timer:
- After how many frames will light spawn(s) expire?
- Use 0 for no expiration.
- You may use JavaScript code.
</pre>

---

<pre>
SPAWN LIGHT: Create Light(s) on Player
- Map only!
- Create new light spawn(s) following the player.
- The light spawn(s) is unaffected by map scrolling.

Light Settings:

Settings:
- Change the radial light settings for the light spawn(s).

Bheavior:
- Change the behaviors for the light spawn(s).

Spawn Settings:

JS: Trajectory:
- Code used to determine the trajectory of these lights.
- These will revolve around the origin X/Y position.

Initial Time:
- What is the initial time value for this light spawn(s)?
- You may use JavaScript code.

Total Spawns:
- How many light spawns should there be?
- Minimum value: 1.
- You may use JavaScript code.

Time Increment:
- What is the time increment between spawns?

Expiration Timer:
- After how many frames will light spawn(s) expire?
- Use 0 for no expiration.
- You may use JavaScript code.
</pre>

---

<pre>
SPAWN LIGHT: Create Light(s) on Follower
- Map only!
- Create new light spawn(s) following the player.
- The light spawn(s) is unaffected by map scrolling.

Light Settings:

Settings:
- Change the radial light settings for the light spawn(s).

Bheavior:
- Change the behaviors for the light spawn(s).

Target:

Follower Index:
- Which follower index should the light(s) follow?
- Index starts at 0.
- You may use JavaScript code.

Spawn Settings:

JS: Trajectory:
- Code used to determine the trajectory of these lights.
- These will revolve around the origin X/Y position.

Initial Time:
- What is the initial time value for this light spawn(s)?
- You may use JavaScript code.

Total Spawns:
- How many light spawns should there be?
- Minimum value: 1.
- You may use JavaScript code.

Time Increment:
- What is the time increment between spawns?

Expiration Timer:
- After how many frames will light spawn(s) expire?
- Use 0 for no expiration.
- You may use JavaScript code.
</pre>

---

<pre>
SPAWN LIGHT: Create Light(s) on Event
- Map only!
- Create new light spawn(s) following the player.
- The light spawn(s) is unaffected by map scrolling.

Light Settings:

Settings:
- Change the radial light settings for the light spawn(s).

Bheavior:
- Change the behaviors for the light spawn(s).

Target:

Event ID:
- Which map event should the light(s) follow?
- Use 0 for "this event".
- You may use JavaScript code.

Spawn Settings:

JS: Trajectory:
- Code used to determine the trajectory of these lights.
- These will revolve around the origin X/Y position.

Initial Time:
- What is the initial time value for this light spawn(s)?
- You may use JavaScript code.

Total Spawns:
- How many light spawns should there be?
- Minimum value: 1.
- You may use JavaScript code.

Time Increment:
- What is the time increment between spawns?

Expiration Timer:
- After how many frames will light spawn(s) expire?
- Use 0 for no expiration.
- You may use JavaScript code.
</pre>

---

=== Light-Related Sub Settings ===

---

<pre>
Radial Light Settings

General:

Enabled?:
- Is this radial light enabled?

Properties:

Filename:
- Filename used for the light effect image.
- If used, ignore Color, Radius, and Intensity.
- Image will be centered on the target where the center of the image is
the anchor point and will be rotated.

Color:
- Color of the radial light in #rrggbb format.
- For generated lights only.
- Ignore if using image.

Radius:
- What is the radius of this radial light?
- For generated lights only.
- Ignore if using image.

Intensity:
- Radial light intensity. Use value between 0 & 1.
- For generated lights only.
- Ignore if using image.

Optional:

Angle:
- What is the angle of this radial light?
- Only noticeable with using images.

Rotate Speed:
- The rotation speed of this light?
- Lower: slower. Higher: faster. Negative: reverse.

Blend Mode:
- What kind of blend mode do you wish to apply to the radial light?

Opacity:
- What is the opacity (0 to 255)?
- Lower: dimmer. Higher: Brighter.

Offsets:

Offset X:
- Offset the X position of this light.
- Negative: left. Positive: right.

Offset Y:
- Offset the Y position of this light.
- Negative: up. Positive: down.
</pre>

---

<pre>
Conical Light Settings

General:

Enabled?:
- Is this conical light enabled?

Properties:

Filename:
- Filename used for the light effect image.
- If used, ignore Radius, Color, and Intensity.

Angle Offset:
- Offset the image angle by this many degrees.
- Only applies to images.

File Anchor X:
File Anchor Y:
- Anchor X/Y used for images.
- For X - Left: 0.0; Center: 0.5; Right: 1.0
- For Y - Top: 0.0; Middle: 0.5; Bottom: 1.0

Color:
- What is the radius of this conical light?
- For generated lights only.
- Ignore if using image.

Radius:
- What is the radius of this conical light?
- For generated lights only.
- Ignore if using image.

Source Radius:
- What is the radius of this light source?
- For generated lights only.
- Ignore if using image.

Intensity:
- Conical light intensity. Use value between 0 & 1.
- For generated lights only.
- Ignore if using image.

Optional:

Blend Mode:
- What kind of blend mode do you wish to apply to the conical light?

Opacity:
- What is the opacity (0 to 255)?
- Lower: dimmer. Higher: Brighter.

Angle:

Arc Angle:
- What is the angle of this conical light's arc?

Angle Sway:
- How many degrees should this light sway?
- Use 0 for no sway.

Sway Speed:
- How fast should this light sway?
- Lower: Slower; Higher: Faster

Randomize Sway?:
- Change the sway to offset at different starting points?

Direction:

Forced Direction?:
- Force the conical light to face a certain direction?

Follow Cursor?
- Follow the mouse cursor?

Offsets:

Use Hand Offset?:
- Put the light source on the target's "hand" position?
- Disables the two settings below if on.

Offset X:
- Offset the X position of this light.
- Negative: left. Positive: right.

Offset Y:
- Offset the Y position of this light.
- Negative: up. Positive: down.
</pre>

---

<pre>
Behavior

Blink:

Blink Rate:
- What is the rate of occurance for this effect?
- Use a decimal number between 0 and 1.

Blink Modifier:
- Static multiplicative opacity modifier. Before additive.
- Use a decimal number between -1 and 1. Negatives allowed.

Flicker:

Flicker Rate:
- What is the rate of occurance for this effect?
- Use a decimal number between 0 and 1.

Flicker Modifier:
- Random multiplicative opacity modifier. Before additive.
- Use a decimal number between -1 and 1. Negatives allowed.

Flash:

Flash Rate:
- What is the rate of occurance for this effect?
- Use a decimal number between 0 and 1.

Flash Modifier:
- Static additive opacity modifier. Before multiplicative.
- Use a decimal number between -1 and 1. Negatives allowed.

Flare:

Flare Rate:
- What is the rate of occurance for this effect?
- Use a decimal number between 0 and 1.

Flare Modifier:
- Random additive opacity modifier. Before multiplicative.
- Use a decimal number between -1 and 1. Negatives allowed.

Glow:

Glow Rate:
- What is the glow change for this light?
- Use a decimal number between 0 and 1.

Glow Speed:
- What is the speed at which glow oscillates at?
- Use a decimal number between 0 and 1.

Randomize Glow?:
- Offset the glow to oscillate at different starting points?

Pulse:

Pulse Rate:
- What is the pulse change for this light?
- Use a decimal number between 0 and 1.

Pulse Speed:
- What is the speed at which pulse oscillates at?
- Use a decimal number between 0 and 1.

Randomize Pulse?:
- Offset the pulse to oscillate at different starting points?

Pattern:

Pattern Name:
- Select the pattern name for this light.
- Ignore if using any Custom Pattern.

Custom Pattern:
- Create a custom pattern with letters from a to z.
- Where 'a' is transparent and 'z' is opaque.

Frame Delay:
- What is the frame delay between pattern updates?
</pre>

---

← Older revision		Revision as of 03:02, 12 March 2022
Line 448:		Line 448:

	=== Spawn Light Plugin Commands ===		=== Spawn Light Plugin Commands ===
		+
		+	[[File:LightingEffects_Spawn.gif]]

	---		---

← Older revision		Revision as of 02:59, 12 March 2022
Line 340:		Line 340:

	=== Conical Offset Plugin Commands ===		=== Conical Offset Plugin Commands ===
		+
		+	[[File:LightingEffects_ConicalHandDir.png\|600px]]

	---		---

← Older revision		Revision as of 02:59, 12 March 2022
Line 217:		Line 217:

	=== Conical Light Plugin Commands ===		=== Conical Light Plugin Commands ===
		+
		+	[[File:LightingEffects_ConicalLight.png\|600px]]

	---		---

← Older revision		Revision as of 02:59, 12 March 2022
Line 92:		Line 92:

	=== Radial Light Plugin Commands ===		=== Radial Light Plugin Commands ===
		+
		+	[[File:LightingEffects_RadialLight.png\|600px]]

	---		---

← Older revision		Revision as of 02:59, 12 March 2022
Line 46:		Line 46:

	=== Battle Light Plugin Commands ===		=== Battle Light Plugin Commands ===
		+
		+	[[File:LightingEffects_BattleCore.png\|600px]]

	---		---

@@ Line 833: / Line 833: @@
      - Disables the two settings below if on.
-     Offset X:
+     Offset X (Non-Hand):
      - Offset the X position of this light.
      - Negative: left. Positive: right.
-     Offset Y:
+     Offset Y (Non-Hand):
      - Offset the Y position of this light.
      - Negative: up. Positive: down.

@@ Line 684: / Line 684: @@
 ---
 <pre>
@@ Line 745: / Line 747: @@
 ---
 <pre>
@@ Line 839: / Line 843: @@
 ---
 <pre>

← Older revision		Revision as of 02:58, 12 March 2022
Line 6:		Line 6:

	=== Overlay Plugin Commands ===		=== Overlay Plugin Commands ===
		+
		+	[[File:LightingEffects_Quick3.png\|600px]]

	---		---

Template:VisuMZ Lighting Effects Plugin Commands - Revision history

Irina: /* Light-Related Sub Settings */

Irina: /* Light-Related Sub Settings */

Irina: /* Spawn Light Plugin Commands */

Irina: /* Conical Offset Plugin Commands */

Irina: /* Conical Light Plugin Commands */

Irina: /* Radial Light Plugin Commands */

Irina: /* Battle Light Plugin Commands */

Irina: /* Overlay Plugin Commands */

Irina: Created page with "VisuMZ Lighting Effects Plugin Commands The following are Plugin Commands that come with this plugin. They can be accesse..."