Skip to content


Backgrounds is a global which provides the ability to interact with the background.

Example Usage:Backgrounds.getBackground().

Function Summary

Function Name Description Return  
getBackground() Returns the current background name.  
getCustomURL() Returns the image URL of the current custom background, or nil if the current background is not custom.  
setBackground( name) Replaces the current background with the background matching the specified name.  
setCustomURL( url) Replaces the current background with a custom background loaded from the specified url.