UE3:HeightFogComponent (UDK): Difference between revisions

From Unreal Wiki, The Unreal Engine Documentation Site
No edit summary
 
m 1 revision: class descriptions for UDK January update (part 2)
 
Line 1: Line 1:
{{infobox class
{{UE3:HeightFogComponent (UT3)}}
| package = Engine
| parent1 = ActorComponent
| parent2 = Component
| parent3 = Object
}}
{{autogenerated}}
<!-- enter class description -->
 
==Properties==
===Property group 'HeightFogComponent'===
====bEnabled====
'''Type:''' [[bool]]
 
'''[[Variables#Modifiers|Modifiers]]:''' const
 
True if the fog is enabled.
 
'''Default value:''' True
 
====Density====
'''Type:''' [[float]]
 
'''[[Variables#Modifiers|Modifiers]]:''' const, interp
 
affects the scale for the fog layer's thickness
 
'''Default value:''' 5.0E-5
 
====ExtinctionDistance====
'''Type:''' [[float]]
 
'''[[Variables#Modifiers|Modifiers]]:''' const, interp
 
The distance at which light passing through the fog is 100% extinguished.
 
'''Default value:''' 1.0E8
 
====LightBrightness====
'''Type:''' [[float]]
 
'''[[Variables#Modifiers|Modifiers]]:''' const, interp
 
affects the inscattering color
 
'''Default value:''' 0.1
 
====LightColor====
'''Type:''' {{tl|Color|Object|structs}}
 
'''[[Variables#Modifiers|Modifiers]]:''' const, interp
 
Fog color to blend with the scene
 
'''Default value:'''
{| class="list defaults"
! {{tl|Color||Object structs|Member}}
! Value
|-
| A
| 0
|-
| B
| 255
|-
| G
| 255
|-
| R
| 255
|}
 
====StartDistance====
'''Type:''' [[float]]
 
'''[[Variables#Modifiers|Modifiers]]:''' const, interp
 
distance at which fog starts affecting the scene
 
===Internal variables===
====Height====
'''Type:''' [[float]]
 
'''[[Variables#Modifiers|Modifiers]]:''' const
 
z-height for the fog plane - updated by the owning actor
 
==Native functions==
====SetEnabled====
{{code|final native function '''SetEnabled''' ([[bool]]&nbsp;'''bSetEnabled''')}}
 
<!-- enter function description -->

Latest revision as of 05:40, 17 January 2010

UDK Object >> Component >> ActorComponent >> HeightFogComponent
Package:
Engine
This class in other games:
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.

Copyright 1998-2007 Epic Games, Inc. All Rights Reserved.

Properties

Property group 'HeightFogComponent'

bEnabled

Type: bool

Modifiers: const

True if the fog is enabled.

Default value: True

Density

Type: float

Modifiers: const, interp

affects the scale for the fog layer's thickness

Default value: 5.0E-5

ExtinctionDistance

Type: float

Modifiers: const, interp

The distance at which light passing through the fog is 100% extinguished.

Default value: 1.0E8

LightBrightness

Type: float

Modifiers: const, interp

affects the inscattering color

Default value: 0.1

LightColor

Type: Object.Color

Modifiers: const, interp

Fog color to blend with the scene

Default value:

Member Value
A 0
B 255
G 255
R 255

StartDistance

Type: float

Modifiers: const, interp

distance at which fog starts affecting the scene

Internal variables

Height

Type: float

Modifiers: const

z-height for the fog plane - updated by the owning actor

Native functions

SetEnabled

final native function SetEnabled (bool bSetEnabled)

Changes the enabled state of the height fog component.

Parameters:

  • bSetEnabled - The new value for bEnabled.
Retrieved from "https://wiki.beyondunreal.com/index.php?title=UE3:HeightFogComponent_(UDK)&oldid=40971"