UI (functions)/Background
From PMDOWiki
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. |
