UI (functions)/Background: Difference between revisions
From PMDOWiki
No edit summary |
|||
| (One intermediate revision by the same user not shown) | |||
| Line 19: | Line 19: | ||
}} | }} | ||
{{ArgRow | {{ArgRow | ||
|name= | |name=fadeInTime | ||
|type=Integer | |type=Integer | ||
|techt=System.Int32 | |techt=System.Int32 | ||
| Line 25: | Line 25: | ||
}} | }} | ||
|} | |} | ||
=== Example === | === Example === | ||
| Line 53: | Line 54: | ||
}} | }} | ||
{{ArgRow | {{ArgRow | ||
|name= | |name=fadeInTime | ||
|type=Integer | |type=Integer | ||
|techt=System.Int32 | |techt=System.Int32 | ||
| Line 59: | Line 60: | ||
}} | }} | ||
|} | |} | ||
== WaitHideBG == | == WaitHideBG == | ||
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. |
