UE2:WaveGenerator (U2XMP)
- Package:
- Engine
| This is an auto-generated page and may need human attention. Please remove the {{autogenerated}} tag if the page seems reasonably complete or replace it with the {{expand}} tag if the page is not yet complete. |
$Author: Mfox $ $Date: 6/25/02 11:36p $ $Revision: 3 $ Name: WaveGenerator.uc Author: Aaron R Leiby Date: 18 January 2000 Description: Used to generate a pond ripple effect on WavyMeshes. How to use this class:
+ Place in the Level relative to the WavyMesh you wish to effect. (Note: Z position is ignored since WavyMeshes are assumed to be horizontal.
+ Set the Event of the WaveGenerator to the Tag of the WavyMesh you wish to effect. (If none is set, then it will effect all WavyMeshes within its Visibility extents (VisibliltyHeight/VisibilityRadius).
+ Hook a trigger to it by setting the Event of a Trigger to the Tag of the WaveGenerator.
+ Set the WaveGenerator's InitialState to TriggerToggle, TriggerControl or TriggerTimed. (If TriggerTimed, make sure to set the time interval.)
+ Set bInitially on as desired.
+ Set Rate, Magnitude and Wavelength as desired.
+ Set MaxRadius if radial falloff is desired.
Properties
Property group 'WaveGenerator'
bInitiallyOn
Type: bool
Modifiers: public
bOn
Type: bool
Modifiers: public
FadeTime
Type: float
Modifiers: public
Amount of time it takes to fade away after we stop oscillating.
Default value: 3.0
Magnitude
Type: float
Modifiers: public
Height of each crest (additive to existing vertex magnitude).
Default value: 16.0
MaxRadius
Type: float
Modifiers: public
Rate
Type: float
Modifiers: public
How fast this wave oscillates (number of crests per second).
Default value: 2.0
TimerDuration
Type: float
Modifiers: public
Default value: 3.0
Wavelength
Type: float
Modifiers: public
Distance between crests.
Default value: 48.0
Internal variables
bPrevOn
Type: bool
Modifiers: private
FadeTimer
Type: float
Modifiers: private
Maintained in C++.
InternalTimer
Type: float
Modifiers: private
Theta
Type: float
Modifiers: private
Maintained in C++.
Default values
| Property | Value |
|---|---|
| InitialState | 'TriggerTimed' |
Events
PreBeginPlay
Overrides: Actor.PreBeginPlay
States
TriggerControl
Modifiers: simulated
TriggerControl.Trigger
Overrides: Actor.Trigger (global)
TriggerControl.UnTrigger
Overrides: Actor.UnTrigger (global)
TriggerTimed
Modifiers: simulated
TriggerTimed.Trigger
Overrides: Actor.Trigger (global)
TriggerToggle
Modifiers: simulated
TriggerToggle.Trigger
Overrides: Actor.Trigger (global)
