UI.ButtonImg

static bool ButtonImg(string text, Sprite image, UIBtnLayout imageLayout)

A pressable button accompanied by an image! The button will expand to fit the text provided to it, horizontally. Text is re-used as the id. Will return true only on the first frame it is pressed!

   
string text Text to display on the button and id for tracking element state. MUST be unique within current hierarchy.
Sprite image This is the image that will be drawn along with the text. See imageLayout for where the image gets drawn!
UIBtnLayout imageLayout This enum specifies how the text and image should be laid out on the button. For example, UIBtnLayout.Left will have the image on the left, and text on the right.
RETURNS: bool Will return true only on the first frame it is pressed! 
static bool ButtonImg(string text, Sprite image, Color imageTint, UIBtnLayout imageLayout)

A pressable button accompanied by an image! The button will expand to fit the text provided to it, horizontally. Text is re-used as the id. Will return true only on the first frame it is pressed! Image can be tinted by passing a custom color

   
string text Text to display on the button and id for tracking element state. MUST be unique within current hierarchy.
Sprite image This is the image that will be drawn along with the text. See imageLayout for where the image gets drawn!
Color imageTint The Sprite’s color will be multiplied by this tint. The default is White(1,1,1,1).
UIBtnLayout imageLayout This enum specifies how the text and image should be laid out on the button. For example, UIBtnLayout.Left will have the image on the left, and text on the right.
RETURNS: bool Will return true only on the first frame it is pressed! 
static bool ButtonImg(string text, Sprite image, UIBtnLayout imageLayout, Vec2 size)

A pressable button accompanied by an image! The button will expand to fit the text provided to it, horizontally. Text is re-used as the id. Will return true only on the first frame it is pressed!

   
string text Text to display on the button and id for tracking element state. MUST be unique within current hierarchy.
Sprite image This is the image that will be drawn along with the text. See imageLayout for where the image gets drawn!
UIBtnLayout imageLayout This enum specifies how the text and image should be laid out on the button. For example, UIBtnLayout.Left will have the image on the left, and text on the right.
Vec2 size The layout size for this element in Hierarchy space. If an axis is left as zero, it will be auto-calculated. For X this is the remaining width of the current layout, and for Y this is UI.LineHeight.
RETURNS: bool Will return true only on the first frame it is pressed! 
static bool ButtonImg(string text, Sprite image, Color imageTint, UIBtnLayout imageLayout, Vec2 size)

A pressable button accompanied by an image! The button will expand to fit the text provided to it, horizontally. Text is re-used as the id. Will return true only on the first frame it is pressed! Image can be tinted by passing a custom color

   
string text Text to display on the button and id for tracking element state. MUST be unique within current hierarchy.
Sprite image This is the image that will be drawn along with the text. See imageLayout for where the image gets drawn!
Color imageTint The Sprite’s color will be multiplied by this tint. The default is White(1,1,1,1).
UIBtnLayout imageLayout This enum specifies how the text and image should be laid out on the button. For example, UIBtnLayout.Left will have the image on the left, and text on the right.
Vec2 size The layout size for this element in Hierarchy space. If an axis is left as zero, it will be auto-calculated. For X this is the remaining width of the current layout, and for Y this is UI.LineHeight.
RETURNS: bool Will return true only on the first frame it is pressed!



Found an issue with these docs, or have some additional questions? Create an Issue on Github!