Modding:Trigger actions

From Stardew Valley Wiki
Jump to navigation Jump to search
The following describes the upcoming Stardew Valley 1.6, and may change before release.

Index

This page documents trigger actions, which let content packs perform an action when something happens. (C# mods should usually use SMAPI events instead.)

Overview

Introduction

A trigger action consists of two main parts:

  • The trigger is what causes the action to happen. This can be an entry in Data/TriggerActions, an event command, etc. See built-in triggers.
  • The action is a space-delimited string which defines what to do. For example, AddMail Current Robin adds the Robin letter to the player's mailbox tomorrow. See argument format and built-in actions.

Argument format

Arguments are space-delimited. For example, AddMail Current Abigail_LeoMoved Now calls the AddMail action with three arguments (player: Current, mail ID: Abigail_LeoMoved, and mail type: Now).

If you have spaces within an argument, you can surround it with quotes to keep it together. For example, AddFriendshipPoints "Mister Qi" 10 has two arguments (Mister Qi and 10). You can escape inner quotes with backslashes, like AddFriendshipPoints "Mister \"Qi\"" 10.

Remember that quotes and backslashes inside JSON strings need to be escaped too. For example, "AddFriendshipPoints \"Mister Qi\" 10" will send AddFriendshipPoints "Mister Qi" 10 to the game code. Alternatively, you can use single-quotes for the JSON string instead, like 'AddFriendshipPoints "Mister Qi" 10'.

Actions

Built-in actions

These are the built-in actions which can be used by any trigger. (Other custom actions may be added by C# mods.)

action effect
AddBuff <buff ID>
RemoveBuff <buff ID>
Apply or remove a buff ID for the current player.
AddConversationTopic <topic ID> <day duration> Start a conversation topic for the given number of days. If the topic is already active, this resets its duration to the given number.
RemoveConversationTopic <topic ID> End a conversation topic, if it's active.
AddCookingRecipe <player> <recipe ID>
AddCraftingRecipe <player> <recipe key>
Add a cooking or crafting recipe to the specified player(s).
AddFriendshipPoints <NPC name> <count> Add <count> friendship points between the current player and specified NPC. The <count> can be negative to reduce friendship points.
AddItem <item ID> [count] [quality] Add an item by its qualified or unqualified item ID to the current player's inventory, with an optional count (default 1) and quality (default 0).
RemoveItem <item ID> [count] Deduct items by qualified or unqualified item ID from the current player's inventory, up to a max combined stack size of [count] (default 1).
AddMail <player> <mail ID> [type]
RemoveMail <player> <mail ID> [type]
Add or remove a mail flag or letter for the specified player(s).

The <type> must be one of:

type effect
now In the player's mailbox now.
tomorrow In the player's list of mail arriving in the mailbox tomorrow.
received In the player's list of received mail (bypassing the mailbox).
all Add or remove it everywhere (mailbox, tomorrow's mailbox, and received mail).

If omitted, the <type> defaults to tomorrow for AddMail and all for RemoveMail.

AddMoney <amount> Add the given <amount> of money for the current player. The <amount> can be negative to deduct money.
AddQuest <quest ID>
RemoveQuest <quest ID>
Add or remove a quest for the current player.
AddSpecialOrder <order ID>
RemoveSpecialOrder <order ID>
Add or remove a special order.
IncrementStat <stat key> [amount] Increment a stat value by the given amount (default 1) for the current player. This can be a vanilla stat key (see the PLAYER_STAT game state query for a list) or a custom stat key. The amount can be negative to decrement it.
MarkActionApplied <player> <answer ID> [applied] Mark a Data/TriggerActions entry as applied or non-applied for the specified player(s), depending on [applied] (default true). This can be used to skip or re-run an entry, since Data/TriggerActions entries are only applied once by default.

Note that an entry can't mark itself unapplied (but you can add a second entry which marks the first one unapplied).

MarkEventSeen <player> <event ID> [seen] Mark an event as seen or unseen for the specified player(s), depending on [seen] (default true).
MarkQuestionAnswered <player> <answer ID> [answered] Mark a dialogue answer as selected or non-selected for the specified player(s), depending on [answered] (default true).
Null (Specialized) Does nothing. This is used internally; there's generally no benefit to using it yourself.
SetNpcInvisible <NPC name> <day duration> Hide an NPC so they disappear and can't be interacted with for the given number of days. This is used when NPCs go away for a while (e.g. Elliott's 14-heart event).

TODO: can you call this from the farmhand? Atra doesn't think so.

SetNpcVisible <NPC name> End the NPC's invisibility, if applicable.

TODO: check to see if can be called from farmhand. Will probably make the NPC visible again, but the daysUntilNotInvisible is NOT synced.

Target player

Some conditions have a <player> argument. This can be one of...

value result
All Apply the action to all players (regardless of whether they're online).
Current Apply to the local player.
Host Apply to the main player.

Triggers

Data/TriggerActions

Data/TriggerActions is a data asset which lets you dynamically perform actions when the conditions are met.

For example, consider this Content Patcher patch:

{
    "Format": "1.30.0",
    "Changes": [
        {
            "Action": "EditData",
            "Target": "Data/TriggerActions",
            "Entries": {
                "{{ModId}}_OnLeoMoved": {
                    "Id": "{{ModId}}_OnLeoMoved",
                    "Trigger": "DayEnding",
                    "Condition": "PLAYER_HAS_MAIL Host leoMoved",
                    "Actions": [
                        "AddMail Current {{ModId}}_Abigail_LeoMoved",
                        "AddConversationTopic {{ModId}}_LeoMoved 5"
                    ]
                }
            }
        }
    ]
}

You can read that like: "When the player is going to sleep, if Leo has moved to the valley, then send a letter and start a conversation topic".

Each entry in Data/TriggerActions only runs once by default, though you can use the MarkActionApplied action to re-enable one.

Data/TriggerActions consists of a list of models with these fields:

field effect
Id The unique string ID for this trigger action.
Trigger When to apply the trigger action. This must be one or more of these values (space-delimited):
trigger effect
DayStarted Raised when the player starts a day, after either sleeping or loading.
DayEnding Raised when the player is going to sleep. This happens immediately before the game changes the date, sets up the new day, and saves.
LocationChanged Raised when the player arrives in a location.
other Other custom triggers may be added by C# mods.
Actions (Optional) The actions to perform, as a list of strings matching the action format.
Action (Optional) A single action to perform, matching the action format.

This is just a shortcut for Actions with one action. Technically you can use both together, but usually you should just pick one property to set.

HostOnly (Optional) Whether this trigger action can only run for the main player. If true, the action will be ignored for farmhands in multiplayer.
Condition (Optional) A game state query which indicates whether this action can be applied currently. Defaults to always true.
CustomFields (Optional) The custom fields for this entry.

Elsewhere

You can also run an action directly from...

  • A dialogue string using the $action command. For example:
    "Mon": "Hi there! Here's 10g and a parsnip, don't spend it all at once.#$action AddMoney 10#$action AddItem (O)24"
    
  • An event script using the action command. For example:
    "{{ModId}}_Event": "continue/64 15/farmer 64 16 2 Abigail 64 18 0/pause 1500/speak Abigail \"Hi. Here's 10g and a parsnip.\"/action AddMoney 10/action AddItem (O)24/pause 500/end"
    

    See also the setSkipActions command.

  • A mail letter using the %action command. For example:
    "{{ModId}}_Letter": "Hey there!^Here's 10g and a parsnip. Take care!^   -Abigail%action AddMoney 10%% %action Additem (O)24%%[#]A gift from Abigail"
    
  • The SMAPI console window using the debug action console command. For example:
    > debug action "AddMoney 10"
    
    Applied action 'AddMoney 10'.

For C# mod authors

Using trigger actions in C# data

Trigger actions are mainly meant for Content Patcher packs. C# mod can use SMAPI's events instead, which are much more flexible and efficient (unless you want to let content packs edit your trigger actions).

Extensibility

C# mods can use the StardewValley.Triggers.TriggerActionManager class to interact with trigger actions.

For example, you can...

  • Add and raise a new trigger type:
    // register custom trigger type
    TriggerActionManager.RegisterTrigger("Some.ModId_OnItemReceived");
    
    // run actions in Data/TriggerActions for the custom trigger
    TriggerActionManager.Raise("Some.ModId_OnItemReceived", new[] { item, index }); // trigger can pass optional trigger arguments
    
  • Or add a new action:
    TriggerActionManager.RegisterAction("Some.ModId_PlaySound", this.PlaySound);
    
    ...
    
    /// <inheritdoc cref="TriggerActionDelegate" />
    public static bool PlaySound(string[] args, TriggerActionContext context, out string error)
    {
        // get args
        if (!ArgUtility.TryGet(args, 1, out string soundId, out string error, allowBlank: false))
            return false;
    
        // apply
        Game1.playSound(soundId);
        return true;
    }
    
  • Or run an action string:
    // NOTE: this is just an example of how to run an action. This is meant to support actions specified in data or content
    // packs. If you want to send mail (or perform other actions) in C#, it's better to call the C# APIs directly instead.
    string action = "AddMail Current Robin Now";
    if (!TriggerActionManager.TryRunAction(action, out string error, out Exception ex))
        Game1.log.Error($"Failed running action '{action}': {error}", ex);
    

To avoid conflicts, custom trigger names should be unique string IDs.

FAQs

Trigger actions vs map actions

Actions can refer to two different systems:

  • Trigger actions (this page) let you perform generic background tasks that can be done anytime, like sending a letter or starting a quest. These can be triggered automatically based on conditions, or via commands in dialogue, events, etc.
  • Map actions refer to the Action and TouchAction map properties, which do something when you walk on or interact with a map tile. These can perform a wide array of map- and interaction-specific things like showing a message box, changing the map, opening shop menus, etc. These only work in maps, and generally don't make sense in other contexts.

Aside from the similar names, they're not interchangeable and there's fairly little overlap.

Make Data/TriggerActions repeat

Each entry in Data/TriggerActions is only applied once per player, but you can use the MarkActionApplied action to forget that it was applied. (Note that an action can't forget itself though.)

For example, this patch will set alternating 'work' or 'weekend' mail flags depending on the day of week:

{
    "Format": "1.30.0",
    "Changes": [
        {
            "Action": "EditData",
            "Target": "Data/TriggerActions",
            "Entries": {
                // set 'work' flag on weekdays, and reset weekend action
                "{{ModId}}_Work": {
                    "Id": "{{ModId}}_Work",
                    "Trigger": "DayStarted",
                    "Condition": "!DAY_OF_WEEK Saturday Sunday",
                    "Actions": [
                        "AddMail Current {{ModId}}_Work Received",
                        "RemoveMail Current {{ModId}}_Weekend",
                        "MarkActionApplied Current {{ModId}}_Weekend false"
                    ]
                },

                // set 'weekend' flag on weekends, and reset work action
                "{{ModId}}_Weekend": {
                    "Id": "{{ModId}}_Weekend",
                    "Trigger": "DayStarted",
                    "Condition": "DAY_OF_WEEK Saturday Sunday",
                    "Actions": [
                        "AddMail Current {{ModId}}_Weekend Received",
                        "RemoveMail Current {{ModId}}_Work",
                        "MarkActionApplied Current {{ModId}}_Work false"
                    ]
                },
            }
        }
    ]
}