Triggers/Category Story

From SC2Mapster Wiki
Jump to: navigation, search

Contents

Campaign Progress[edit | edit source]

Set Campaign Progress Campaign Finished[edit | edit source]

  • Action. Flags the campaign as finished or unfinished for the specified campaign for the specified player.

Set Campaign Progress Image[edit | edit source]

  • Action. Sets the progress image for the specified campaign for the specified player.

Set Campaign Progress Text[edit | edit source]

  • Action. Sets the progress text for the specified campaign for the specified player.

Set Campaign Progress Tutorial Finished[edit | edit source]

  • Action. Flags the tutorial as finished or unfinished for the specified campaign for the specified player.

Character Sheet[edit | edit source]

Set Character Sheet Description Text[edit | edit source]

  • Action. Sets the description text for the character sheet for the specified players.

Set Character Sheet Name Text[edit | edit source]

  • Action. Sets the name text for the character sheet for the specified players.

Set Character Sheet Model[edit | edit source]

  • Action. Sets the model for the character sheet for the specified players.

Mercenary Panel[edit | edit source]

Create Mercenary[edit | edit source]

  • Action. Creates a new mercenary for the mercenary panel. Use "Last Created Mercenary" to get the mercenary created by this action.

Destroy Mercenary[edit | edit source]

  • Action. Removes the specified mercenary from the mercenary panel.

Selected Mercenary[edit | edit source]

  • Function. Returns the mercenary the specified player currently has selected.

Mercenary Is Recently Purchased[edit | edit source]

  • Function. Returns true if the specified mercenary is flagged as being recently purchased.

Last Created Mercenary[edit | edit source]

  • Function. Returns the last mercenary created using "Create Mercenary".

Enable/Disable Mercenary Panel Close Button[edit | edit source]

  • Action. Enables or disables the close button on the mercenary panel for the specified players.

Enable/Disable Mercenary Panel Dismiss Button[edit | edit source]

  • Action. Enables or disables the dismiss button on the mercenary panel for the specified players.

Purchase Mercenary[edit | edit source]

  • Action. Convenience function to mark the specified mercenary as purchased, recently purchased, and play the purchase animation on it.

Set Mercenary Availability Text[edit | edit source]

  • Action. Sets the availability text for the specified mercenary.

Set Mercenary Cost[edit | edit source]

  • Action. Sets the cost for the specified mercenary.

Set Mercenary CostText[edit | edit source]

  • Action. Sets the cost text for the specified mercenary.

Set Mercenary Description Text[edit | edit source]

  • Action. Sets the description text for the specified mercenary.

Set Mercenary Portrait Image[edit | edit source]

  • Action. Sets the portrait image for the specified mercenary.

Set Mercenary Portrait Model[edit | edit source]

  • Action. Sets the portrait model for the specified mercenary.

Set Mercenary Player Group[edit | edit source]

  • Action. Sets the player group that the specified mercenary will appear for.

Set Mercenary Recently Purchased[edit | edit source]

  • Action. Flags or unflags the specified mercenary as being recently purchased.

Set Mercenary Scene[edit | edit source]

  • Action. Sets the movie that plays when the specified mercenary is selected.

Set Selected Mercenary[edit | edit source]

  • Action. Selects the specified mercenary for the specified player.

Set Mercenary Special Text[edit | edit source]

  • Action. Sets the special text for the specified mercenary.

Set Mercenary State[edit | edit source]

  • Action. Sets the visibility state for the specified mercenary.

Set Mercenary Title Text[edit | edit source]

  • Action. Sets the title text for the specified mercenary.

Set Mercenary Unit Text[edit | edit source]

  • Action. Sets the unit text for the specified mercenary.

Mission Archives Panel[edit | edit source]

Add Mission Archive Achievement[edit | edit source]

  • Action. This will only work on Blizzard maps.

Add Mission Archive[edit | edit source]

  • Action. Adds a mission or scene to the mission archives panel for the specified players. Use "Last Created Mission Archive" to get the mission archive created through this action.

Remove Mission Archive[edit | edit source]

  • Action. Removes the specified mission archive from the mission archive panel.

Last Created Mission Archive[edit | edit source]

  • Function. Returns the last mission archive created using "Add Mission Archive".

Selected Mission Archive[edit | edit source]

  • Function. Returns the mission archive that the specified player currently has selected.

Set Selected Mission Archive[edit | edit source]

  • Action. Sets which mission archive is selected on the mission archive panel for the specified player group.

Set Mission Archive Best Time Text[edit | edit source]

  • Action. Sets the best time text for the specified mission archive.

Set Mission Archive Bonus Text[edit | edit source]

  • Action. Sets the bonus text for the specified mission archive.

Set Mission Archive Bonus Title[edit | edit source]

  • Action. Sets the bonus title for the specified mission archive.

Set Mission Archive Button Image[edit | edit source]

  • Action. Sets the button image for the specified mission archive.

Set Mission Archive Button Text[edit | edit source]

  • Action. Sets the button text for the specified mission archive.

Set Mission Archive Difficulty Best Time Text[edit | edit source]

  • Action. Sets the dificulty-specific best time text for the specified mission archive.

Set Mission Archive Difficulty Completed[edit | edit source]

  • Action. Flags a difficulty level as completed for the specified mission archive.

Set Mission Archive Mission Image[edit | edit source]

  • Action. Sets the mission image for the specified mission archive.

Set Mission Archive Mission Text[edit | edit source]

  • Action. Sets the mission text for the specified mission archive.

Set Mission Archive Priority[edit | edit source]

  • Action. Sets the priority for the specified mission archive.

Set Mission Archive Research Text[edit | edit source]

  • Action. Sets the research text for the specified mission archive.

Set Mission Archive Research Title[edit | edit source]

  • Action. Sets the research title for the specified mission archive.

Set Mission Archive Scene Image[edit | edit source]

  • Action. Sets the scene image for the specified mission archive.

Set Mission Archive Scene Text[edit | edit source]

  • Action. Sets the scene text for the specified mission archive.

Show Mission Archive in Missions Completed Total[edit | edit source]

  • Action. If this mission archive is flagged as a mission, this will determine if this mission is counted in the missions completed section of the mission archive panel.

Set Mission Archive State[edit | edit source]

  • Action. Sets the visibility state for the specified mission archive.

Selected Mission Archive Difficulty[edit | edit source]

  • Function. Returns the mission archive mission difficulty that was last selected. Only valid in response to "Mission Archives Panel Play Mission" events.

Selected Mission Archive Mission[edit | edit source]

  • Function. Returns the mission archive mission selected. Only valid in response to "Mission Archives Panel Play Mission" events.

Selected Mission Archive Scene[edit | edit source]

  • Function. Returns the mission archive scene selected. Only valid in response to "Mission Archives Panel Play Scene" events.

Modes And Sets[edit | edit source]

Campaign Mode[edit | edit source]

  • Action. Turns campaign mode on or off for a player group. This will only work for Blizzard maps.

Player In Story Mode[edit | edit source]

  • Function. Returns true if the specified player is in story mode. Use the "Story Mode" action to turn story mode on and off for a player.

Story Mode[edit | edit source]

  • Action. Turns story mode on or off for a player group. This will only work for Blizzard maps.

Story Set Change[edit | edit source]

  • Action. Prepares the graphics engine for a set change.

_Story Mode On/Off For Player[edit | edit source]

  • Action.

_Story Mode On/Off For Player Group[edit | edit source]

  • Action.

_Story Mode Hide UI[edit | edit source]

  • Action.

_Story Mode Restore UI[edit | edit source]

  • Action.

_Story Mode Internal[edit | edit source]

  • Action.

Planet Panel[edit | edit source]

Selected Mission Difficulty[edit | edit source]

  • Function. Returns the desired difficulty at which the player wanted to play the mission.

Clicked Planet[edit | edit source]

  • Function. Returns the planet that triggered "Planet Panel Mission Selected".

Clear Selected Planet[edit | edit source]

  • Action. Clears the planet selection on the planet panel for the specified players.

Selected Planet[edit | edit source]

  • Function. Returns the planet the specified player has selected.

Planet Panel Contact Button State[edit | edit source]

  • Function. Returns the current state of the contact button on the planet panel.

Enable/Disable Planet Panel Close Button[edit | edit source]

  • Action. Enables or disables the close button on the planet panel for the specified players.

Set Planet Panel Close Button Shortcut[edit | edit source]

  • Action. Sets the hotkey for the close button on the planet panel for the specified players.

Set Planet Panel Close Button Text[edit | edit source]

  • Action. Sets the text that is displayed on the close button on the planet panel for the specified players.

Set Planet Panel Close Button Tooltip[edit | edit source]

  • Action. Sets the tooltip text for the close button on the planet panel for the specified players.

Set Planet Panel Background Image[edit | edit source]

  • Action. Sets the background image for the planet panel for the specified players.

Set Planet Panel Contact Button State[edit | edit source]

  • Action. Sets the state of the contact button on the planet panel for the specified players.

Enable/Disable Planet Panel Dismiss Button[edit | edit source]

  • Action. Enables or disables the dismiss button on the planet panel for the specified players.

Set Selected Planet[edit | edit source]

  • Action. Selects the specified planet on the planet panel for the specified players.

Set Planet Background Model[edit | edit source]

  • Action. Sets the background model for the specified planet.

Set Planet Bonus Text[edit | edit source]

  • Action. Sets the bonus description for the specified planet.

Set Planet Bonus Title[edit | edit source]

  • Action. Sets the bonus title for the specified planet.

Set Planet Contact Model[edit | edit source]

  • Action. Sets the model for the contact for the specified planet.

Set Planet Contact Name[edit | edit source]

  • Action. Sets the contact name for the specified planet.

Set Planet Contact Title[edit | edit source]

  • Action. Sets the contact title for the specified planet.

Set Planet Contact Tooltip[edit | edit source]

  • Action. Sets the tooltip for the contact for the specified planet.

Set Planet Description[edit | edit source]

  • Action. Sets the description text for the specified planet.

Set Planet Mission Name[edit | edit source]

  • Action. Sets the mission name for the specified planet.

Set Planet Mission Title[edit | edit source]

  • Action. Sets the mission title for the specified planet.

Set Planet Model[edit | edit source]

  • Action. Sets the model for the specified planet.

Set Planet Name[edit | edit source]

  • Action. Sets the name fo the specified planet.

Set Planet Frame Text[edit | edit source]

  • Action. Sets the frame text for the specified planet.

Set Planet Players[edit | edit source]

  • Action. Sets the player group that the specified planet will display for.

Set Planet Primary Objective Text[edit | edit source]

  • Action. Sets the primary objective description for the specified planet.

Set Planet Primary Objective Title[edit | edit source]

  • Action. Sets the primary objective title for the specified planet.

Set Planet Research Text[edit | edit source]

  • Action. Sets the research description for the specified planet.

Set Planet Research Title[edit | edit source]

  • Action. Sets the research title for the specified planet.

Set Planet Reward Text[edit | edit source]

  • Action. Sets the reward description for the specified planet.

Set Planet Reward Title[edit | edit source]

  • Action. Sets the reward title for the specified planet.

Set Planet Secondary Objective Text[edit | edit source]

  • Action. Sets the secondary objective description for the specified planet.

Set Planet Secondary Objective Title[edit | edit source]

  • Action. Sets the secondary objective title for the specified planet.

Set Planet State[edit | edit source]

  • Action. Sets the visibility state of the specified planet.

Set Planet Technology Icon[edit | edit source]

  • Action. Sets the icon for the tech for the specified planet.

Set Planet Technology Name[edit | edit source]

  • Action. Sets the name for the tech for the specified planet.

Set Planet Technology Text[edit | edit source]

  • Action. Sets the description for the tech for the specified planet.

Set Planet Technology Title[edit | edit source]

  • Action. Sets the title for the tech for the specified planet.

Set Planet Technology Tooltip[edit | edit source]

  • Action. Sets the tooltip for the tech for the specified planet.

Set Planet Technology Unit[edit | edit source]

  • Action. Sets the unit for the tech for the specified planet.

Set Planet Tooltip[edit | edit source]

  • Action. Sets the tooltip for the specified planet.

Create Planet[edit | edit source]

  • Action. Creates a new planet on the planet panel for the specified players. Use "Last Created Planet" to refer to the planet that was created.

Destroy Planet[edit | edit source]

  • Action. Removes the specified planet from the planet panel.

Destroy All Planets[edit | edit source]

  • Action. Removes all planets from the planet panel for the specified players.

Last Created Planet[edit | edit source]

  • Function. Returns the last planet created with "Create Planet".

Research Panel[edit | edit source]

Create Research Category[edit | edit source]

  • Action. Creates a new research category for the research panel. Use "Last Created Research Category" to get the research category created by this action.

Destroy Research Category[edit | edit source]

  • Action. Removes the specified research category from the research panel.

Destroy All Research Categories[edit | edit source]

  • Action. Removes all research categories from the research panel for the specified players.

Last Created Research Category[edit | edit source]

  • Function. Returns the last research category created using "Create Research Category".

Set Research Category Current Level[edit | edit source]

  • Action. Sets the current level for the specified research category to the specified level.

Set Research Category Last Level[edit | edit source]

  • Action. Sets the last level for the specified research category to the specified level.

Set Research Category Name[edit | edit source]

  • Action. Sets the name for the specified research category.

Create Research Item[edit | edit source]

  • Action. Creates a new research item for the research panel. Use "Last Created Research Item" to get the research item created by this action.

Destroy Research Item[edit | edit source]

  • Action. Removes the specified research item from the research panel.

Selected Research Item[edit | edit source]

  • Function. Returns the research item the specified player has selected.

Research Item Is Recently Purchased[edit | edit source]

  • Function. Returns true if the specified research item is flagged as recently purchased.

Last Created Research Item[edit | edit source]

  • Function. Returns the last research item created using "Create Research Item".

Purchase Research Item[edit | edit source]

  • Action. Combined with the "Set Research Tier Max Purchases Allowed", this function will perform logic to mark the given research item as purchased, and flag any other research items in the tier that are past the max purchases allowed as disabled.

Set Research Item Confirmation[edit | edit source]

  • Action. Sets the confirmation text of the specified research item.

Set Research Item Description[edit | edit source]

  • Action. Sets the description of the specified research item.

Set Research Item Icon[edit | edit source]

  • Action. Sets the icon for the specified research item.

Set Research Item Movie[edit | edit source]

  • Action. Sets the movie that will be shown when the specified research item is selected.

Set Research Item Name[edit | edit source]

  • Action. Sets the name of the specified research item.

Set Research Item Recently Purchased[edit | edit source]

  • Action. Flags or unflags a research item as being recently purchased.

Set Selected Research Item[edit | edit source]

  • Action. Selects the specified research item for the specified players.

Set Research Item State[edit | edit source]

  • Action. Sets the enabled state of the specified research item.

Set Research Item Tooltip[edit | edit source]

  • Action. Sets the tooltip of the specified research item.

Create Research Tier[edit | edit source]

  • Action. Creates a new research tier for the research panel. Use "Last Created Research Tier" to get the research tier created by this action.

Destroy Research Tier[edit | edit source]

  • Action. Removes the specified research tier from the research panel.

Destroy All Research Tiers[edit | edit source]

  • Action. Removes all research tiers from the research panel for the specified players.

Last Created Research Tier[edit | edit source]

  • Function. Returns the last research tier created using "Create Research Tier".

Set Research Tier Max Purchases Allowed[edit | edit source]

  • Action. If this number is set higher than 0, when setting the state of one of the Research Items of this tier to Purchased, logic will execute to ensure the rest of the Research Items are set to disabled.

Set Research Tier Required Level[edit | edit source]

  • Action. Sets the required level for the specified research tier to the specified level.

Tech Purchase Panel[edit | edit source]

Purchased Purchase Item[edit | edit source]

  • Function. Returns the purchase item that was purchased. Used in response to a "Purchase Made" event.

Selected Purchase Category[edit | edit source]

  • Function. Returns the purchase category that the specified player currently has selected.

Selected Purchase Item[edit | edit source]

  • Function. Returns the purchase item that the specified player currently has selected.

Purchase Item Is Recently Purchased[edit | edit source]

  • Function. Returns true if the specified purchase item is flagged as recently purchased.

Purchase Purchase Item[edit | edit source]

  • Action. Convenience function to mark the specified purchase item as purchased, recently purchased, and play the purchase animation on it.

Set Selected Purchase Category[edit | edit source]

  • Action. Selects the specified purchase category for the specified players.

Set Selected Purchase Item[edit | edit source]

  • Action. Selects the specified purchase item for the specified players.

Create Purchase Category[edit | edit source]

  • Action. Creates a group for purchasable techs for the specified player group. Use "Last Created Purchase Category" to get the purchase category created by this action. Tech purchase actions are used to populate the Hyperion Armory tech purchase UI with data.

Destroy Purchase Category[edit | edit source]

  • Action. Destroys the specified purchase category.

Destroy All Purchase Categories[edit | edit source]

  • Action. Destroys all the tech purchase categories for the specified players.

Last Created Purchase Category[edit | edit source]

  • Function. Returns the last purchase category created using "Create Purchase Category".

Set Purchase Category Name[edit | edit source]

  • Action. Sets the name for the specified purchase category.

Set Purchase Category Players[edit | edit source]

  • Action. Sets the player group for the specified purchase category.

Set Purchase Category Slot[edit | edit source]

  • Action. Sets the slot for the specified purchase category.

Set Purchase Category State[edit | edit source]

  • Action. Sets the visibility state for the specified purchase category.

Create Purchase Group[edit | edit source]

  • Action. Creates a purchase group for the specified purchase category and players. Use "Last Created Purchase Group" to get the purchase group created by this action. Tech purchase actions are used to populate the Hyperion Armory tech purchase UI with data.

Destroy Purchase Group[edit | edit source]

  • Action. Removes the specified purchase group from the tech purchase UI.

Destroy All Purchase Groups[edit | edit source]

  • Action. Destroys all purchase groups for the specified players.

Last Created Purchase Group[edit | edit source]

  • Function. Returns the last purchase group created by the "Create Purchase Group" action.

Set Purchase Group Icon[edit | edit source]

  • Action. Sets the icon for the specified purchase group.

Set Purchase Group Name[edit | edit source]

  • Action. Sets the name for the specified purchase group.

Set Purchase Group Players[edit | edit source]

  • Action. Sets the players for the specified purchase group.

Set Purchase Group Slot[edit | edit source]

  • Action. Sets the slot for the specified purchase group.

Set Purchase Group State[edit | edit source]

  • Action. Sets the visibility state for the specified purchase group.

Set Purchase Group Tooltip[edit | edit source]

  • Action. Sets the tooltip for the specified purchase group.

Set Purchase Group Unit[edit | edit source]

  • Action. Sets the unit for the specified purchase group.

Create Purchase Item[edit | edit source]

  • Action. Creates a purchasable tech item for the specified purchase group and players. Use "Last Created Purchase Item" to get the purchase item created by this action. Tech purchase actions are used to populate the Hyperion Armory tech purchase UI with data.

Destroy Purchase Item[edit | edit source]

  • Action. Removes the specified purchase item from the tech purchase UI.

Destroy All Purchase Items[edit | edit source]

  • Action. Destroys all purchase items for the specified players.

Last Created Purchase Item[edit | edit source]

  • Function. Returns the last purchase item created by the "Create Purchase Item" action.

Set Purchase Item Cost[edit | edit source]

  • Action. Sets the cost for the specified purchase item.

Set Purchase Item Description[edit | edit source]

  • Action. Sets the description for the specified purchase item.

Set Purchase Item Icon[edit | edit source]

  • Action. Sets the icon for the specified purchase item.

Set Purchase Item Movie[edit | edit source]

  • Action. Sets the movie for the specified purchase item.

Set Purchase Item Name[edit | edit source]

  • Action. Sets the name for the specified purchase item.

Set Purchase Item Players[edit | edit source]

  • Action. Sets the player group for the specified purchase item.

Set Purchase Item Recently Purchased[edit | edit source]

  • Action. Flags or unflags the specified purchase item as recently purchased.

Set Purchase Item Slot[edit | edit source]

  • Action. Sets the slot for the specified purchase item.

Set Purchase Item State[edit | edit source]

  • Action. Sets the visibility state for the specified purchase item.

Set Purchase Item Tooltip[edit | edit source]

  • Action. Sets the tooltip for the specified purchase item.

Victory Panel[edit | edit source]

Selected Victory Difficulty[edit | edit source]

  • Function. Returns the desired difficulty at which the player wanted to replay the mission.

Enable/Disable Score Tracking[edit | edit source]

  • Action. Enables or disables tracking of a specific statistic for the specified player.

Enable/Disable All Score Tracking[edit | edit source]

  • Action. Enables or disables all score tracking for the specified player.

Add Victory Panel Achievement[edit | edit source]

  • Action. This will only work with Blizzard maps.

Add Victory Panel Custom Statistic Line[edit | edit source]

  • Action. Adds a custom statistic to the victory panel. While values for tracked statistics are provided by the game, you will have to script actions to collect data for custom statistics.

Add Victory Panel Tracked Statistic[edit | edit source]

  • Action. Adds a statistic to the victory panel.

Clear Victory Panel Custom Statistic Table[edit | edit source]

  • Action. Clears all custom statistic text and values in the victory panel.

Set Victory Panel Achievements Title[edit | edit source]

  • Action. Sets the achievements title on the victory panel.

Set Victory Panel Background Image[edit | edit source]

  • Action. Sets the background image of the victory panel.

Set Victory Panel Custom Statistic Text[edit | edit source]

  • Action. Sets the text for a victory panel custom statistic.

Set Victory Panel Custom Statistic Value[edit | edit source]

  • Action. Sets the value for a victory panel custom statistic.

Set Victory Panel Mission Text[edit | edit source]

  • Action. Sets the mission text on the victory panel.

Set Victory Panel Time Text[edit | edit source]

  • Action. Sets the time text on the victory panel.

Set Victory Panel Time Title[edit | edit source]

  • Action. Sets the time title on the victory panel.

Set Victory Panel Mission Title[edit | edit source]

  • Action. Sets the mission title on the victory panel.

Set Victory Panel Background Model[edit | edit source]

  • Action. Sets the model to be displayed on the victory panel.

Set Victory Panel Reward Credits[edit | edit source]

  • Action. Using this function instead of "Set Victory Panel Reward Text" will cause the credits to count up from 0 to the desired number.

Set Victory Panel Reward Text[edit | edit source]

  • Action. Sets the reward text on the victory panel.

Set Victory Panel Reward Title[edit | edit source]

  • Action. Sets the reward title on the victory panel.

Set Victory Panel Statistics Title[edit | edit source]

  • Action. Sets the statistics title on the victory panel.

Set Victory Panel Summary Background Image[edit | edit source]

  • Action. Sets the background image of the summary section of the victory panel.

Set Victory Panel Victory Text[edit | edit source]

  • Action. Sets the victory text on the victory panel.