SC2Mapster.com

SC2Mapster.com Wiki

Galaxy / Triggers / Category UI

UI

Alerts

Create Alert With No Source

  • Creates an alert displaying the custom alert text.

Clear Alerts

  • Clears all alerts and spacebar points for the specified player.

Create Alert At Point

  • Creates an alert with a spacebar point (point that the camera will jump to when the player presses the spacebar) at the target point displaying the custom alert text.

Create Alert At Unit

  • Creates an alert with a spacebar point (point that the camera will jump to when the player presses the spacebar) at the target unit displaying the custom alert text.

Boss Bar

Display Boss Bar

  • Creates and shows a boss bar near the top of the screen.

Move Boss Bar

  • Moves the specified boss bar to the specified coordinates.

Refresh Boss Bar

  • Forces the boss bar to redraw.

Set Boss Bar Boss

  • Sets the unit for the specified boss bar. Calling this action will overwrite the maximum and current value you set through "Set Boss Bar Maximum Value" and "Set Boss Bar Current Value", and will instead base its value on the specified unit's HP.

Set Boss Bar Current Value

  • Sets the current value for the specified boss bar. Calling this action will overwrite the boss unit you set through "Set Boss Bar Boss", and will instead rely on the values sent to it through "Set Boss Bar Maximum Value" and "Set Boss Bar Current Value".

Set Boss Bar Maximum Value

  • Sets the maximum value for the specified boss bar. Calling this action will overwrite the boss unit you set through "Set Boss Bar Boss", and will instead rely on the values sent to it through "Set Boss Bar Maximum Value" and "Set Boss Bar Current Value".

Set Boss Bar Race

  • Sets the race for the specified boss bar, which will change its appearance.

Show/Hide Boss Bar

  • Shows or hides the specified boss bar.

_BB_HPBarChange

_BB_HPBarCurrentWidth

_BB_HPBarFormatLabel

_BB_HPBarHeight

_BB_HPBarWidth

_BB_HPBorderHeight

_BB_HPBorderWidth

_BB_PortraitBorderHeight

_BB_PortraitBorderWidth

_BB_PortraitHeight

_BB_PortraitWidth

_BB_TitleBarHeight

_BB_TitleBarWidth

Challenges

Get Challenge High Score

  • This action will only work for Blizzard maps.

Set Challenge Completed

  • This action will only work for Blizzard maps.

Set Challenge High Score

  • This action will only work for Blizzard maps.

Challenge Mode

  • This action will only work for Blizzard maps.

Set Challenge Score Text

  • This action will only work for Blizzard maps.

Custom Dialog

Custom Dialog Result

  • Returns the custom dialog item a player selected. Use in response to "Custom Dialog Dismissed".

Display Custom Dialog

  • Displays a custom dialog. Message Dialogs are informational only and will always have a result of yes. Query dialogs provide the player with a yes or no option.

Game Menu

Game Menu Item Selected

  • Returns the menu item a player selected from the game menu dialog. Use in response to "Game Menu Item Selected".

Hide All Custom Menu Dialog Items

  • Hides all the Custom Menu dialog items.

Set Custom Menu Dialog Item Text

  • Sets the text of a specified Menu Item in the Custom Menu.

Show/Hide Custom Menu Dialog Item

  • Shows or hides the specified Menu Item in the Custom Menu.

Set Game Menu Dialog Item Text

  • Sets the text of a specified menu item in the game menu. Allows customization of the F10 menu.

Show/Hide Game Menu Dialog Item

  • Shows or hides the specified menu item in the game menu. Allows customization of the F10 menu.

Show Custom Menu

  • The Custom Menu is similiar in look and functionality to the Game Menu (F10 Menu). However, the Custom Menu doesn't force items on or off based on the current state of the game.

Game UI

Show/Hide Achievement Panel

  • Shows or hides the achievement panel for the specified players.

For Each UI Frame

  • Loops through all UI frames.

Show/Hide Game UI

  • Shows or hides the entire game UI.

Clear BattleNet Button Offset

  • Clear the custom positioning of the BattleNet Button. This will cause it to return to the default location

Unlock Flyer Helper Display

  • Unlocks flyer helper display for the player group.

Lock Flyer Helper Display

  • Locks the flyer helper display that is selected for all players in the player group.

UI Frame Is Visible

  • Returns true if the specified UI frame is visible for the specified player.

Set BattleNet Button Offset

  • Allows custom positioning of the BattleNet Button, relative to the bottom right corner of the screen. Note that there is a "safe rect" constraint that prevents the button and friends list from being too far to the left or too far upwards.

Turn Ability Highlight On/Off

  • The buttons for a highlighted ability command are flashed in the user's command card UI. If the ability command is contained in a sub-page, like one of the standard "build" commands, the button for the sub-page itself will also be highlighted.

Enable/Disable Command Type

  • Enables or disables certain types of interface commands. Use the "Set Command Type Disabled Message" action to customize the message that is displayed when the player attempts to use commands disabled in this manner.

Set Command Type Disabled Message

  • Specifies the message to be displayed to players when they attempt to use a command that has been disabled by the "Enable/Disable Command Type" action.

Enable/Disable Mouse Cursor Auto Hide

  • Auto hide causes the mouse cursor to automatically be hidden if the user hasn't moved the cursor for a period of time. The cursor will also automatically be shown whenever the cursor is moved.

Show/Hide Mouse Cursor

  • Shows or hides the mouse cursor for the specified players.

Enable/Disable Drag Selection

  • If drag selection is disabled, the selection box will no longer appear when left clicking and holding down the button while moving the mouse cursor

Show/Hide UI Frame

  • Shows or hides the specified frame in the user interface. Only Blizzard maps are allowed to hide the Battle UI frame.

Set Minimap Background Color

  • Sets the minimap background color.

Show/Hide Minimap Camera Field of View

  • Sets the minimap camera field of view visibility.

Set Screen Mode

  • Changes the screen mode for the player group over the duration specified.

Show/Hide World

  • Shows or hides the 3D game world for the players specified.

Unlock Ally Color Setting

  • Unlocks ally color settings for the player group.

Lock Ally Color Setting

  • Locks the ally color setting that is selected for all players in the player group.

_Store Game UI Visible States

Help Panel

Format Tip Title

  • Returns the specified text string with some formatting added to it.

Create Cheat

  • Creates a tip on the help panel with a button that must be pressed in order for the description to be displayed.

Create Tip

  • Creates a tip that will display above the command card, and also adds the tip to the help panel.

Create Tutorial

  • Creates a tutorial that will display above the command card, and also adds the tutorial to the help panel.

Destroy All Tips

Destroy All Tutorials

Display Help Page

  • Shows the help panel set to the specified page for the specified players.

Enable/Disable Help Panel Tech Glossary Button

  • Enables or disables the glossary button on the help panel for the specified players.

Enable/Disable Help Panel Tech Tree Button

  • Enables or disables the tech tree button on the help panel for the specified players.

Show/Hide Help Panel Tech Tree Race

  • Shows or hides a specific race's tech tree on the help panel.

Show/Hide Help For Unit

  • Determines whether or not a unit type will show up in the help panel.

Set Help Panel Default Visibility

  • Determines whether or not units show up in the help panel by default. Use the "Show/Hide Help For Unit" action to show or hide individual unit types.

Clear All Tip Alerts

  • Clears all currently displayed tip alerts. Does not remove the tips themselves, which can still be viewed in the help panel.

Input

Button Pressed

  • Returns the button pressed. Use in response to a "Button Pressed" event.

Alt Key Pressed

  • Returns true if the alt key was pressed. Use in response to a "Key Pressed" or "Mouse Clicked" event.

Control Key Pressed

  • Returns true if the control key was pressed. Use in response to a "Key Pressed" or "Mouse Clicked" event.

Key Pressed

  • Returns the key pressed. Use in response to a "Key Pressed" event.

Shift Key Pressed

  • Returns true if the shift key was pressed. Use in response to a "Key Pressed" or "Mouse Clicked" event.

Mouse Clicked Button

  • Returns the mouse button clicked. Use in response to a "Mouse Clicked" event.

Mouse Clicked UI Pos X

  • Returns the mouse position clicked in the X axis. Use in response to a "Mouse Clicked" event.

Mouse Clicked World Pos X

  • Returns the mouse position clicked in the X axis. Use in response to a "Mouse Clicked" event.

Mouse Clicked UI Pos Y

  • Returns the mouse position clicked in the Y axis. Use in response to a "Mouse Clicked" event.

Mouse Clicked World Pos Y

  • Returns the mouse position clicked in the Y axis. Use in response to a "Mouse Clicked" event.

Mouse Clicked World Pos Z

  • Returns the mouse position clicked in the Z axis. Use in response to a "Mouse Clicked" event.

Mouse Moved UI Pos X

  • Returns the mouse position in the X axis. Use in response to a "Mouse Moved" event.

Mouse Moved World Pos X

  • Returns the mouse position in the X axis. Use in response to a "Mouse Moved" event.

Mouse Moved UI Pos Y

  • Returns the mouse position in the Y axis. Use in response to a "Mouse Moved" event.

Mouse Moved World Pos Y

  • Returns the mouse position in the Y axis. Use in response to a "Mouse Moved" event.

Mouse Moved World Pos Z

  • Returns the mouse position in the Z axis. Use in response to a "Mouse Moved" event.

Resource Trading

Set Resource Trade Countdown Time

  • Disables resource trading for the specified amount of time in seconds.

Set Resource Trading Allowed

  • Allows or disallows resource trading for the specified Resource Type

Set Resource Trading Major Step

  • The major step is the amount incremented by clicking the arrows in the Team Resource Panel with the control key held down

Set Resource Trading Minor Step

  • The minor step is the amount incremented by clicking the arrows in the Team Resource Panel

Text

Clear Text Messages

  • Clears all text messages currently displayed on the screen.

Text Message

  • Displays a text message in the specified area of the screen.

Error Message

  • Displays an error message.

Hide Cinematic Text

  • Hides all cinematic text that is currently displaying for the specified players.

Hide Text Crawl

  • Hides text crawls that are currently displaying for the specified players.

Show Cinematic Text

  • Displays the specified text in the cinematic text area using the specified parameters.

Show Text Crawl

  • Displays text that types out one character at a time over the specified duration.

Transitions

Set Next Movie

  • The specified movie will play for the given players after the game finishes.

Set Next Loading Screen

  • Creates the next loading screen if transitioning to a new map from the current one.

Set Next Loading Screen Image Scale

  • Sets the next loading screen image scaling method if transitioning to a new map from the current one.

Set Next Loading Screen Text Position

  • Adjusts the text position of the next loading screen if transitioning to a new map from the current one.

Set Restart Loading Screen Tip

  • Sets the loading screen tip to use when restarting the current map.

You must login to post a comment. Don't have an account? Register to get one!

Table of contents

  1. 1 UI
    1. 1.1 Alerts
      1. 1.1.1 Create Alert With No Source
      2. 1.1.2 Clear Alerts
      3. 1.1.3 Create Alert At Point
      4. 1.1.4 Create Alert At Unit
    2. 1.2 Boss Bar
      1. 1.2.1 Display Boss Bar
      2. 1.2.2 Move Boss Bar
      3. 1.2.3 Refresh Boss Bar
      4. 1.2.4 Set Boss Bar Boss
      5. 1.2.5 Set Boss Bar Current Value
      6. 1.2.6 Set Boss Bar Maximum Value
      7. 1.2.7 Set Boss Bar Race
      8. 1.2.8 Show/Hide Boss Bar
      9. 1.2.9 _BB_HPBarChange
      10. 1.2.10 _BB_HPBarCurrentWidth
      11. 1.2.11 _BB_HPBarFormatLabel
      12. 1.2.12 _BB_HPBarHeight
      13. 1.2.13 _BB_HPBarWidth
      14. 1.2.14 _BB_HPBorderHeight
      15. 1.2.15 _BB_HPBorderWidth
      16. 1.2.16 _BB_PortraitBorderHeight
      17. 1.2.17 _BB_PortraitBorderWidth
      18. 1.2.18 _BB_PortraitHeight
      19. 1.2.19 _BB_PortraitWidth
      20. 1.2.20 _BB_TitleBarHeight
      21. 1.2.21 _BB_TitleBarWidth
    3. 1.3 Challenges
      1. 1.3.1 Get Challenge High Score
      2. 1.3.2 Set Challenge Completed
      3. 1.3.3 Set Challenge High Score
      4. 1.3.4 Challenge Mode
      5. 1.3.5 Set Challenge Score Text
    4. 1.4 Custom Dialog
      1. 1.4.1 Custom Dialog Result
      2. 1.4.2 Display Custom Dialog
    5. 1.5 Game Menu
      1. 1.5.1 Game Menu Item Selected
      2. 1.5.2 Hide All Custom Menu Dialog Items
      3. 1.5.3 Set Custom Menu Dialog Item Text
      4. 1.5.4 Show/Hide Custom Menu Dialog Item
      5. 1.5.5 Set Game Menu Dialog Item Text
      6. 1.5.6 Show/Hide Game Menu Dialog Item
      7. 1.5.7 Show Custom Menu
    6. 1.6 Game UI
      1. 1.6.1 Show/Hide Achievement Panel
      2. 1.6.2 For Each UI Frame
      3. 1.6.3 Show/Hide Game UI
      4. 1.6.4 Clear BattleNet Button Offset
      5. 1.6.5 Unlock Flyer Helper Display
      6. 1.6.6 Lock Flyer Helper Display
      7. 1.6.7 UI Frame Is Visible
      8. 1.6.8 Set BattleNet Button Offset
      9. 1.6.9 Turn Ability Highlight On/Off
      10. 1.6.10 Enable/Disable Command Type
      11. 1.6.11 Set Command Type Disabled Message
      12. 1.6.12 Enable/Disable Mouse Cursor Auto Hide
      13. 1.6.13 Show/Hide Mouse Cursor
      14. 1.6.14 Enable/Disable Drag Selection
      15. 1.6.15 Show/Hide UI Frame
      16. 1.6.16 Set Minimap Background Color
      17. 1.6.17 Show/Hide Minimap Camera Field of View
      18. 1.6.18 Set Screen Mode
      19. 1.6.19 Show/Hide World
      20. 1.6.20 Unlock Ally Color Setting
      21. 1.6.21 Lock Ally Color Setting
      22. 1.6.22 _Store Game UI Visible States
    7. 1.7 Help Panel
      1. 1.7.1 Format Tip Title
      2. 1.7.2 Create Cheat
      3. 1.7.3 Create Tip
      4. 1.7.4 Create Tutorial
      5. 1.7.5 Destroy All Tips
      6. 1.7.6 Destroy All Tutorials
      7. 1.7.7 Display Help Page
      8. 1.7.8 Enable/Disable Help Panel Tech Glossary Button
      9. 1.7.9 Enable/Disable Help Panel Tech Tree Button
      10. 1.7.10 Show/Hide Help Panel Tech Tree Race
      11. 1.7.11 Show/Hide Help For Unit
      12. 1.7.12 Set Help Panel Default Visibility
      13. 1.7.13 Clear All Tip Alerts
    8. 1.8 Input
      1. 1.8.1 Button Pressed
      2. 1.8.2 Alt Key Pressed
      3. 1.8.3 Control Key Pressed
      4. 1.8.4 Key Pressed
      5. 1.8.5 Shift Key Pressed
      6. 1.8.6 Mouse Clicked Button
      7. 1.8.7 Mouse Clicked UI Pos X
      8. 1.8.8 Mouse Clicked World Pos X
      9. 1.8.9 Mouse Clicked UI Pos Y
      10. 1.8.10 Mouse Clicked World Pos Y
      11. 1.8.11 Mouse Clicked World Pos Z
      12. 1.8.12 Mouse Moved UI Pos X
      13. 1.8.13 Mouse Moved World Pos X
      14. 1.8.14 Mouse Moved UI Pos Y
      15. 1.8.15 Mouse Moved World Pos Y
      16. 1.8.16 Mouse Moved World Pos Z
    9. 1.9 Resource Trading
      1. 1.9.1 Set Resource Trade Countdown Time
      2. 1.9.2 Set Resource Trading Allowed
      3. 1.9.3 Set Resource Trading Major Step
      4. 1.9.4 Set Resource Trading Minor Step
    10. 1.10 Text
      1. 1.10.1 Clear Text Messages
      2. 1.10.2 Text Message
      3. 1.10.3 Error Message
      4. 1.10.4 Hide Cinematic Text
      5. 1.10.5 Hide Text Crawl
      6. 1.10.6 Show Cinematic Text
      7. 1.10.7 Show Text Crawl
    11. 1.11 Transitions
      1. 1.11.1 Set Next Movie
      2. 1.11.2 Set Next Loading Screen
      3. 1.11.3 Set Next Loading Screen Image Scale
      4. 1.11.4 Set Next Loading Screen Text Position
      5. 1.11.5 Set Restart Loading Screen Tip

Facts

Date created
Sep 19, 2010
Last updated
Jan 24, 2011

Authors