diff --git a/docs/triggers/level/bg_effect_on_off.md b/docs/triggers/level/bg_effect_on_off.md index 03b7567..31c64e4 100644 --- a/docs/triggers/level/bg_effect_on_off.md +++ b/docs/triggers/level/bg_effect_on_off.md @@ -2,4 +2,6 @@ Enables / Disables the background particles that appear when your current gamemode is Ship, UFO, Wave or Swing. +## Notes + This trigger affects the spawning of particles not their visibility, particles will not disappear or reappear instantly. \ No newline at end of file diff --git a/docs/triggers/level/bg_speed.md b/docs/triggers/level/bg_speed.md index 705743a..853feba 100644 --- a/docs/triggers/level/bg_speed.md +++ b/docs/triggers/level/bg_speed.md @@ -2,6 +2,8 @@ Controls the X and Y speed of the background, relative to the camera's movement. +## Notes + The background's movement can be calculated using the formulas: $BGMoveX = CMoveX \cdot (1 - SpeedX)$ $BGMoveY = CMoveY \cdot (1 - SpeedY)$ diff --git a/docs/triggers/level/change_background.md b/docs/triggers/level/change_background.md index 04f9d82..40be3ff 100644 --- a/docs/triggers/level/change_background.md +++ b/docs/triggers/level/change_background.md @@ -1,5 +1,9 @@ # Change Background -Changes the level's Background to a different preset. There are currently 59 BG presets. +Changes the level's Background to a different preset. + +## Notes + +There are currently 59 BG presets. Only one Background change can be made per render frame. The first will trigger, while any other subsequent BG trigger is ignored until the next frame. \ No newline at end of file diff --git a/docs/triggers/level/change_ground.md b/docs/triggers/level/change_ground.md index d60472e..07ccb4c 100644 --- a/docs/triggers/level/change_ground.md +++ b/docs/triggers/level/change_ground.md @@ -1,6 +1,10 @@ # Change Ground -Changes the level's Ground to a different preset. There are currently 22 Ground presets. +Changes the level's Ground to a different preset. + +## Notes + +There are currently 22 Ground presets. 3 Line options exist, but the trigger cannot currently set them. diff --git a/docs/triggers/level/change_middleground.md b/docs/triggers/level/change_middleground.md index 02c1cc7..4b29c99 100644 --- a/docs/triggers/level/change_middleground.md +++ b/docs/triggers/level/change_middleground.md @@ -1,5 +1,9 @@ # Change Middleground -Changes the level's Middleground to a different preset. There are currently 3 MG presets. +Changes the level's Middleground to a different preset. + +## Notes + +There are currently 3 MG presets. Only one Middleground change can be made per render frame. The first will trigger, while any other subsequent MG trigger is ignored until the next frame. \ No newline at end of file diff --git a/docs/triggers/level/mg_speed.md b/docs/triggers/level/mg_speed.md index 3aedfb4..e7325bd 100644 --- a/docs/triggers/level/mg_speed.md +++ b/docs/triggers/level/mg_speed.md @@ -2,15 +2,17 @@ Controls the X and Y speed of the middleground. +## Notes + Middleground speed works differently for X and Y: - X axis: movement is relative to camera movement - Y axis: position is relative to camera position As a side-effect, if you change the middleground's Y speed this will also instantly change the middleground's position. -The middleground's movement and position can be calculated using the formulas: -$MGMoveX = CMoveX \cdot (1 - SpeedX)$ -$MGPosY = CPosY \cdot (1 - SpeedY) + OffsetY \cdot 3$ +The middleground's movement and position can be calculated using the formulas: +$MGMoveX = CMoveX \cdot (1 - SpeedX)$ +$MGPosY = CPosY \cdot (1 - SpeedY) + OffsetY$ For example, a speed of 1.00 makes the middleground stationary, while a speed of 0.00 matches the camera's movement. diff --git a/docs/triggers/level/offset_mg_y.md b/docs/triggers/level/offset_mg_y.md index ed0e7bb..bf29fc0 100644 --- a/docs/triggers/level/offset_mg_y.md +++ b/docs/triggers/level/offset_mg_y.md @@ -2,7 +2,9 @@ Changes the middleground's current Y offset to a new value. -This change can be animated using an **Easing** for a given **Move Time**. +## Notes + +Can be animated using an **Easing** for a given **Move Time**. The offset is applied on top of the middleground's base vertical position and is not reset if the middleground's Y speed changes.