Trigger API Reference\DCEI Events\Custom UI
InGameUILayoutComponent CreateSliderFrame(InGameUILayoutComponent parent)
InGameUILayoutComponent CreateSliderFrame(InGameUILayoutComponent parent)
Description
Creates a slider UI frame, such as one would use to control game volume. Slider allows user to pick a value between 0-1.
Parameters
- InGameUILayoutComponent
parent
parent frame to create the slider inside of.
Example Usage
-- Define callback function
local function OnSliderChange(value)
DCEI.LogMessage(value)
end
-- Create and setup slider
local slider = DCEI.CreateSliderFrame(DCEI.GetUiRootFrame())
DCEI.SetFrameWidth(slider, 500)
DCEI.SetFrameHeight(slider, 60)
-- Slider properties
DCEI.SetOnSliderValueChangeCallback(slider, OnSliderChange)
DCEI.SetSliderFrameBackgroundImage(slider, DCEI.Texture("flat_icon_bar_empty_grey_ipick"))
DCEI.SetSliderFrameFillImage(slider, DCEI.Texture("bar_card_attribute"))
DCEI.SetSliderFrameHandleImage(slider, DCEI.Texture("fantasy_icon_mob_boss_slimeking"))
DCEI.SetSliderFrameHandleRadius(slider, 32)
DCEI.ShowSliderFrameHandle(slider, true)
DCEI.SetSliderFrameValue(slider, 0.5)
-- Log Value
DCEI.LogError(DCEI.GetSliderFrameValue(slider))
void SetOnSliderValueChangeCallback(InGameUILayoutComponent ui, TypedCallback<float> callback)
void SetOnSliderValueChangeCallback(InGameUILayoutComponent ui, TypedCallback<float> callback)
Description
Register a callback for when the slider handle is moved on a slider frame. The callback is passed the slider value, which is a real between 0 and 1.
Parameters
- InGameUILayoutComponent
ui
The slider frame. - TypedCallback<float>
callback
function to call when slider handle is moved.
Example Usage
-- Define callback function
local function OnSliderChange(value)
DCEI.LogMessage(value)
end
-- Create and setup slider
local slider = DCEI.CreateSliderFrame(DCEI.GetUiRootFrame())
DCEI.SetFrameWidth(slider, 500)
DCEI.SetFrameHeight(slider, 60)
-- Slider properties
DCEI.SetOnSliderValueChangeCallback(slider, OnSliderChange)
DCEI.SetSliderFrameBackgroundImage(slider, DCEI.Texture("flat_icon_bar_empty_grey_ipick"))
DCEI.SetSliderFrameFillImage(slider, DCEI.Texture("bar_card_attribute"))
DCEI.SetSliderFrameHandleImage(slider, DCEI.Texture("fantasy_icon_mob_boss_slimeking"))
DCEI.SetSliderFrameHandleRadius(slider, 32)
DCEI.ShowSliderFrameHandle(slider, true)
DCEI.SetSliderFrameValue(slider, 0.5)
-- Log Value
DCEI.LogError(DCEI.GetSliderFrameValue(slider))
void SetSliderFrameBackgroundImage(InGameUILayoutComponent ui, string name)
void SetSliderFrameBackgroundImage(InGameUILayoutComponent ui, string name)
Description
Sets the background image for the "unfilled" part of the slider frame (everything to the right of the handle).
Parameters
- InGameUILayoutComponent
ui
The slider frame. - string
name
name of the texture to use for the background image.
Example Usage
-- Define callback function
local function OnSliderChange(value)
DCEI.LogMessage(value)
end
-- Create and setup slider
local slider = DCEI.CreateSliderFrame(DCEI.GetUiRootFrame())
DCEI.SetFrameWidth(slider, 500)
DCEI.SetFrameHeight(slider, 60)
-- Slider properties
DCEI.SetOnSliderValueChangeCallback(slider, OnSliderChange)
DCEI.SetSliderFrameBackgroundImage(slider, DCEI.Texture("flat_icon_bar_empty_grey_ipick"))
DCEI.SetSliderFrameFillImage(slider, DCEI.Texture("bar_card_attribute"))
DCEI.SetSliderFrameHandleImage(slider, DCEI.Texture("fantasy_icon_mob_boss_slimeking"))
DCEI.SetSliderFrameHandleRadius(slider, 32)
DCEI.ShowSliderFrameHandle(slider, true)
DCEI.SetSliderFrameValue(slider, 0.5)
-- Log Value
DCEI.LogError(DCEI.GetSliderFrameValue(slider))
void SetSliderFrameFillImage(InGameUILayoutComponent ui, string name)
void SetSliderFrameFillImage(InGameUILayoutComponent ui, string name)
Description
Sets the background image for the "filled" part of the slider frame (everything to the left of the handle).
Parameters
- InGameUILayoutComponent
ui
The slider frame. - string
name
name of the texture to use for the fill image.
Example Usage
-- Define callback function
local function OnSliderChange(value)
DCEI.LogMessage(value)
end
-- Create and setup slider
local slider = DCEI.CreateSliderFrame(DCEI.GetUiRootFrame())
DCEI.SetFrameWidth(slider, 500)
DCEI.SetFrameHeight(slider, 60)
-- Slider properties
DCEI.SetOnSliderValueChangeCallback(slider, OnSliderChange)
DCEI.SetSliderFrameBackgroundImage(slider, DCEI.Texture("flat_icon_bar_empty_grey_ipick"))
DCEI.SetSliderFrameFillImage(slider, DCEI.Texture("bar_card_attribute"))
DCEI.SetSliderFrameHandleImage(slider, DCEI.Texture("fantasy_icon_mob_boss_slimeking"))
DCEI.SetSliderFrameHandleRadius(slider, 32)
DCEI.ShowSliderFrameHandle(slider, true)
DCEI.SetSliderFrameValue(slider, 0.5)
-- Log Value
DCEI.LogError(DCEI.GetSliderFrameValue(slider))
void SetSliderFrameHandleImage(InGameUILayoutComponent ui, string name)
void SetSliderFrameHandleImage(InGameUILayoutComponent ui, string name)
Description
Sets the image used for the handle on a slider UI frame.
Parameters
- InGameUILayoutComponent
ui
The slider frame. - string
name
name of the texture to use for the slider handle image.
Example Usage
-- Define callback function
local function OnSliderChange(value)
DCEI.LogMessage(value)
end
-- Create and setup slider
local slider = DCEI.CreateSliderFrame(DCEI.GetUiRootFrame())
DCEI.SetFrameWidth(slider, 500)
DCEI.SetFrameHeight(slider, 60)
-- Slider properties
DCEI.SetOnSliderValueChangeCallback(slider, OnSliderChange)
DCEI.SetSliderFrameBackgroundImage(slider, DCEI.Texture("flat_icon_bar_empty_grey_ipick"))
DCEI.SetSliderFrameFillImage(slider, DCEI.Texture("bar_card_attribute"))
DCEI.SetSliderFrameHandleImage(slider, DCEI.Texture("fantasy_icon_mob_boss_slimeking"))
DCEI.SetSliderFrameHandleRadius(slider, 32)
DCEI.ShowSliderFrameHandle(slider, true)
DCEI.SetSliderFrameValue(slider, 0.5)
-- Log Value
DCEI.LogError(DCEI.GetSliderFrameValue(slider))
void SetSliderFrameHandleRadius(InGameUILayoutComponent ui, float value)
void SetSliderFrameHandleRadius(InGameUILayoutComponent ui, float value)
Description
Sets the size of the handle (the part you drag to move) on a slider UI frame.
Parameters
- InGameUILayoutComponent
ui
The slider frame. - float
value
the size of the handle.
Example Usage
-- Define callback function
local function OnSliderChange(value)
DCEI.LogMessage(value)
end
-- Create and setup slider
local slider = DCEI.CreateSliderFrame(DCEI.GetUiRootFrame())
DCEI.SetFrameWidth(slider, 500)
DCEI.SetFrameHeight(slider, 60)
-- Slider properties
DCEI.SetOnSliderValueChangeCallback(slider, OnSliderChange)
DCEI.SetSliderFrameBackgroundImage(slider, DCEI.Texture("flat_icon_bar_empty_grey_ipick"))
DCEI.SetSliderFrameFillImage(slider, DCEI.Texture("bar_card_attribute"))
DCEI.SetSliderFrameHandleImage(slider, DCEI.Texture("fantasy_icon_mob_boss_slimeking"))
DCEI.SetSliderFrameHandleRadius(slider, 32)
DCEI.ShowSliderFrameHandle(slider, true)
DCEI.SetSliderFrameValue(slider, 0.5)
-- Log Value
DCEI.LogError(DCEI.GetSliderFrameValue(slider))
void ShowSliderFrameHandle(InGameUILayoutComponent ui, bool show)
void ShowSliderFrameHandle(InGameUILayoutComponent ui, bool show)
Description
Sets the visibility of the handle (the part you drag to move) on a slider UI frame.
Parameters
- InGameUILayoutComponent
ui
The slider frame. - bool
show
set to false to hide slider, true to show.
Example Usage
-- Define callback function
local function OnSliderChange(value)
DCEI.LogMessage(value)
end
-- Create and setup slider
local slider = DCEI.CreateSliderFrame(DCEI.GetUiRootFrame())
DCEI.SetFrameWidth(slider, 500)
DCEI.SetFrameHeight(slider, 60)
-- Slider properties
DCEI.SetOnSliderValueChangeCallback(slider, OnSliderChange)
DCEI.SetSliderFrameBackgroundImage(slider, DCEI.Texture("flat_icon_bar_empty_grey_ipick"))
DCEI.SetSliderFrameFillImage(slider, DCEI.Texture("bar_card_attribute"))
DCEI.SetSliderFrameHandleImage(slider, DCEI.Texture("fantasy_icon_mob_boss_slimeking"))
DCEI.SetSliderFrameHandleRadius(slider, 32)
DCEI.ShowSliderFrameHandle(slider, true)
DCEI.SetSliderFrameValue(slider, 0.5)
-- Log Value
DCEI.LogError(DCEI.GetSliderFrameValue(slider))
void SetSliderFrameValue(InGameUILayoutComponent ui, float value)
void SetSliderFrameValue(InGameUILayoutComponent ui, float value)
Description
Set the current value/slider position for a slider frame. 0 will set the slider handle to the left, 0.5 will set it to the middle, and 1 will set it to the right (completely filled). Any real number between those ranges will position the slider accordingly.
Parameters
- InGameUILayoutComponent
ui
The slider frame. - float
value
value between 1 and 0.
Example Usage
-- Define callback function
local function OnSliderChange(value)
DCEI.LogMessage(value)
end
-- Create and setup slider
local slider = DCEI.CreateSliderFrame(DCEI.GetUiRootFrame())
DCEI.SetFrameWidth(slider, 500)
DCEI.SetFrameHeight(slider, 60)
-- Slider properties
DCEI.SetOnSliderValueChangeCallback(slider, OnSliderChange)
DCEI.SetSliderFrameBackgroundImage(slider, DCEI.Texture("flat_icon_bar_empty_grey_ipick"))
DCEI.SetSliderFrameFillImage(slider, DCEI.Texture("bar_card_attribute"))
DCEI.SetSliderFrameHandleImage(slider, DCEI.Texture("fantasy_icon_mob_boss_slimeking"))
DCEI.SetSliderFrameHandleRadius(slider, 32)
DCEI.ShowSliderFrameHandle(slider, true)
DCEI.SetSliderFrameValue(slider, 0.5)
-- Log Value
DCEI.LogError(DCEI.GetSliderFrameValue(slider))
float GetSliderFrameValue(InGameUILayoutComponent ui)
float GetSliderFrameValue(InGameUILayoutComponent ui)
Description
Get the current value/slider position for a slider frame. Will return 0 if the slider handle is to the left, 0.5 if the middle, and 1 if to the right (completely filled). Will return any real number between those ranges accordingly for other positions.
Parameters
- InGameUILayoutComponent
ui
The slider frame.
Example Usage
-- Define callback function
local function OnSliderChange(value)
DCEI.LogMessage(value)
end
-- Create and setup slider
local slider = DCEI.CreateSliderFrame(DCEI.GetUiRootFrame())
DCEI.SetFrameWidth(slider, 500)
DCEI.SetFrameHeight(slider, 60)
-- Slider properties
DCEI.SetOnSliderValueChangeCallback(slider, OnSliderChange)
DCEI.SetSliderFrameBackgroundImage(slider, DCEI.Texture("flat_icon_bar_empty_grey_ipick"))
DCEI.SetSliderFrameFillImage(slider, DCEI.Texture("bar_card_attribute"))
DCEI.SetSliderFrameHandleImage(slider, DCEI.Texture("fantasy_icon_mob_boss_slimeking"))
DCEI.SetSliderFrameHandleRadius(slider, 32)
DCEI.ShowSliderFrameHandle(slider, true)
DCEI.SetSliderFrameValue(slider, 0.5)
-- Log Value
DCEI.LogError(DCEI.GetSliderFrameValue(slider))