GuiFadeinBitmapCtrl
A GUI control which renders a black square over a bitmap image. The black square will fade out, then fade back in after a determined time. This control is especially useful for transitions and splash screens.
Fading
LinearColorF
Color to fade in from and fade out to.
int
Milliseconds for the bitmap to fade in.
int
Milliseconds to wait after fading in before fading out the bitmap.
int
Milliseconds for the bitmap to fade out.
EaseF
Easing curve for fade-in.
EaseF
Easing curve for fade-out.
bool
Whether the fade cycle has finished running.
Callbacks
Detailed Description
A GUI control which renders a black square over a bitmap image. The black square will fade out, then fade back in after a determined time. This control is especially useful for transitions and splash screens.
new GuiFadeinBitmapCtrl() { fadeinTime = "1000"; waitTime = "2000"; fadeoutTime = "1000"; done = "1"; // Additional GUI properties that are not specific to GuiFadeinBitmapCtrl have been omitted from this example. };
Fading
LinearColorF fadeColor
Color to fade in from and fade out to.
int fadeInTime
Milliseconds for the bitmap to fade in.
int waitTime
Milliseconds to wait after fading in before fading out the bitmap.
int fadeOutTime
Milliseconds for the bitmap to fade out.
EaseF fadeInEase
Easing curve for fade-in.
EaseF fadeOutEase
Easing curve for fade-out.
bool done
Whether the fade cycle has finished running.
Callbacks
click()
Informs the script level that this object received a Click event from the cursor or keyboard.
GuiFadeInBitmapCtrl::click(%this) { // Code to run when click occurs }
onDone()
Informs the script level that this object has completed is fade cycle.
GuiFadeInBitmapCtrl::onDone(%this) { // Code to run when the fade cycle completes }