UI (functions)/Background: Difference between revisions

From PMDOWiki
Imbion (talk | contribs)
3,593 edits
Created page with "== UI:WaitShowBG == Fades in a chosen background image, with a chosen framerate, at a certain fade time, waiting until the fade-in is complete. === Arguments === * <code>bg</code>: The background to show, from the list of BG textures. * <code>frameTime</code>: Framerate of the image animation. * <code>fadeInTime</code>: Time taken to fade in the image. === Example === <pre> UI:WaitShowBG("TestBG", 3, 60) </pre> == UI:ShowBG(System.String,System.Int32,System.Int..."
 
Imbion (talk | contribs)
3,593 edits
 
(2 intermediate revisions by the same user not shown)
Line 1: Line 1:
== UI:WaitShowBG ==
== WaitShowBG ==
 
 
Fades in a chosen background image, with a chosen framerate, at a certain fade time, waiting until the fade-in is complete.


Fades in a chosen background image, with a chosen framerate, at a certain fade time, waiting until the fade-in is complete. {{FuncUsage|nmspace=UI|nm=WaitShowBG|args=}}


=== Arguments ===
=== Arguments ===
 
{| class="wikitable"
* <code>bg</code>: The background to show, from the list of BG textures.
{{ArgHeader}}
* <code>frameTime</code>: Framerate of the image animation.
{{ArgRow
* <code>fadeInTime</code>: Time taken to fade in the image.
|name=bg
|type=String
|techt=System.String
|purp=The background to show, from the list of BG textures.
}}
{{ArgRow
|name=frameTime
|type=Integer
|techt=System.Int32
|purp=Framerate of the image animation.
}}
{{ArgRow
|name=fadeInTime
|type=Integer
|techt=System.Int32
|purp=Time taken to fade in the image.
}}
|}


=== Example ===
=== Example ===
Line 19: Line 34:
</pre>
</pre>


== UI:ShowBG(System.String,System.Int32,System.Int32) ==
== ShowBG ==
 
 
Sets an image to display.  Requires WaitDialog to actually display.


Sets an image to display. Requires WaitDialog to actually display. {{FuncUsage|nmspace=UI|nm=ShowBG|args=}}


=== Arguments ===
=== Arguments ===
{| class="wikitable"
{{ArgHeader}}
{{ArgRow
|name=bg
|type=String
|techt=System.String
|purp=The background to show, from the list of BG textures.
}}
{{ArgRow
|name=frameTime
|type=Integer
|techt=System.Int32
|purp=Framerate of the image animation.
}}
{{ArgRow
|name=fadeInTime
|type=Integer
|techt=System.Int32
|purp=Time taken to fade in the image.
}}
|}


* <code>bg</code>: The background to show, from the list of BG textures.
== WaitHideBG ==
* <code>frameTime</code>: Framerate of the image animation.
* <code>fadeInTime</code>: Time taken to fade in the image.
 
== UI:WaitHideBG ==
 
 
Fades out the current background image, waiting until the fade-out is complete.


Fades out the current background image, waiting until the fade-out is complete. {{FuncUsage|nmspace=UI|nm=WaitHideBG|args=}}


=== Arguments ===
=== Arguments ===
 
{| class="wikitable"
* <code>time</code>: Time taken to fade out the image.
{{ArgHeader}}
{{ArgRow
|name=time
|type=Integer
|techt=System.Int32
|purp=Time taken to fade out the image.
}}
|}


=== Example ===
=== Example ===
Line 49: Line 84:
</pre>
</pre>


== UI:FadeBG(System.Int32) ==
== FadeBG ==
 
 
Prepares a fade-out of the current image.  Requires WaitDialog to actually display.


Prepares a fade-out of the current image. Requires WaitDialog to actually display. {{FuncUsage|nmspace=UI|nm=FadeBG|args=}}


=== Arguments ===
=== Arguments ===
 
{| class="wikitable"
* <code>time</code>: Time taken to fade out the image.
{{ArgHeader}}
{{ArgRow
|name=time
|type=Integer
|techt=System.Int32
|purp=Time taken to fade out the image.
}}
|}

Latest revision as of 05:06, 18 January 2026

WaitShowBG

Fades in a chosen background image, with a chosen framerate, at a certain fade time, waiting until the fade-in is complete. Argument order is UI:WaitShowBG().

Arguments

Name Type Technical Type Purpose
bg String System.String The background to show, from the list of BG textures.
frameTime Integer System.Int32 Framerate of the image animation.
fadeInTime Integer System.Int32 Time taken to fade in the image.

Example


UI:WaitShowBG("TestBG", 3, 60)

ShowBG

Sets an image to display. Requires WaitDialog to actually display. Argument order is UI:ShowBG().

Arguments

Name Type Technical Type Purpose
bg String System.String The background to show, from the list of BG textures.
frameTime Integer System.Int32 Framerate of the image animation.
fadeInTime Integer System.Int32 Time taken to fade in the image.

WaitHideBG

Fades out the current background image, waiting until the fade-out is complete. Argument order is UI:WaitHideBG().

Arguments

Name Type Technical Type Purpose
time Integer System.Int32 Time taken to fade out the image.

Example


UI:WaitHideBG(60)

FadeBG

Prepares a fade-out of the current image. Requires WaitDialog to actually display. Argument order is UI:FadeBG().

Arguments

Name Type Technical Type Purpose
time Integer System.Int32 Time taken to fade out the image.
Retrieved from "https://wiki.pmdo.pmdcollab.org/wiki/index.php?title=UI_(functions)/Background&oldid=6469"