SC2Mapster Wiki
Explore
Main Page
All Pages
Interactive Maps
navigation
Main page
Community portal
Recent changes
Random page
Help
SC2MAPSTER
News
Maps
Assets
Teams
Authors
Forums
Paste
Gamepedia
Gamepedia support
Report a bad ad
Help Wiki
Contact us
FANDOM
Fan Central
BETA
Games
Anime
Movies
TV
Video
Wikis
Explore Wikis
Community Central
Start a Wiki
Don't have an account?
Register
Sign In
Sign In
Register
SC2Mapster Wiki
1,003
pages
Explore
Main Page
All Pages
Interactive Maps
navigation
Main page
Community portal
Recent changes
Random page
Help
SC2MAPSTER
News
Maps
Assets
Teams
Authors
Forums
Paste
Gamepedia
Gamepedia support
Report a bad ad
Help Wiki
Contact us
Editing
UI/Layouts
(section)
Back to page
Edit
VisualEditor
View history
Talk (0)
Edit Page
UI/Layouts
Warning:
You are not logged in. Your IP address will be publicly visible if you make any edits. If you
log in
or
create an account
, your edits will be attributed to your username, along with other benefits.
Anti-spam check. Do
not
fill this in!
=Layout= ==What are Layouts== Layouts, are the files used by SC2 to create the User Interface (UI) which the player sees. The UI Editor allows modders to extend or modify the current UI for their needs, by creating new Layouts where the player can declare new frames, or hookup existing frames and modify as they please. ====Tutorial==== The current tutorials cover an outdated method, which is heavily discouraged with newer additions in the editor. They are left here for preservation or until new tutorials are written. Tutorial by: Helral [https://www.sc2mapster.com/forums/resources/tutorials/179504-ui-sc2layout-files-override-method-aiurchef-method/ SC2Layout Files Override Method] explains: #What are Layout Files and how can they help #How to use custom layout files in your map #What does the override file look like #How to adjust the correct frame #How to move a frame #How to hide a frame #How to create an image frame ====Pay attention to these points when working with Layouts==== #Use file="GameUI" when adjusting UI elements which are already available. #Setting an incorrect Type for a Frame might cause the game to crash untested #Hiding frames with <syntaxhighlight lang="xml" inline style="background: none;"><Visible val="False" /></syntaxhighlight> only works for frames which aren't adjusted by the game itself. (no effect e.g. on the portrait or inventory) #Always surround the values with quotes (") ==Template for Custom UI Layouts== Template File (Missing File) <syntaxhighlight lang="xml"> <?xml version="1.0" encoding="utf-8" standalone="yes"?> <Desc> </Desc> </syntaxhighlight> ==Hooking Up Custom UI in The Trigger Editor== When hooking up frames created inside the GameUI (the only place where layouts are created without using triggers to create them), then the frame need to be hooked up using the action [[triggers/hookup-standard-dialog-item|Hookup Standard Dialog Item]]. The path is relative to GameUI, this means if you want to hook up GameUI/UIContainer, the path is UIContainer. If you want to hook up the GameUI/UIContainer/ConsolePanel the path is UIContainer/ConsolePanel. When you create a frame from template using a layout you made you can use [[triggers/hookup-dialog-item-in-panel|Hookup Dialog Item In Panel]] to hook up the frames inside of it. However the parent frame has to have been created from template as a panel. ==[[UI/Special Terms And Symbols| Special Terms And Symbols]]== ==[[UI/Frame object| Frame Object]]== ==[[UI/Frame Properties| Frame Properties]]== ==[[UI/Animations| Animations]]== ==[[UI/State Groups| State Groups]]== ==How to use Layout Files== Since the 1.5 patch, you can now take advantage of the built-in [[UI Editor| UI Editor]] to directly input the xml for your layout files. The previous method, which still works, was to import the layout file via the import editor, and then assign them in the Game UI data type. This import method is described in more detail [http://www.sc2mapster.com/forums/resources/tutorials/20323-ui-sc2layout-files-override-method-aiurchef-method/ here]. ==Additional Information & Resources== *[[UI/Frame Types| List of Frame Types]] *[[UI/UI Elements| List of UI Elements]] *[[FrameElementList| List of Supported Frame Elements]] *[[UI/Examples| Frame Examples/Samples]] {{UI Pages}} [[Category:UI]]
Summary:
Please note that all contributions to the SC2Mapster Wiki are considered to be released under the CC BY-NC-SA
Cancel
Editing help
(opens in new window)
Follow on IG
TikTok
Join Fan Lab