Story

Campaign Progress

Set Campaign Progress Campaign Finished

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

Set Campaign Progress Image

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

Set Campaign Progress Text

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

Set Campaign Progress Tutorial Finished

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

Character Sheet

Set Character Sheet Description Text

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

Set Character Sheet Name Text

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

Set Character Sheet Model

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

Mercenary Panel

Create Mercenary

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

Destroy Mercenary

• Removes the specified mercenary from the mercenary panel.

Selected Mercenary

• Returns the mercenary the specified player currently has selected.

Mercenary Is Recently Purchased

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

Last Created Mercenary

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

Enable/Disable Mercenary Panel Close Button

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

Enable/Disable Mercenary Panel Dismiss Button

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

Purchase Mercenary

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

Set Mercenary Availability Text

• Sets the availability text for the specified mercenary.

Set Mercenary Cost

• Sets the cost for the specified mercenary.

Set Mercenary CostText

• Sets the cost text for the specified mercenary.

Set Mercenary Description Text

• Sets the description text for the specified mercenary.

Set Mercenary Portrait Image

• Sets the portrait image for the specified mercenary.

Set Mercenary Portrait Model

• Sets the portrait model for the specified mercenary.

Set Mercenary Player Group

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

Set Mercenary Recently Purchased

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

Set Mercenary Scene

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

Set Selected Mercenary

• Selects the specified mercenary for the specified player.

Set Mercenary Special Text

• Sets the special text for the specified mercenary.

Set Mercenary State

• Sets the visibility state for the specified mercenary.

Set Mercenary Title Text

• Sets the title text for the specified mercenary.

Set Mercenary Unit Text

• Sets the unit text for the specified mercenary.

Mission Archives Panel

Add Mission Archive Achievement

• This will only work on Blizzard maps.

Add Mission Archive

• 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

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

Last Created Mission Archive

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

Selected Mission Archive

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

Set Selected Mission Archive

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

Set Mission Archive Best Time Text

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

Set Mission Archive Bonus Text

• Sets the bonus text for the specified mission archive.

Set Mission Archive Bonus Title

• Sets the bonus title for the specified mission archive.

Set Mission Archive Button Image

• Sets the button image for the specified mission archive.

Set Mission Archive Button Text

• Sets the button text for the specified mission archive.

Set Mission Archive Difficulty Best Time Text

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

Set Mission Archive Difficulty Completed

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

Set Mission Archive Mission Image

• Sets the mission image for the specified mission archive.

Set Mission Archive Mission Text

• Sets the mission text for the specified mission archive.

Set Mission Archive Priority

• Sets the priority for the specified mission archive.

Set Mission Archive Research Text

• Sets the research text for the specified mission archive.

Set Mission Archive Research Title

• Sets the research title for the specified mission archive.

Set Mission Archive Scene Image

• Sets the scene image for the specified mission archive.

Set Mission Archive Scene Text

• Sets the scene text for the specified mission archive.

Show Mission Archive in Missions Completed Total

• 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

• Sets the visibility state for the specified mission archive.

Selected Mission Archive Difficulty

• 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

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

Selected Mission Archive Scene

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

Modes And Sets

Campaign Mode

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

Player In Story Mode

• 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

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

Story Set Change

• Prepares the graphics engine for a set change.

_Story Mode On/Off For Player

_Story Mode On/Off For Player Group

_Story Mode Hide UI

_Story Mode Restore UI

_Story Mode Internal

Planet Panel

Selected Mission Difficulty

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

Clicked Planet

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

Clear Selected Planet

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

Selected Planet

• Returns the planet the specified player has selected.

Planet Panel Contact Button State

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

Enable/Disable Planet Panel Close Button

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

Set Planet Panel Close Button Shortcut

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

Set Planet Panel Close Button Text

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

Set Planet Panel Close Button Tooltip

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

Set Planet Panel Background Image

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

Set Planet Panel Contact Button State

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

Enable/Disable Planet Panel Dismiss Button

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

Set Selected Planet

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

Set Planet Background Model

• Sets the background model for the specified planet.

Set Planet Bonus Text

• Sets the bonus description for the specified planet.

Set Planet Bonus Title

• Sets the bonus title for the specified planet.

Set Planet Contact Model

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

Set Planet Contact Name

• Sets the contact name for the specified planet.

Set Planet Contact Title

• Sets the contact title for the specified planet.

Set Planet Contact Tooltip

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

Set Planet Description

• Sets the description text for the specified planet.

Set Planet Mission Name

• Sets the mission name for the specified planet.

Set Planet Mission Title

• Sets the mission title for the specified planet.

Set Planet Model

• Sets the model for the specified planet.

Set Planet Name

• Sets the name fo the specified planet.

Set Planet Frame Text

• Sets the frame text for the specified planet.

Set Planet Players

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

Set Planet Primary Objective Text

• Sets the primary objective description for the specified planet.

Set Planet Primary Objective Title

• Sets the primary objective title for the specified planet.

Set Planet Research Text

• Sets the research description for the specified planet.

Set Planet Research Title

• Sets the research title for the specified planet.

Set Planet Reward Text

• Sets the reward description for the specified planet.

Set Planet Reward Title

• Sets the reward title for the specified planet.

Set Planet Secondary Objective Text

• Sets the secondary objective description for the specified planet.

Set Planet Secondary Objective Title

• Sets the secondary objective title for the specified planet.

Set Planet State

• Sets the visibility state of the specified planet.

Set Planet Technology Icon

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

Set Planet Technology Name

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

Set Planet Technology Text

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

Set Planet Technology Title

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

Set Planet Technology Tooltip

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

Set Planet Technology Unit

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

Set Planet Tooltip

• Sets the tooltip for the specified planet.

Create Planet

• 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

• Removes the specified planet from the planet panel.

Destroy All Planets

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

Last Created Planet

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

Research Panel

Create Research Category

• 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

• Removes the specified research category from the research panel.

Destroy All Research Categories

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

Last Created Research Category

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

Set Research Category Current Level

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

Set Research Category Last Level

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

Set Research Category Name

• Sets the name for the specified research category.

Create Research Item

• 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

• Removes the specified research item from the research panel.

Selected Research Item

• Returns the research item the specified player has selected.

Research Item Is Recently Purchased

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

Last Created Research Item

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

Purchase Research Item

• 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

• Sets the confirmation text of the specified research item.

Set Research Item Description

• Sets the description of the specified research item.

Set Research Item Icon

• Sets the icon for the specified research item.

Set Research Item Movie

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

Set Research Item Name

• Sets the name of the specified research item.

Set Research Item Recently Purchased

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

Set Selected Research Item

• Selects the specified research item for the specified players.

Set Research Item State

• Sets the enabled state of the specified research item.

Set Research Item Tooltip

• Sets the tooltip of the specified research item.

Create Research Tier

• 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

• Removes the specified research tier from the research panel.

Destroy All Research Tiers

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

Last Created Research Tier

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

Set Research Tier Max Purchases Allowed

• 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

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

Tech Purchase Panel

Purchased Purchase Item

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

Selected Purchase Category

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

Selected Purchase Item

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

Purchase Item Is Recently Purchased

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

Purchase Purchase Item

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

Set Selected Purchase Category

• Selects the specified purchase category for the specified players.

Set Selected Purchase Item

• Selects the specified purchase item for the specified players.

Create Purchase Category

• 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

• Destroys the specified purchase category.

Destroy All Purchase Categories

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

Last Created Purchase Category

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

Set Purchase Category Name

• Sets the name for the specified purchase category.

Set Purchase Category Players

• Sets the player group for the specified purchase category.

Set Purchase Category Slot

• Sets the slot for the specified purchase category.

Set Purchase Category State

• Sets the visibility state for the specified purchase category.

Create Purchase Group

• 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

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

Destroy All Purchase Groups

• Destroys all purchase groups for the specified players.

Last Created Purchase Group

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

Set Purchase Group Icon

• Sets the icon for the specified purchase group.

Set Purchase Group Name

• Sets the name for the specified purchase group.

Set Purchase Group Players

• Sets the players for the specified purchase group.

Set Purchase Group Slot

• Sets the slot for the specified purchase group.

Set Purchase Group State

• Sets the visibility state for the specified purchase group.

Set Purchase Group Tooltip

• Sets the tooltip for the specified purchase group.

Set Purchase Group Unit

• Sets the unit for the specified purchase group.

Create Purchase Item

• 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

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

Destroy All Purchase Items

• Destroys all purchase items for the specified players.

Last Created Purchase Item

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

Set Purchase Item Cost

• Sets the cost for the specified purchase item.

Set Purchase Item Description

• Sets the description for the specified purchase item.

Set Purchase Item Icon

• Sets the icon for the specified purchase item.

Set Purchase Item Movie

• Sets the movie for the specified purchase item.

Set Purchase Item Name

• Sets the name for the specified purchase item.

Set Purchase Item Players

• Sets the player group for the specified purchase item.

Set Purchase Item Recently Purchased

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

Set Purchase Item Slot

• Sets the slot for the specified purchase item.

Set Purchase Item State

• Sets the visibility state for the specified purchase item.

Set Purchase Item Tooltip

• Sets the tooltip for the specified purchase item.

Victory Panel

Selected Victory Difficulty

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

Enable/Disable Score Tracking

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

Enable/Disable All Score Tracking

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

Add Victory Panel Achievement

• This will only work with Blizzard maps.

Add Victory Panel Custom Statistic Line

• 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

• Adds a statistic to the victory panel.

Clear Victory Panel Custom Statistic Table

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

Set Victory Panel Achievements Title

• Sets the achievements title on the victory panel.

Set Victory Panel Background Image

• Sets the background image of the victory panel.

Set Victory Panel Custom Statistic Text

• Sets the text for a victory panel custom statistic.

Set Victory Panel Custom Statistic Value

• Sets the value for a victory panel custom statistic.

Set Victory Panel Mission Text

• Sets the mission text on the victory panel.

Set Victory Panel Time Text

• Sets the time text on the victory panel.

Set Victory Panel Time Title

• Sets the time title on the victory panel.

Set Victory Panel Mission Title

• Sets the mission title on the victory panel.

Set Victory Panel Background Model

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

Set Victory Panel Reward Credits

• 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

• Sets the reward text on the victory panel.

Set Victory Panel Reward Title

• Sets the reward title on the victory panel.

Set Victory Panel Statistics Title

• Sets the statistics title on the victory panel.

Set Victory Panel Summary Background Image

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

Set Victory Panel Victory Text

• Sets the victory text on the victory panel.