Index | Collapse All Expand All

SetBackground Method
Control Class Members See Also

Beta Documentation - Subject to change.
Sets the background image of the control.

# Syntax

Lua
    function Control:SetBackground(backgroundImage);

#### Parameters

backgroundImage
  Type: any
  The path or id of the image to set the background of the control to.

# Remarks

This method will change the background image of the control. The value specified can be either a path to a file to load from the plugins folder or a unique id that specifies a game asset.For images loaded from the plugins folder, the path should be a relative directory from the top level plugins folder. Images must be either in TGA or JPG format.

# See Also

- Control
- Turbine.UI