Mostly Harmless

UE3:FluidInfluenceComponent (UDK)

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
UDK Object >> Component >> ActorComponent >> PrimitiveComponent >> FluidInfluenceComponent
Package: 
Engine


Properties[edit]

Property group 'FluidFlow'[edit]

FlowFrequency[edit]

Type: float

Modifiers: interp

Frequency of up/down and sideways motion of each ripple.

Default value: 4.0

FlowNumRipples[edit]

Type: int

Modifiers: interp

Number of flow ripples generated on the fluid surface.

Default value: 10

FlowSideMotionRadius[edit]

Type: float

Modifiers: interp

How much each flow ripple should oscillate sideways while moving down that flow direction.

Default value: 30.0

FlowSpeed[edit]

Type: float

Modifiers: interp

How fast the flow moves thru the fluid, in world space units per second.

Default value: 100.0

FlowStrength[edit]

Type: float

Modifiers: interp

Strength of each wave ripple.

Default value: 20.0

FlowWaveRadius[edit]

Type: float

Modifiers: interp

Radius of each flow wave, in world space units.

Default value: 50.0

Property group 'FluidInfluenceComponent'[edit]

bActive[edit]

Type: bool

Whether the effect is active and applying forces to the fluid.

Default value: True

FluidActor[edit]

Type: FluidSurfaceActor

If a specific FluidSurfaceActor is set, this influence won't automatically affect any other fluid and MaxDistance is ignored.

InfluenceType[edit]

Type: EInfluenceType

Type of fluid influence (a flow of waves, raindrops, or a single wave).

Default value: Fluid_Wave

MaxDistance[edit]

Type: float

Maximum distance (from the fluid plane) from where this influence will affect a fluid.

Default value: 1000.0

Property group 'FluidRaindrops'[edit]

RaindropAreaRadius[edit]

Type: float

Modifiers: interp

Radius of the area where raindrops fall.

Default value: 300.0

RaindropFillEntireFluid[edit]

Type: bool

Modifiers: interp

Whether raindrops should fill the entire fluid (TRUE), or just in a circular area around the influenceactor (FALSE).

Default value: True

RaindropRadius[edit]

Type: float

Modifiers: interp

Radius of each raindrop, in world space units.

Default value: 10.0

RaindropRate[edit]

Type: float

Modifiers: interp

Number of raindrops per second.

Default value: 20.0

RaindropStrength[edit]

Type: float

Modifiers: interp

Strength of each raindrop.

Default value: 5.0

Property group 'FluidSphere'[edit]

SphereInnerRadius[edit]

Type: float

Modifiers: interp

Inner radius of the 3D sphere. While inside this radius, the force will decrease as it moves closer to the fluid plane.

Default value: 50.0

SphereOuterRadius[edit]

Type: float

Modifiers: interp

Outer radius of the 3D sphere. While inside this radius, the force will increase as it moves closer to the fluid plane.

Default value: 100.0

SphereStrength[edit]

Type: float

Modifiers: interp

Strength of the force applied by the sphere.

Default value: -40.0

Property group 'FluidWave'[edit]

WaveFrequency[edit]

Type: float

Modifiers: interp

Wave frequency (can be 0 for a standing wave).

Default value: 1.0

WavePhase[edit]

Type: float

Modifiers: interp

Angular phase, in 0-360 degrees.

WaveRadius[edit]

Type: float

Modifiers: interp

Radius of the wave, in world space units.

Default value: 50.0

WaveStrength[edit]

Type: float

Modifiers: interp

Strength of the influencing force.

Default value: 40.0

Internal variables[edit]

bIsToggleTriggered[edit]

Type: bool

Modifiers: transient

The "toggle" Kismet event will set this to true, which will enable/disable the influence for 1 tick, then automatically go back to its previous state.

CurrentAngle[edit]

Type: float

Modifiers: private, native, transient


CurrentFluidActor[edit]

Type: FluidSurfaceActor

Modifiers: private, native, transient

The currently affected FluidSurfaceActor.

CurrentTimer[edit]

Type: float

Modifiers: private, native, transient


Default values[edit]

Property Value
bTickInEditor True

Enums[edit]

EInfluenceType[edit]

Fluid_Flow 
Fluid_Raindrops 
Fluid_Wave 
Fluid_Sphere