Triggers/Category Dialog

From SC2Mapster Wiki
Jump to: navigation, search

Contents

Create Specific Dialog Item Actions[edit | edit source]

Create Dialog Item (Achievement)[edit | edit source]

  • Action. Creates an achievement dialog item, using parameters to set up the essential properties for the achievement.

Create Dialog Item (Button)[edit | edit source]

  • Action. Creates a button dialog item, using parameters to set up the essential properties for the button.

Create Dialog Item (Check Box)[edit | edit source]

  • Action. Creates a check box dialog item, using parameters to set up the essential properties for the check box.

Create Dialog Item (Image)[edit | edit source]

  • Action. Creates an image dialog item, using parameters to set up the essential properties for the image. The tiled property will only work if the image type is border.

Create Dialog Item (Label)[edit | edit source]

  • Action. Creates a label dialog item, using parameters to set up the essential properties for the label. If text writeout is set to true, the text that appears within the label will animate as if being written out a single character at a time. Text writeout duration will only work if text writeout is set to true.

Dialog Item Size And Position[edit | edit source]

Dialog Item Anchor[edit | edit source]

  • Function. Returns the anchor for the specified dialog item in relationship to its parent dialog. Requires a Player parameter as different players may have dialogs set up differently.

Dialog Item Height[edit | edit source]

  • Function. Returns the height of a dialog item.

Dialog Item Offset X[edit | edit source]

  • Function. Returns the horizontal offset of a dialog item.

Dialog Item Offset Y[edit | edit source]

  • Function. Returns the vertical offset of a dialog item.

Dialog Item Relative Anchor[edit | edit source]

  • Function. Returns the relative anchor for the specified dialog item. Relative anchor for dialog items is only used by the Move Dialog Item (Relative) action.

Relative Dialog Item[edit | edit source]

  • Function. Returns the dialog item that the specified dialog item is anchored relative to.

Dialog Item Width[edit | edit source]

  • Function. Returns the width of a dialog item.

Dialog Item Is Full Dialog[edit | edit source]

  • Function. Returns true if the specified dialog item is ignoring any size and position set, and instead is using the full size and position of the parent dialog.

Set Dialog Item Size to Parent[edit | edit source]

  • Action. When set to true, the dialog item will ignore any other set size and position and instead always take up the full size and position of its parent. The parent can be either a dialog or a dialog item of type Panel.

Move Dialog Item[edit | edit source]

  • Action. Moves the specified dialog item to the specified anchor of its parent dialog, with the specified offsets.

Attach Dialog Item To Dialog Item[edit | edit source]

  • Action. Moves the specified dialog item to the specified anchor, relative to the anchor of another dialog item, with the specified offsets.

Set Dialog Item Size[edit | edit source]

  • Action. Sets the width and height of a dialog item.

Set Dialog Item Rotation[edit | edit source]

  • Action. Rotates a dialog item.

Dialog Item Tools[edit | edit source]

Destroy Dialog Item[edit | edit source]

  • Action. Destroys the specified dialog item.

Destroy All Dialog Items[edit | edit source]

  • Action. Destroys all dialog items within the specified dialog.

Fade Dialog Item Transparency[edit | edit source]

  • Action. Changes the transparency of a dialog item over time.

Dialog Containing Dialog Item[edit | edit source]

  • Function. Returns the dialog containing the specified dialog item.

Dialog Item Type[edit | edit source]

  • Function. Returns the type of the specified dialog item.

Dialog Item Invoke As String[edit | edit source]

  • Action. Calls a method invoke on a loaded flash dialog item. The flash dialog item must have a flash file loaded which has the specified method name in it. The parameters for the invoked method are optional.

Dialog Item Invoke As Text[edit | edit source]

  • Action. Calls a method invoke on a loaded flash dialog item. The flash dialog item must have a flash file loaded which has the specified method name in it. The parameters for the invoked method are optional.

Dialog Item Color[edit | edit source]

  • Function. Returns the color of a dialog item.

Dialog Item Image[edit | edit source]

  • Function. Returns the image of an image dialog item.

Dialog Item Image Type[edit | edit source]

  • Function. Returns the image type setting for an image dialog item.

Dialog Item Style[edit | edit source]

  • Function. Returns the string value of a dialog item's font style.

Dialog Item Tooltip[edit | edit source]

  • Function. Returns the tooltip text of a dialog item.

Set Dialog Background[edit | edit source]

  • Action. Sets the background image of a dialog.

Set Dialog Item Achievement[edit | edit source]

  • Action. Sets an achievement for the specified dialog item.

Set Dialog Item Blend Mode[edit | edit source]

  • Action. Sets the blend mode for a dialog item.

Set Dialog Item Click On Down[edit | edit source]

  • Action. Set a Trigger Dialog Item to execute its click behavior on mouse down instead of mouse up. While mouse up is the default behavior and used for most buttons in the game, mouse down can be preferred for controls that need a more responsive feel.

Set Dialog Item Color[edit | edit source]

  • Action. Sets the color of a dialog item.

Set Dialog Item Flash[edit | edit source]

  • Action. Sets a flash animation file to play for the specified dialog item.

Set Dialog Item Image[edit | edit source]

  • Action. Sets the image to display on a dialog item.

Set Dialog Item Hover Image[edit | edit source]

  • Action. Sets the hover image to display on a dialog item.

Set Dialog Item Image Type[edit | edit source]

  • Action. Sets how an image is applied to a dialog item.

Set Dialog Item Tiled[edit | edit source]

  • Action. This is for images that are using the border image type. If tiled is set to true, the sides of the image will be repeated to fill the desired height/width. Otherwise they will be stretched.

Set Dialog Item Render Priority[edit | edit source]

  • Action. Sets the render priority for the specified dialog item, which controls the z order that dialog items are rendered. The default render priority is 512. Setting a render priority lower than this means this dialog item should render below other dialog items within the same dialog. Setting a render priority higher than this means the dialog item should render above other dialog items within the same dialog.

Set Dialog Item Style[edit | edit source]

  • Action. Sets the font style for the text of a dialog item using a string value. Font styles can be found in FontStyles.SC2Style.

Set Dialog Item Text Writeout[edit | edit source]

  • Action. If set to true, the text that appears within the dialog item will animate as if being written out a single character at a time.

Set Dialog Item Text Writeout Duration[edit | edit source]

  • Action. This controls the time it takes for the text to animate if "Set Dialog Item Text Writeout" is set to true.

Set Dialog Item Tooltip[edit | edit source]

  • Action. Sets the text that appears when mousing over a dialog item.

Dialog Item Values[edit | edit source]

Add List Item[edit | edit source]

  • Action. Adds a list item to a dialog item with a list, such as a pulldown or a list box.

Count Of List Items[edit | edit source]

  • Function. Returns the count of list items in the dialog item. Only works with dialog items that have lists, such as pulldowns or list boxes.

Selected List Item[edit | edit source]

  • Function. Returns the index of the selected list item for the specified dialog item. Only works with dialog items that have lists, such as pulldowns or list boxes.

Remove All List Items[edit | edit source]

  • Action. Removes all of the list items from the specified dialog item.

Remove List Item[edit | edit source]

  • Action. Removes the list item at the specified index from the specified dialog item for the specified player.

Select List Item[edit | edit source]

  • Action. Selects the specified list index for the specified dialog.

Dialog Item Edit Value[edit | edit source]

  • Function. Returns the string edit value for a dialog item.

Dialog Item Is Checked[edit | edit source]

  • Function. Returns true if the dialog item is checked.

Dialog Item Maximum Value[edit | edit source]

  • Function. Returns the maximum value of a dialog item.

Dialog Item Minimum Value[edit | edit source]

  • Function. Returns the minimum value of a dialog item.

Dialog Item Current Value[edit | edit source]

  • Function. Returns the current value that is set for a dialog item.

Set Dialog Item Checked[edit | edit source]

  • Action. Checks or unchecks a dialog item.

Set Dialog Item Current Value[edit | edit source]

  • Action. Sets the current value for a dialog item.

Set Dialog Item Edit Value[edit | edit source]

  • Action. Sets the string edit value for a dialog item.

Set Dialog Item Maximum Value[edit | edit source]

  • Action. Sets the maximum value for a dialog item.

Set Dialog Item Minimum Value[edit | edit source]

  • Action. Sets the minimum value for a dialog item.

Dialog Item Boolean Value[edit | edit source]

  • Function.

Dialog Item Color Value[edit | edit source]

  • Function.

Dialog Item Control Value[edit | edit source]

  • Function.

Dialog Item Real Value[edit | edit source]

  • Function.

Dialog Item Integer Value[edit | edit source]

  • Function.

Dialog Item String Value[edit | edit source]

  • Function.

Dialog Item Text Value[edit | edit source]

  • Function.

Set Dialog Item Boolean Value[edit | edit source]

  • Action.

Set Dialog Item Color Value[edit | edit source]

  • Action.

Set Dialog Item Control Value[edit | edit source]

  • Action.

Set Dialog Item Real Value[edit | edit source]

  • Action.

Set Dialog Item Integer Value[edit | edit source]

  • Action.

Set Dialog Item String Value[edit | edit source]

  • Action.

Set Dialog Item Text Value[edit | edit source]

  • Action.

Dialog Items[edit | edit source]

Create Dialog Item[edit | edit source]

  • Action. Creates a dialog item, of the specified type, for the specified dialog. A new dialog item will always be anchored to the top left of its parent dialog, with no offset. It can be moved and resized using the "Move Dialog Item" and "Set Dialog Item Size" actions.

Create Dialog Item From Template[edit | edit source]

  • Action. Creates a dialog item, of the specified type, using the specified template for the specified dialog. Dialog item templates are preset, and cannot be user defined. A new dialog item will always be anchored to the top left of its parent dialog, with no offset. It can be moved and resized using the "Move Dialog Item" and "Set Dialog Item Size" actions.

Create Dialog Item In Panel[edit | edit source]

  • Action. Creates a dialog item of the specified type within the specified dialog item panel.

Create Dialog Item In Panel From Template[edit | edit source]

  • Action. Creates a dialog item of the specified type using the specified template within the specified dialog item panel.

Hookup Dialog Item In Panel[edit | edit source]

  • Action. Hooks up an already existing dialog item of the specified type in the specified dialog item panel.

Hookup Standard Dialog Item[edit | edit source]

  • Action.Hooks up an already existing dialog item in the default UI of the specified type. This allows dynamic modification of any frame within the Built-In UI. Frames that were created from locked Descs cannot be hooked up.

Hookup Unit Status Dialog Item[edit | edit source]

  • Action.Hooks up an already existing dialog item of the specified type in the status bar of the specified unit with the specified name.

Dialog Item Is Enabled[edit | edit source]

  • Function. Returns true if the dialog item is enabled for the specified player.

Dialog Item Is Visible[edit | edit source]

  • Function. Returns true if the dialog item is visible for the specified player.

Last Created Dialog Item[edit | edit source]

  • Function. Returns the last created dialog item.

Enable/Disable Dialog Item[edit | edit source]

  • Action. Enable or disable a dialog item. A disabled dialog item is greyed out, and cannot be used.

Show/Hide Dialog Item[edit | edit source]

  • Action. Shows or hides the specified dialog item.

Dialog Item Text[edit | edit source]

  • Function. Returns the text of the dialog item for the specified player.

Used Dialog Item[edit | edit source]

  • Function. Returns the dialog item that was used.

Dialog Item Event Type[edit | edit source]

  • Function. Returns the event type of the dialog item that was used.

Set Dialog Item Text[edit | edit source]

  • Action. Sets the text that appears within the dialog item.

Dialog Size And Position[edit | edit source]

Dialog Anchor[edit | edit source]

  • Function. Returns the anchor for a dialog.

Dialog Height[edit | edit source]

  • Function. Returns the height of a dialog.

Dialog Offset X[edit | edit source]

  • Function. Returns the horizontal offset of a dialog.

Dialog Offset Y[edit | edit source]

  • Function. Returns the vertical offset of a dialog.

Dialog Relative Anchor[edit | edit source]

  • Function. Returns the relative anchor for the specified dialog. Relative anchor for dialogs is only used by the"Move Dialog (Relative)" action.

Relative Dialog[edit | edit source]

  • Function. Returns the dialog that the specified dialog is anchored relative to.

Dialog Width[edit | edit source]

  • Function. Returns the width of a dialog.

Dialog Is Fullscreen[edit | edit source]

  • Function. Returns true if the specified dialog is set to always be sized to the entire screen.

Set Dialog Fullscreen[edit | edit source]

  • Action. Setting a dialog fullscreen will make it ignore any other set position and size and always take up the full screen.

Move Dialog[edit | edit source]

  • Action. Moves a dialog to the specified anchor, with the specified offsets.

Attach Dialog To Dialog[edit | edit source]

  • Action. Moves a dialog to the specified anchor, relative to the anchor of another dialog, with the specified offsets.

Set Dialog Size[edit | edit source]

  • Action. Sets the width and height of a dialog.

Dialog Tools[edit | edit source]

Clear Subtitle Position Override[edit | edit source]

  • Action. Using this function will cause the subtitle panel to return to its default size and position.

Destroy Dialog[edit | edit source]

  • Action. Destroys the specified dialog, and all the dialog items within.

Destroy All Dialogs[edit | edit source]

  • Action. Destroys all dialogs.

Dialog Channel[edit | edit source]

  • Function. Returns the render-to-texture channel the specified dialog is using.

Dialog Background Image[edit | edit source]

  • Function. Returns the background image of the specified dialog.

Dialog Transparency[edit | edit source]

  • Function. Returns the transparency level of the specified dialog.

Dialog Background Image Is Visible[edit | edit source]

  • Function. Returns true if the specified dialog's background image is visible.

Dialog Is Offscreen[edit | edit source]

  • Function. Returns true if the specified dialog is flagged as being offscreen.

Set Dialog RTT Channel[edit | edit source]

  • Action. Sets the render-to-texture channel for the specified dialog.

Show/Hide Dialog Background[edit | edit source]

  • Action. Shows or hides a dialog's background. Dialog items will remain visible.

Set Dialog Offscreen[edit | edit source]

  • Action. An offscren dialog is not rendered normally and is instead used in conjuction with the render-to-texture feature.

Set Subtitle Position Override[edit | edit source]

  • Action. Using this function will cause the subtitle panel to use the bounds of the specified dialog instead of its default size and position.

Set Dialog Transparency[edit | edit source]

  • Action. Sets the transparency of the specified dialog.

Dialog Is Modal[edit | edit source]

  • Function. Returns true if the specified dialog is modal.

==Dialogs

Create Dialog[edit | edit source]

  • Action. Creates a dialog box of specified width, height, position on the screen with offsets

Dialog Title[edit | edit source]

  • Function. Returns the title text of the dialog.

Dialog Is Visible[edit | edit source]

  • Function. Returns true if the dialog is visible.

Last Created Dialog[edit | edit source]

  • Function. Returns the last created dialog.

Set Dialog Title[edit | edit source]

  • Action. Sets the text that is used for the title of the dialog.

Show/Hide Dialog[edit | edit source]

  • Action. Shows or hides the specified dialog. A dialog needs to be shown in order to be seen.

Screen Button[edit | edit source]

Display Screen Button[edit | edit source]

  • Action. Creates a screen button, with an identifier chosen by the ScreenButtonID parameter, at the specified anchor, with the specified size and offset. The Callback parameter determines what trigger is run when this button is used.

Flash Screen Button[edit | edit source]

  • Action. Causes a screen button to change between two colors at the specified interval.

Show/Hide Screen Button[edit | edit source]

  • Action. Shows or hides a screen button, chosen through the ScreenButtonID parameter. A hidden screen button cannot be seen or used.

Screen Button[edit | edit source]

  • Function. Returns the dialog item that is the specified screen button.

Screen Button Dialog[edit | edit source]

  • Function. Returns the dialog the specified screen button belongs to.

Set Screen Button Border Image[edit | edit source]

  • Action. Sets the border image for a screen button.

Set Screen Button Flashing Border Image[edit | edit source]

  • Action. Sets the border image for a screen button for when it is flashing.

Stop Flashing Screen Button[edit | edit source]

  • Action. Causes a screen button to stop flashing.

Screen Image[edit | edit source]

Display Screen Image[edit | edit source]

  • Action. Creates a screen image, with an identifier chosen by the ScreenImageID parameter, at the specified anchor, with the specified size and offset.

Show/Hide Screen Image[edit | edit source]

  • Action. Shows or hides a screen image. Use "Display Screen Image" to create screen images.

Pulse Screen Image[edit | edit source]

  • Action. Causes a screen image to change between two transperency values at the specified interval.

Screen Image Dialog[edit | edit source]

  • Function. Returns the dialog the specified screen button image to. Use "Display Screen Image" to create screen images.

Screen Image Dialog Item[edit | edit source]

  • Function. Returns the dialog item that is the specified screen image. Use "Display Screen Image" to create screen images.

Stop Pulsing Screen Image[edit | edit source]

  • Action. Causes a screen image to stop pulsing.