-
Notifications
You must be signed in to change notification settings - Fork 237
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Improve beam blueprint annotations (#6450)
Add descriptions so a novice can understand beam blueprints.
- Loading branch information
Showing
3 changed files
with
22 additions
and
13 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
- (#6450) Improve beam blueprint annotations with thorough descriptions of beam parameters. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,12 +1,20 @@ | ||
---@meta | ||
|
||
---@alias BeamBlendmode | ||
---| 0 # Alpha blend | ||
---| 1 # Modulate Inverse | ||
---| 2 # Modulate2X Inverse | ||
---| 3 # Add | ||
---| 4 # Premodulated Alpha | ||
|
||
---@class BeamBlueprint : EmitterBlueprint | ||
---@field Length number Total length of beam | ||
---@field Lifetime number Lifetime of the emitter | ||
---@field Thickness number Thickness of the beam | ||
---@field TextureName FileName Filename of texture | ||
---@field StartColor NamedQuaternion RGBA start color of beam | ||
---@field EndColor NamedQuaternion RGBA end color of beam | ||
---@field UShift number U Texture shift of beam texture | ||
---@field VShift number V Texture shift of beam texture | ||
---@field RepeatRate number How often the texture repeats per ogrid blendmode of this beam | ||
---@field Length number # Total length of beam | ||
---@field Lifetime number # Lifetime of the emitter | ||
---@field Thickness number # Thickness of the beam in both directions from the center | ||
---@field TextureName FileName # Filename of texture | ||
---@field StartColor NamedQuaternion # Color multiplier from 0 to 1 of beam texture at start point. `w, x, y, z = ARGB` | ||
---@field EndColor NamedQuaternion # Color multiplier from 0 to 1 of beam texture at end point. `w, x, y, z = ARGB` | ||
---@field UShift number # Proportional shift of beam texture per tick in the U direction (across width of beam, X direction of texture) | ||
---@field VShift number # Proportional shift of beam texture per tick in the V direction (across the length of the beam, Y direction of texture) | ||
---@field RepeatRate number # How often the texture repeats per ogrid. `0` stretches the texture over the length of the beam. | ||
---@field Blendmode BeamBlendmode # Blend mode of the beam. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters