Skip to content

Adds various controls for customising the Sonic Beam weapon effect. #548

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: develop
Choose a base branch
from

Conversation

CCHyper
Copy link
Contributor

@CCHyper CCHyper commented Sep 9, 2021

Closes #540, Closes #547

This pull request adds various controls for customising the Sonic Beam weapon effect. It also implements a possible fix for the common "WaveClass" crashes see on older hardware (see issue #540).

Special thanks to @askhati and @MortonPL for assistance with the math calculations, and @tomsons26 with the drawing code.

SonicBeamColor=<r,g,b>
Color of the sonic beam, in 24-bit RGB. This color entry is used to enable the new drawing system, so you may need to experiment with the options below to get the desired drawing effect.

SonicBeamIsClear=<boolean>
Is the sonic beam clear (no color)? Defaults to false.

SonicBeamAlpha=<float>
The alpha blending of the sonic beam. Defaults to 0.5.

SonicBeamSineDuration=<float>
The duration of one wave effect pattern cycle. Defaults to 0.125.

SonicBeamSineAmplitude=<float>
The amplitude of the sonic beam pattern effect. Defaults to 12.0.

SonicBeamOffset=<float>
The amount to offset the pixel data under the sonic beam. Defaults to 0.49.

SonicBeamStartPinLeft=<x,y,z> Defaults to -30.0, -100.0, 0.0
SonicBeamStartPinRight=<x,y,z> Defaults to -30.0, 100.0, 0.0
SonicBeamEndPinLeft=<x,y,z> Defaults to 30.0, -100.0, 0.0
SonicBeamEndPinRight=<x,y,z> Defaults to 30.0, 100.0, 0.0
Start and end pins for the shape of the sonic beam.

SonicBeamSurfacePattern=<string>
The pattern for the sonic beam effect. Available options are; circle, ellipse, rhombus, and square. Defaults to circle.

SonicBeamSinePattern=<string>
The sine wave pattern for the sonic beam effect. Available options are; circle, square, sawtooth, and triangle. Defaults to circle.

Example screenshot;
image

@CCHyper CCHyper added new-feature New feature or request. enhancement Enhancement to original behaviour. labels Sep 9, 2021
@CCHyper CCHyper requested a review from a team September 9, 2021 23:04
@github-actions
Copy link

github-actions bot commented Sep 9, 2021

This comment is automaticly generated by Nightly.link and allows non-registered users to get download the artifacts for this pull request. This link is also updated when the pull request is pushed to.

@CCHyper CCHyper force-pushed the develop branch 2 times, most recently from b000bdc to 3eb9620 Compare September 15, 2021 21:38
@Bittah
Copy link
Collaborator

Bittah commented Oct 2, 2021

I tried out all different keys and while they all seemed to have some sort of effect, I wasn't clear on the exact effect or purpose of all of the different keys.

The keys that I was at least clear about worked fully as intended; these being SonicBeamColor, SonicBeamIsClear, SonicBeamStartPinLeft, SonicBeamStartPinRight ,SonicBeamEndPinLeft, and SonicBeamEndPinRight.

I expected that SonicBeamAlpha would control the beam's opacity, but it actually only controlled the color tint (higher values made the beam brighter and less saturated, while lower values made the beam darker and more saturated).

One thing that's still missing from this is a key to customize the duration for which the beam is actually fired, since this still appears to be hardcoded.

@CCHyper CCHyper force-pushed the develop branch 5 times, most recently from 58dc156 to 1b504cc Compare October 16, 2021 21:59
@CCHyper CCHyper force-pushed the develop branch 2 times, most recently from eb03022 to 8ed42ec Compare January 21, 2022 22:45
@CCHyper CCHyper force-pushed the develop branch 12 times, most recently from 7a2cd0e to 5e9bf4a Compare February 24, 2022 01:04
@CCHyper CCHyper self-assigned this Mar 28, 2023
@ZivDero ZivDero force-pushed the develop branch 2 times, most recently from 65abfa3 to 5be9542 Compare September 26, 2024 13:00
@CCHyper CCHyper removed their assignment Oct 7, 2024
@ZivDero ZivDero force-pushed the develop branch 5 times, most recently from a307ea7 to 735e008 Compare October 17, 2024 22:42
@ZivDero ZivDero force-pushed the develop branch 2 times, most recently from f40cd5a to ce12b49 Compare October 22, 2024 15:52
@ZivDero ZivDero force-pushed the develop branch 2 times, most recently from c3e7349 to 0a8e674 Compare November 27, 2024 12:27
@ZivDero ZivDero force-pushed the develop branch 3 times, most recently from ff8fc5d to 29067a6 Compare February 22, 2025 22:14
@ZivDero ZivDero force-pushed the develop branch 4 times, most recently from ff0d5d0 to 9ef6826 Compare March 22, 2025 02:13
@ZivDero ZivDero force-pushed the develop branch 5 times, most recently from acea927 to afcc4b3 Compare April 8, 2025 12:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Enhancement to original behaviour. new-feature New feature or request.
Projects
None yet
2 participants