raw_text = "Action buttons represent an action you can DO, that change the game state or applies changes."
}
}
vbox_component_entry = {
blockoverride "vce_name"
{
raw_text = "Primary Button"
}
blockoverride "vce_area"
{
button_primary = {
raw_text = "Verb Noun"
down = "[GetVariableSystem.Exists('ui_library_down_state')]"
}
button_primary_big = {
raw_text = "Verb Noun"
down = "[GetVariableSystem.Exists('ui_library_down_state')]"
}
}
blockoverride "vce_desc"
{
raw_text = "The Primary Action of a View. There should only be at most one of these per view, though not all views need one. It represents the most important action you can take in the view. It should not have an icon, simply a text. The label should contain a verb, and ideally also a noun."
}
}
vbox_component_entry = {
blockoverride "vce_name"
{
raw_text = "Secondary Button"
}
blockoverride "vce_area"
{
button_round = {
down = "[GetVariableSystem.Exists('ui_library_down_state')]"
button_prison_ransom = {
parentanchor = center
down = "[GetVariableSystem.Exists('ui_library_down_state')]"
}
}
button_standard = {
raw_text = "Verb Noun"
down = "[GetVariableSystem.Exists('ui_library_down_state')]"
}
button_standard_big = {
raw_text = "Verb Noun"
down = "[GetVariableSystem.Exists('ui_library_down_state')]"
}
}
blockoverride "vce_desc"
{
raw_text = "Secondary Actions of a View. There can be many of these in a view. To save space, we sometimes use an icon-only version. The label should contain a verb, and ideally also a noun. Currently we use button_standard for this type, but possibly some of the button_standard should really be button_primary or button_tertiary"
}
}
vbox_component_entry = {
blockoverride "vce_name"
{
raw_text = "Back Button"
}
blockoverride "vce_area"
{
button_standard_back = {
raw_text = "Verb Noun"
down = "[GetVariableSystem.Exists('ui_library_down_state')]"
}
}
blockoverride "vce_desc"
{
raw_text = "This back button type should be used everytime there is a need for a back button, always including the icon to the left."
}
}
vbox_component_entry = {
blockoverride "vce_name"
{
raw_text = "Tertiary Button"
}
blockoverride "vce_area"
{
button_me = {
name = "button_me"
block "button_me" {
visible = yes
}
down = "[GetVariableSystem.Exists('ui_library_down_state')]"
}
button_tertiary = {
raw_text = "Verb Noun"
down = "[GetVariableSystem.Exists('ui_library_down_state')]"
}
}
blockoverride "vce_desc"
{
raw_text = "Rare and non-recommended Actions. Does not currently have an icon-only version. Could possibly have its own unique look instead of being the same as the frontend button"
}
}
vbox_component_entry = {
blockoverride "vce_name"
{
raw_text = "Frontend Button"
}
blockoverride "vce_area"
{
button_frontend = {
raw_text = "Verb Noun"
down = "[GetVariableSystem.Exists('ui_library_down_state')]"
}
}
blockoverride "vce_desc"
{
raw_text = "Action button for the Main Menu and Ingame Menu parts of the game. The same visual importance as a Secondary Button, but one that looks a bit more flavorful."
raw_text = "Regular editbox, allows entry of text on one or more lines"
}
}
vbox_component_entry = {
blockoverride "vce_name"
{
raw_text = "editbox_standard_with_label"
}
blockoverride "vce_area"
{
editbox_standard_with_label = {
blockoverride "editbox_label"
{
raw_text = "Label:"
}
}
}
blockoverride "vce_desc"
{
raw_text = "Regular editbox, with a label. This is preferrable if there is space. The label is above to make sure there is maximum room for the text itself"
raw_text = "View Controls hide or show parts of a UI, but they have no direct effect on the game itself."
}
}
vbox_component_entry = {
blockoverride "vce_name"
{
raw_text = "Tab"
}
blockoverride "vce_area"
{
button_tab = {
raw_text = "Noun"
down = "[GetVariableSystem.Exists('ui_library_down_state')]"
}
}
blockoverride "vce_desc"
{
raw_text = "A tab, gives a mutually exclusive choice of what subview to show. The text on them should simply be a Noun."
}
}
vbox_component_entry = {
blockoverride "vce_name"
{
raw_text = "Vertical Tab"
}
blockoverride "vce_area"
{
button_tab_vertical = {
raw_text = "Noun"
down = "[GetVariableSystem.Exists('ui_library_down_state')]"
}
}
blockoverride "vce_desc"
{
raw_text = "Works the same as a tab, but the tabs are arranged vertically instead. Currently, the only way to toggle it 'selected' is to change the upframe property, instead of using the down property as you would expect."
}
}
vbox_component_entry = {
blockoverride "vce_name"
{
raw_text = "Sidepanel Open"
}
blockoverride "vce_area"
{
button_sidepanel_right = {
down = "[GetVariableSystem.Exists('ui_library_down_state')]"
blockoverride "button_text"
{
raw_text = "View Blablablas"
}
}
}
blockoverride "vce_desc"
{
raw_text = "Opens a sidepanel in a window. Has two versions, one opens a panel to the right, another to the left."
}
}
vbox_component_entry = {
blockoverride "vce_name"
{
raw_text = "Expand/Collapse Heading"
}
blockoverride "vce_area"
{
}
blockoverride "vce_desc"
{
raw_text = "A heading you can click to expand/collapse what is under it."
}
}
vbox_component_entry = {
blockoverride "vce_name"
{
raw_text = "Window Controls"
}
blockoverride "vce_area"
{
buttons_window_control = {
blockoverride "button_go_to" {
visible = yes
}
blockoverride "button_pin"
{
visible = yes
}
blockoverride "button_me" {
visible = yes
}
blockoverride "button_back" {
visible = yes
}
blockoverride "button_minimize" {
visible = yes
}
}
}
blockoverride "vce_desc"
{
raw_text = "Controls in top right that acts on the UI itself, such as closing, minimizing, or pinning the UI for opening at a later time."
raw_text = "Selectors allow the player to choose among a few options. Currently we make no distinction between if this selection affects the gamestate or just what is shown/hidden, or if it is applied immediately or requires some confirmation."
}
}
vbox_component_entry = {
blockoverride "vce_name"
{
raw_text = "Checkbox"
}
blockoverride "vce_area"
{
button_checkbox_label = {}
}
blockoverride "vce_desc"
{
raw_text = "Used to choose between two states. Ideally a checkbox should always have a label, though we sometimes use button_checkbox if there is no room. Some Jomini interfaces do not use button_checkbox_label, mostly because it is too much work to change it."
}
}
vbox_component_entry = {
blockoverride "vce_name"
{
raw_text = "Segmented Control"
}
blockoverride "vce_area"
{
}
blockoverride "vce_desc"
{
text = ""
}
}
vbox_component_entry = {
blockoverride "vce_name"
{
raw_text = "Radiobutton"
}
blockoverride "vce_area"
{
button_radio_label = {}
}
blockoverride "vce_desc"
{
raw_text = "Used to pick one of many options. We don't use this gui type currently because all our radiobuttons are in jomini"
}
}
vbox_component_entry = {
blockoverride "vce_name"
{
raw_text = "dropdown_menu_standard"
}
blockoverride "vce_area"
{
dropdown_menu_standard = {
blockoverride "dropdown_properties"
{
datamodel = "[GetPlayer.GetCourt]"
}
blockoverride "dropdown_size"
{
size = { 300 32 }
}
blockoverride "dropdown_list_maxsize"
{
maximumsize = { 291 250 }
}
}
}
blockoverride "vce_desc"
{
raw_text = "Used to pick one from many options. Use this if space is limited. Note that you NEED a datamodel otherwise it will not even appear"
}
}
vbox_component_entry = {
blockoverride "vce_name"
{
raw_text = "widget_game_rule_option"
}
blockoverride "vce_area"
{
text_single = {
raw_text = "this type spawns errors..."
}
# widget_game_rule_option = {
# }
}
blockoverride "vce_desc"
{
raw_text = "Stepper only used in game rules, can be used in more places if needed"
raw_text = "Coat of Arms are essentially Object Buttons for Titles, Realms, Houses and Dynasties, but we use a few different size so it nice to see them all in one place."
}
}
hbox_text_entry = {
visible = "[Not(IsInGame)]"
blockoverride "hte_text"
{
raw_text = "You have to be in-game to see portraits and coat of arms"
}
}
vbox_component_entry = {
visible = "[IsInGame]"
blockoverride "vce_name"
{
raw_text = "Realm Coat of Arms"
}
blockoverride "vce_area"
{
hbox = {
vbox = {
coa_realm_tiny_crown = {
datacontext = "[GetPlayer]"
}
text_single = {
raw_text = "tiny"
}
}
vbox = {
coa_realm_small_crown = {
datacontext = "[GetPlayer]"
}
text_single = {
raw_text = "small"
}
}
vbox = {
coa_realm_medium_crown = {
datacontext = "[GetPlayer]"
}
text_single = {
raw_text = "medium"
}
}
vbox = {
coa_realm_big_crown = {
datacontext = "[GetPlayer]"
}
text_single = {
raw_text = "big"
}
}
vbox = {
coa_realm_huge_crown = {
datacontext = "[GetPlayer]"
}
text_single = {
raw_text = "huge"
}
}
}
}
blockoverride "vce_desc"
{
raw_text = "Represents a Realm. Has an suffix for '_crown' if a crown should be added so that the Rank of the Realm is clearer."
}
}
vbox_component_entry = {
visible = "[IsInGame]"
blockoverride "vce_name"
{
raw_text = "Title Coat of Arms"
}
blockoverride "vce_area"
{
hbox = {
vbox = {
coa_title_tiny_crown = {
datacontext = "[GetPlayer.GetPrimaryTitle]"
}
text_single = {
raw_text = "tiny"
}
}
vbox = {
coa_title_small_crown = {
datacontext = "[GetPlayer.GetPrimaryTitle]"
}
text_single = {
raw_text = "small"
}
}
vbox = {
coa_title_medium_crown = {
datacontext = "[GetPlayer.GetPrimaryTitle]"
}
text_single = {
raw_text = "medium"
}
}
vbox = {
coa_title_big_crown = {
datacontext = "[GetPlayer.GetPrimaryTitle]"
}
text_single = {
raw_text = "big"
}
}
}
}
blockoverride "vce_desc"
{
raw_text = "Represents a Title. Has an suffix for '_crown' if a crown should be added so that the Rank of the Title is clearer."
raw_text = "Indicators are visual elements that show a certain value or percentage. They usually do not have a way for the player to perform an action."
}
}
vbox_component_entry = {
blockoverride "vce_name"
{
raw_text = "Progressbar"
}
blockoverride "vce_area"
{
progressbar_standard = {
layoutpolicy_horizontal = expanding
value = 40
}
progressbar_standard_transparent = {
layoutpolicy_horizontal = expanding
value = 40
}
progressbar_red = {
layoutpolicy_horizontal = expanding
value = 40
}
progressbar_green = {
layoutpolicy_horizontal = expanding
value = 40
}
progressbar_frozen = {
layoutpolicy_horizontal = expanding
value = 40
}
progressbar_frozen_transparent = {
layoutpolicy_horizontal = expanding
value = 40
}
}
blockoverride "vce_desc"
{
raw_text = "Various standard progressbars"
}
}
vbox_component_entry = {
blockoverride "vce_name"
{
raw_text = "Relative Bar"
}
blockoverride "vce_area"
{
}
blockoverride "vce_desc"
{
raw_text = "Like a Progressbar, but instead of indication progress towards some end, instead it shows the relative relation between two things, like the two sides in a Battle."
}
}
vbox_component_entry = {
blockoverride "vce_name"
{
raw_text = "Indicator backgrounds"
}
blockoverride "vce_area"
{
text_single = {
raw_text = "Status_Good"
using = Status_Good
}
text_single = {
raw_text = "Status_Mixed"
using = Status_Mixed
}
text_single = {
raw_text = "Status_Bad"
using = Status_Bad
}
text_single = {
raw_text = "Status_Highlight"
using = Status_Highlight
}
}
blockoverride "vce_desc"
{
raw_text = "Backgrounds that highlights whether a value is positive, negative, or if we just need to highlight something."
raw_text = "Text formats are defined in 'gui/textformatting.gui'. They are named based on their use rather than their look, so we can tweak them easily."
}
}
vbox_component_entry = {
blockoverride "vce_name"
{
raw_text = "High Contrast (##high)"
}
blockoverride "vce_area"
{
text_single = {
raw_text = "Flygande bäckasiner söka hwila på mjuka tuvor"
default_format = "#high"
}
}
blockoverride "vce_desc"
{
raw_text = "For text that needs to stand out"
}
}
vbox_component_entry = {
blockoverride "vce_name"
{
raw_text = "Medium Contrast (##medium)"
}
blockoverride "vce_area"
{
text_single = {
raw_text = "Flygande bäckasiner söka hwila på mjuka tuvor"
default_format = "#medium"
}
}
blockoverride "vce_desc"
{
raw_text = "For most regular text"
}
}
vbox_component_entry = {
blockoverride "vce_name"
{
raw_text = "Low Contrast (##low)"
}
blockoverride "vce_area"
{
text_single = {
raw_text = "Flygande bäckasiner söka hwila på mjuka tuvor"
default_format = "#low"
}
}
blockoverride "vce_desc"
{
raw_text = "For lowest contrast, mostly for short text and UI elements"
}
}
vbox_component_entry = {
blockoverride "vce_name"
{
raw_text = "Weak (##weak)"
}
blockoverride "vce_area"
{
text_single = {
raw_text = "Flygande bäckasiner söka hwila på mjuka tuvor"
default_format = "#weak"
}
}
blockoverride "vce_desc"
{
raw_text = "Low contrast longer text that explains something that is not very important. For example, filling out an empty state, or instructing how a mechanic works."
}
}
vbox_component_entry = {
blockoverride "vce_name"
{
raw_text = "Flavor (##flavor, ##F)"
}
blockoverride "vce_area"
{
text_single = {
raw_text = "Flygande bäckasiner söka hwila på mjuka tuvor"
default_format = "#flavor"
}
}
blockoverride "vce_desc"
{
raw_text = "For Flavor texts for entities such as Faiths, Men-at-Arms types, etc."
raw_text = "This tab contains our debug and placeholder assets. You can use these whenever there is art missing or in early development to simply wireframe a UI."
}
}
vbox_component_entry = {
blockoverride "vce_name"
{
raw_text = "debug_square"
}
blockoverride "vce_area"
{
debug_square = {}
}
blockoverride "vce_desc"
{
raw_text = "Our classic vintage debug_square. This shouldn't have to be used as much anymore but it's there if you need it."
}
}
vbox_component_entry = {
blockoverride "vce_name"
{
raw_text = "icon_placeholder"
}
blockoverride "vce_area"
{
icon_placeholder = {
size = { 30 30 }
}
}
blockoverride "vce_desc"
{
raw_text = "A placeholder version of an icon which can be used when art isn't made yet. When hooking in icons which have not yet been made by art, simply copy the texture in the gfx/interface/_debug-folder and paste it in the correct game folder. Then change the name to the name specified in the related Jira."
}
}
vbox_component_entry = {
blockoverride "vce_name"
{
raw_text = "flat_icon_standard_placeholder"
}
blockoverride "vce_area"
{
icon_flat_standard_placeholder = {
size = { 30 30 }
}
}
blockoverride "vce_desc"
{
raw_text = "A placeholder version of an icon_flat_standard which can be used when art isn't made yet. This is just a black icon shape with a texture applied on top of it through script. When hooking in icons which have not yet been made by art, simply copy the texture in the gfx/interface/_debug-folder and paste it in the correct game folder. Then change the name to the name specified in the related Jira."
}
}
vbox_component_entry = {
blockoverride "vce_name"
{
raw_text = "button_icon_placeholder"
}
blockoverride "vce_area"
{
button_icon_placeholder = {
size = { 30 30 }
}
}
blockoverride "vce_desc"
{
raw_text = "A placeholder version of an icon_flat_standard which can be used when art isn't made yet. To find out when to use this button type go to the Action Buttons tab in this window for more information."
}
}
vbox_component_entry = {
blockoverride "vce_name"
{
raw_text = "button_round_placeholder"
}
blockoverride "vce_area"
{
button_round_placeholder = {
down = "[GetVariableSystem.Exists('ui_library_down_state')]"
down = "[GetVariableSystem.Exists('ui_library_down_state')]"
}
}
}
blockoverride "vce_desc"
{
raw_text = "A placeholder round button icon which can be used when icon isn't made by art yet. This is very similar to the button_icon type but with the addition of a round frame. To find out when to use this button type go to the Action Buttons tab in this window for more information."
down = "[GetVariableSystem.Exists('ui_library_down_state')]"
}
button_primary_big_placeholder = {
down = "[GetVariableSystem.Exists('ui_library_down_state')]"
}
}
blockoverride "vce_desc"
{
raw_text = "Placeholder version of our primary button. To find out when to use this button type go to the Action Buttons tab in this window for more information."
down = "[GetVariableSystem.Exists('ui_library_down_state')]"
}
button_standard_big_placeholder = {
down = "[GetVariableSystem.Exists('ui_library_down_state')]"
}
}
blockoverride "vce_desc"
{
raw_text = "Placeholder version of our standard button. To find out when to use this button type go to the Action Buttons tab in this window for more information."
}
}
vbox_component_entry = {
blockoverride "vce_name"
{
raw_text = "button_tertiary_placeholder"
}
blockoverride "vce_area"
{
button_tertiary_placeholder = {
down = "[GetVariableSystem.Exists('ui_library_down_state')]"
}
}
blockoverride "vce_desc"
{
raw_text = "Placeholder version of our tertiary button. To find out when to use this button type go to the Action Buttons tab in this window for more information."
}
}
vbox_component_entry = {
blockoverride "vce_name"
{
raw_text = "Text_Placeholder & Debug Text Format (##D)"
}
blockoverride "vce_area"
{
text_single = {
raw_text = "Flygande bäckasiner söka hwila på mjuka tuvor"
using = Text_Placeholder
}
}
blockoverride "vce_desc"
{
raw_text = "Text template format that can be used on texts to make it pink and communicate it's not final. This can be applied to text inside our types: text_single, text_multi etc. To apply this template to text write: using = Text_Placeholder or use ( default_format = ##D )"
