I love the smell of UnrealEd crashing in the morning. – tarquin

Difference between revisions of "UE3:UIComp DrawComponents (UT3)"

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
m (moved subclass list to infobox)
(Auto-generated page)
 
Line 6: Line 6:
 
| within = UIObject
 
| within = UIObject
 
}}
 
}}
 +
{{autogenerated}}
 +
Copyright 2004-2005 Epic Games, Inc. All Rights Reserved.
 +
 +
+Added support for pulsing and fading the drawing components.  It adds an UpdateFade() function that
 +
will return the current fade value giving the deltatime.  The child is responsible for called SetOpacity()
 +
passing in whatever value is included.  This is possibly a temporary solution
  
 
==Properties==
 
==Properties==
Line 61: Line 67:
 
==Delegates==
 
==Delegates==
 
====OnFadeComplete====
 
====OnFadeComplete====
<code>delegate '''OnFadeComplete''' ({{cl|UIComp_DrawComponents}} '''Sender''')</code>
+
{{code|delegate '''OnFadeComplete''' ({{cl|UIComp_DrawComponents}}&nbsp;'''Sender''')}}
  
 
OnFadeComplete will be called as soon as the fade has been completed
 
OnFadeComplete will be called as soon as the fade has been completed
Line 67: Line 73:
 
==Native functions==
 
==Native functions==
 
====Fade====
 
====Fade====
<code>function final native '''Fade''' ([[float]] '''FromAlpha''', [[float]] '''ToAlpha''', [[float]] '''TargetFadeTime''')</code>
+
{{code|function final native '''Fade''' ([[float]]&nbsp;'''FromAlpha''', [[float]]&nbsp;'''ToAlpha''', [[float]]&nbsp;'''TargetFadeTime''')}}
  
 
How Much Longer until we reach the target Alpha
 
How Much Longer until we reach the target Alpha
  
 
====Pulse====
 
====Pulse====
<code>function final native '''Pulse''' (optional [[float]] '''MaxAlpha''', optional [[float]] '''MinAlpha''', optional [[float]] '''PulseRate''')</code>
+
{{code|function final native '''Pulse''' (optional&nbsp;[[float]]&nbsp;'''MaxAlpha''', optional&nbsp;[[float]]&nbsp;'''MinAlpha''', optional&nbsp;[[float]]&nbsp;'''PulseRate''')}}
  
 
<!-- enter function description -->
 
<!-- enter function description -->
  
 
====ResetFade====
 
====ResetFade====
<code>function final native '''ResetFade''' ()</code>
+
{{code|function final native '''ResetFade''' ()}}
  
 
<!-- enter function description -->
 
<!-- enter function description -->

Latest revision as of 10:11, 17 May 2008

UT3 Object >> Component >> UIComponent >> UIComp_DrawComponents
Package: 
Engine
Within class: 
UIObject
Direct subclasses:
UIComp_DrawImage, UIComp_DrawString
This class in other games:
UDK

Copyright 2004-2005 Epic Games, Inc. All Rights Reserved.

Added support for pulsing and fading the drawing components. It adds an UpdateFade() function that

will return the current fade value giving the deltatime. The child is responsible for called SetOpacity()

passing in whatever value is included. This is possibly a temporary solution

Properties[edit]

Property group 'Fading'[edit]

FadeAlpha[edit]

Type: float

Modifiers: transient


FadeTarget[edit]

Type: float

Modifiers: transient


FadeTime[edit]

Type: float

Modifiers: transient


FadeType[edit]

Type: EFadeType

Modifiers: transient

Where the fade is going

Internal variables[edit]

FadeRate[edit]

Type: float

Modifiers: transient

Used for pulsing. This is the rate at which it will occur

LastRenderTime[edit]

Type: float

Modifiers: transient

Used to create a delta for fading

Enums[edit]

EFadeType[edit]

EFT_None 
No fading, Opacity will
EFT_Fading 
Fading to a specific Alpha
EFT_Pulsing 
Pulsing between Alpha 0.0 and FadeTarget

Delegates[edit]

OnFadeComplete[edit]

delegate OnFadeComplete (UIComp_DrawComponents Sender)

OnFadeComplete will be called as soon as the fade has been completed

Native functions[edit]

Fade[edit]

function final native Fade (float FromAlpha, float ToAlpha, float TargetFadeTime)

How Much Longer until we reach the target Alpha

Pulse[edit]

function final native Pulse (optional float MaxAlpha, optional float MinAlpha, optional float PulseRate)


ResetFade[edit]

function final native ResetFade ()