Skip to content

Commit

Permalink
Update effects and jump_effect pages with verified information provid…
Browse files Browse the repository at this point in the history 
…ed from the old wiki by Discord user JohnSmith
  • Loading branch information
@IrateRedKite
IrateRedKite committed Nov 15, 2024
1 parent ba7db85 commit 5acc325
Show file tree
Hide file tree
Showing 2 changed files with 44 additions and 44 deletions.
60 changes: 30 additions & 30 deletions docs/ini-editing/typed-inis/effects.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -46,17 +46,17 @@ run_time = INT
pbubble = INT, INT
```

| Parameter | Information |
| ---------------- | -------------------------------------------------- |
| nickname | How the effect is referenced by `[Effect]` blocks. |
| priority | |
| generic_priority | |
| lod_type | |
| radius | |
| visibility | Options are `EXIST_OFFSCREEN` or `CULL_OFFSCREEN` |
| update | Options are `UPDATE_OFFSCREEN` or `CULL_UPDATE` |
| run_time | Maximum run time for effects of this type. |
| pbubble | |
| Parameter | Information |
| ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| nickname | How the effect is referenced by `[Effect]` blocks. |
| priority | Sets the effect's render priority. This appears to determine culling order when particle cap is reached. |
| generic_priority | Same as `priority`, but for the effect referenced by `vis_generic`. in `[Effect]` blocks. |
| lod_type | Options are `EFT_LOD_NONE`, `EFT_LOD_TRAIL`, `EFT_LOD_WEAPON`, `EFT_LOD_SMALL`, `EFT_LOD_MEDIUM`, `EFT_LOD_LARGE` and `EFT_LOD_SMALL_DISTANT`. |
| radius | Range: 0 to infty. Approximates the size of the object; may be used in the calculations for `visibility` and `update`. |
| visibility | Determines the visibility of the effect. Options are `EXIST_OFFSCREEN` or `CULL_OFFSCREEN` |
| update | Determines whether the effect is updated when offsceen. Options are `UPDATE_OFFSCREEN` or `CULL_UPDATE` |
| run_time | Maximum run time for effects of this type. |
| pbubble | Determines the maximum and minimum view distance of the effect. Note that any radius higher than the hardcoded maximum draw range or the maximum effect view distance will not be used, defaulting to the hardcoded maximum instead. |

### VisEffect

Expand Down Expand Up @@ -175,25 +175,25 @@ trail_texture = STRING
flash_size = INT
```

| Parameter | Information |
| ---------------- | ------------------------------------------------------------- |
| nickname | How the BeamSpear is referred to in `[Effect]` blocks. |
| tip_length | Length of the tip element of the beam |
| tail_length | Length of the tail element of the beam |
| head_width | Width of the head element of the beam |
| core_width | Width of the core element of the beam |
| sec_core_width | |
| tip_color | RGB color of the tip element of the beam |
| core_color | RGB color of the core element of the beam |
| outter_color | RBG color of the outer 'glow' of the beam |
| sec_core_color | |
| sec_outter_color | |
| tail_color | RGB color of the tail element of the beam |
| head_brightness | Alpha of the head element of the beam (0-1 range) |
| trail_brightness | Alpha of the trail element of the beam (0-1 range) |
| head_texture | Texture of the head element of the beam (Can be ball or star) |
| trail_texture | Texture of the trail element of the beam (Be be wide or thin) |
| flash_size | Flash size of the beam when it is created. |
| Parameter | Information |
| ---------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
| nickname | How the BeamSpear is referred to in `[Effect]` blocks. |
| tip_length | Length of the tip element of the beam |
| tail_length | Length of the tail element of the beam |
| head_width | Width of the head element of the beam |
| core_width | Width of the core element of the beam |
| sec_core_width | Sets the diameter of the secondary core. |
| tip_color | RGB color of the tip element of the beam |
| core_color | RGB color of the core element of the beam |
| outter_color | RBG color of the outer 'glow' of the beam |
| sec_core_color | Sets the color inside of the secondary core. |
| sec_outter_color | Sets the color of the outter ring of the secondary core. The secondary core color is a gradient from sec_core_color to sec_outter_color. |
| tail_color | RGB color of the tail element of the beam |
| head_brightness | Alpha of the head element of the beam (0-1 range) |
| trail_brightness | Alpha of the trail element of the beam (0-1 range) |
| head_texture | Texture of the head element of the beam (Can be ball or star) |
| trail_texture | Texture of the trail element of the beam (Be be wide or thin) |
| flash_size | Flash size of the beam when it is created. |

#### Beam Breakdown

Expand Down
28 changes: 14 additions & 14 deletions docs/ini-editing/typed-inis/jump_effect.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -51,17 +51,17 @@ jump_ambient = INT, INT, INT
jump_background_color = INT, INT, INT
```

| Parameter | Information |
| --------------------- | ----------- |
| nickname | |
| glow_ring_effect | |
| glow_create_time | |
| jump_out_time | |
| jump_out_tunnel_time | |
| jump_in_tunnel_time | |
| jump_in_time | |
| kill_time_before_done | |
| jump_tunnel_effect | |
| jump_tunnel | |
| jump_ambient | |
| jump_background_color | |
| Parameter | Information |
| --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
| nickname | |
| glow_ring_effect | Lists the [effects](./effects.md) that should to be played when a ship docks with the jumpgate. Freelancer seems to have a limit of 7 here. |
| glow_create_time | Lists the time at which the effects are created after a ship begins docking. |
| jump_out_time | How long it takes for a ship to enter the tunnel after your ship reaches HpDockMountA. |
| jump_out_tunnel_time | The time until Freelancer loads the target system. |
| jump_in_tunnel_time | The time after loading until a player enters the target system. |
| jump_in_time | The time from when a player exits the tunnel until they arrive at the jumpgate. |
| kill_time_before_done | |
| jump_tunnel_effect | References an [effect](./effects.md) used during the jump sequence. |
| jump_tunnel | References a [gate_tunnel](./gate_tunnel.md) block that determines the jump tunnel used. |
| jump_ambient | An RGB tint value for the ambient light inside the jump tunnel. |
| jump_background_color | An RGB tint value for the 'backgrond' of the jump tunnel. |

0 comments on commit 5acc325

Please sign in to comment.