_ForgeUser1604162 - SC2 Mapster Forums

Search results for '_ForgeUser1604162'

[Trigger] Universal Yes/No Dialog Mar 21, 2012

_ForgeUser1604162

Join Date: 11/12/2008
Posts: 571
Member Details

Universal Yes/No Dialog

Description

Dialog which will preform different action on Yes,No (any buttons) per call as simple as possible
Usage examples;
- Do you want to sell 'some' item?
- Do you want to kill this player?
- Are you sure you want to leave to group?
All in simple one function call + definition of ActionID - what should happen
note: this method is limited to displaying 1 dialog per player at given time to keep it simple and light
note2: this method is not inline with code. Action selection and execution is handled from separate trigger

Before reading

Any kind of visual modification (text style, labels sizes etc) is up to you. I won't cover it in this tutorial.
Creation process is in code tags. Each - possibly hard - line is explained in // comments
function - function with specified return type.
action - function with no return type.
[size] - indicates array of 'size' size.
<type> - indicates variable of 'type' type.
record - a structure defining group of variables stored under single object.
Player group(Player) - is function inserted in Player Group place found in 'Player Group -> Convert Player to Player Group'

Step 1 - Creating dialog

1.1:

Create record type named "YNDialog" - (right click in list of your triggers etc; New -> New Record)

1.2: Screenshot

In record's variables create - (select your new record type and create variables in right part)

CODE

YNDialog
    Variables
        Main dialog = No Dialog <Dialog>
        Message label = No Dialog Item <Dialog Item>
        Yes button = No Dialog Item <Dialog Item>
        No button = No Dialog Item <Dialog Item>
        ActionID = "" <String[15]> // this will hold currently displayed YNDialog's ActionID for given player

1.3:

Create Global variable of your struct <YNDialog> named YNDialogVar" (whatever) Global variables are those in left window part, not inside any triggers etc

Step 2 - Creating functions

2.1: Screenshot

Create action named YNDialogVar Initialize" - it must be run only once - prior to any attempt of displaying

CODE

YNDialogVar Initialize
    Options: Action
    Return Type: (None)
    Parameters
    Local Variables
    Actions
        // Dialog - Create Dialog
        Dialog - Create a Modal dialog of size (400, 300) at (0, 0) relative to Center of screen
        Variable - Set YNDialogVar.Main dialog = (Last created dialog)
        // Dialog - Create Dialog Item (Label)
        Dialog - Create a label for dialog (Last created dialog) with the dimensions (300, 150) anchored to Top Left with an offset of (50, 50) with the text null color set to White text writeout set to False with a writeout duration of 2.0
        Variable - Set YNDialogVar.Message label = (Last created dialog item)
        // Dialog - Create Dialog Item (Button)
        //     Yes
        Dialog - Create a button for dialog (Last created dialog) with the dimensions (160, 50) anchored to Bottom with an offset of (-90, 50) setting the tooltip to "" with button text "Yes" and the hover image set to ""
        Variable - Set YNDialogVar.Yes button = (Last created dialog item)
        //     No
        Dialog - Create a button for dialog (Last created dialog) with the dimensions (160, 50) anchored to Bottom with an offset of (90, 50) setting the tooltip to "" with button text "No" and the hover image set to ""
        Variable - Set YNDialogVar.No button = (Last created dialog item)

2.2: Screenshot

Create action named "YNDialog Show" - this is what you will call everytime you need to pop Yes/No dialog (remember: one at time, otherwise last window will simply be overwritten)

CODE

YNDialog Show
    Options: Action
    Return Type: (None)
    Parameters
        Player = 0 <Integer>
        Message = No Text <Text>
        ActionID = "" <String>
    Local Variables
    Actions
        // Simple check to preform automatic initialization (optional)
        General - If (Conditions) then do (Actions) else do (Actions)
            If
                YNDialogVar.Main dialog == No Dialog
            Then
                YNDialogVar Initialize()
            Else
        // Dialog - Set Dialog Item Text
        Dialog - SetYNDialogVar.Message label text to Message for (Player group(Player))
		
        Variable - SetYNDialogVar.ActionID[Player] = ActionID
		
        // Dialog - Show/Hide Dialog
        Dialog - Show YNDialogVar.Main dialog for (Player group(Player))

2.3: Screenshot

Create trigger named "YNDialog Trigger" - this is where you will define what will happen on given ActionID

CODE

YNDialog Trigger
    Events
        Dialog - Any Dialog Item is used by Player Any Player with event type Clicked
    Local Variables
        // Yes, No are Boolean variables if you wonder, you can see this at the end of variable declaration in <> tags
        Yes = ((Used dialog item) == YNDialogVar.Yes button) <Boolean>
        // Yes = ?
        // - Double click 'initial value'
        // - Scroll thru list untill you find 'Comparison'
        // - Value 1: Used Dialog Item ( found at bottom of dialog category )
        // - ==
        // - Value 2: YNDialogVar.Yes button ( found in variables section )
        No = ((Used dialog item) == YNDialogVar.No button) <Boolean>
        // Same as above, just use 'No Button'
        Action to execute = "" <String>
    Conditions
        Yes != No
        // ?
        // - if both are 'false' - means button pressed is not one of our buttons - it will fail and skip the rest of trigger
        // - same with both 'true' which is impossible
        // - if only one of those will be 'true' means other one will be 'false' and trigget will run
    Actions
        Dialog - Hide YNDialogVar.Main dialog for (Player group((Triggering player)))
        Variable - Set Action to execute = YNDialogVar.ActionID[(Triggering player)]
		// You define every ActionID's outcomes here inside switch
        General - Switch (Actions) depending on Action to execute
            Cases
                General - If ("Some ActionID")
                    Actions
                        // You can also use switch here if you have more buttons
                        General - If (Conditions) then do (Actions) else do (Actions)
                            If
                                Yes == True
                            Then
                                // do something on YES
                            Else
                                // do something on NO
            Default
                // In case you mistype something
                Debug - Display (Text((Combine ("Missing definition for '", Action to execute, "' ActionID")))) as debug output using Type 1, and Do display it in the game window

Step 3 - Example usage

3.1: Screenshot

Create trigger named "Example trigger"

CODE

Example trigger
    Events
        Timer - Elapsed time is 1.0 Game Time seconds
    Local Variables
    Conditions
    Actions
        // Our target player in this case is player 1
        // Message is "It works?"
        // ActionID will be "test"
        YNDialog Show(1, "It works?", "test")

3.2: Screenshot

Create new case for our "test" ActionID

In our "YNDialog Trigger":

CODE

        General - Switch (Actions) depending on Action to execute
            Cases
                //...
                General - If ("test")
                    Actions
                        General - If (Conditions) then do (Actions) else do (Actions)
                            If
                                Yes == True
                            Then
                                UI - Display "Correct." for (All players) to Subtitle area
                            Else
                                UI - Display "Wrong, it works!" for (All players) to Subtitle area

3.3:

Done. Now just run the map and see if it works.

End

You can see attached map for more examples.

Last edited by _ForgeUser1604162: Mar 27, 2012

To post a comment, please login or register a new account.