Modding:Trigger actions - Revision history

imported>Sunbeam135: /* Make Data/TriggerActions repeat */

2026-01-02T09:48:51Z

Make Data/TriggerActions repeat

← Older revision		Revision as of 09:48, 2 January 2026
Line 362:		Line 362:
	[[Category:Modding]]		[[Category:Modding]]

			[[ru:Модификации:Триггерные действия]]
	[[zh:模组:触发动作]]		[[zh:模组:触发动作]]

imported>Pathoschild: /* Built-in actions */ link IncrementStat to new Modding:Stats page, remove redundant or unneeded info

2025-09-20T21:51:16Z

Built-in actions: link IncrementStat to new Modding:Stats page, remove redundant or unneeded info

← Older revision		Revision as of 21:51, 20 September 2025
Line 87:		Line 87:
	\|-		\|-
	\| <samp>IncrementStat {{t\|stat key}} {{o\|amount}}</samp>		\| <samp>IncrementStat {{t\|stat key}} {{o\|amount}}</samp>
	\| Increment a stat value by the given amount (default 1) for the current player. This can be a vanilla stat key (see the <samp>PLAYER_STAT</samp> [[Modding:Game state queries\|game state query]] for a list) or a custom stat key. If the stat key does not already exist, it will be created. The amount can be negative to decrement it~~. If a stat becomes 0 or less~~, ~~it will~~ be ~~removed~~.		\| Increment a [[Modding:Stats\|stat value]] by the given amount (default 1) for the current player. The amount can be negative to decrement it, but can't be reduced below 0.
	\|-		\|-
	\| <samp>MarkActionApplied {{t\|player}} {{t\|answer ID}} {{o\|applied}}</samp>		\| <samp>MarkActionApplied {{t\|player}} {{t\|answer ID}} {{o\|applied}}</samp>

imported>Spiderbuttons at 19:24, 3 August 2025

2025-08-03T19:24:45Z

← Older revision		Revision as of 19:24, 3 August 2025
Line 87:		Line 87:
	\|-		\|-
	\| <samp>IncrementStat {{t\|stat key}} {{o\|amount}}</samp>		\| <samp>IncrementStat {{t\|stat key}} {{o\|amount}}</samp>
	\| Increment a stat value by the given amount (default 1) for the current player. This can be a vanilla stat key (see the <samp>PLAYER_STAT</samp> [[Modding:Game state queries\|game state query]] for a list) or a custom stat key. If the stat key does not already exist, it will be created. The amount can be negative to decrement it. If a stat becomes 0, it will be removed.		\| Increment a stat value by the given amount (default 1) for the current player. This can be a vanilla stat key (see the <samp>PLAYER_STAT</samp> [[Modding:Game state queries\|game state query]] for a list) or a custom stat key. If the stat key does not already exist, it will be created. The amount can be negative to decrement it. If a stat becomes 0 or less, it will be removed.
	\|-		\|-
	\| <samp>MarkActionApplied {{t\|player}} {{t\|answer ID}} {{o\|applied}}</samp>		\| <samp>MarkActionApplied {{t\|player}} {{t\|answer ID}} {{o\|applied}}</samp>

imported>Spiderbuttons: /* Data/TriggerActions */ Clarify that DayStarted happens before SMAPI's own DayStarted and SaveLoaded events.

2025-06-08T16:16:35Z

Data/TriggerActions: Clarify that DayStarted happens before SMAPI's own DayStarted and SaveLoaded events.

← Older revision		Revision as of 16:16, 8 June 2025
Line 190:		Line 190:
	\|-		\|-
	\| <samp>DayStarted</samp>		\| <samp>DayStarted</samp>
	\| Raised when the player starts a day, after either sleeping or loading.		\| Raised when the player starts a day, after either sleeping or loading. This happens before SMAPI's <samp>DayStarted</samp> ''and'' <samp>SaveLoaded</samp> events.
	\|-		\|-
	\| <samp>DayEnding</samp>		\| <samp>DayEnding</samp>

imported>Spiderbuttons: The duration argument for AddConversationTopic is actually optional and defaults to 4.

2025-05-29T02:09:58Z

The duration argument for AddConversationTopic is actually optional and defaults to 4.

← Older revision		Revision as of 02:09, 29 May 2025
Line 28:		Line 28:
	\| Apply or remove a buff ID for the current player. For <samp>AddBuff</samp>, duration defaults to the buff's default duration if not specified; this value can be <samp>-2</samp> to make the buff last the entire day.		\| Apply or remove a buff ID for the current player. For <samp>AddBuff</samp>, duration defaults to the buff's default duration if not specified; this value can be <samp>-2</samp> to make the buff last the entire day.
	\|-		\|-
	\| <samp>AddConversationTopic {{t\|topic ID}} {{t\|~~day duration~~}}</samp>		\| <samp>AddConversationTopic {{t\|topic ID}} {{o\|days}}</samp>
	\| Start a [[Modding:Dialogue#Conversation topics\|conversation topic]] for the given number of days. If the topic is already active, this resets its duration to the given number.		\| Start a [[Modding:Dialogue#Conversation topics\|conversation topic]] for the given number of {{o\|days}} (default 4). If the topic is already active, this resets its duration to the given number.
	\|-		\|-
	\| <samp>RemoveConversationTopic {{t\|topic ID}}</samp>		\| <samp>RemoveConversationTopic {{t\|topic ID}}</samp>

imported>Spiderbuttons: Clarify how IncrementStat works a bit.

2025-05-22T22:57:34Z

Clarify how IncrementStat works a bit.

← Older revision		Revision as of 22:57, 22 May 2025
Line 87:		Line 87:
	\|-		\|-
	\| <samp>IncrementStat {{t\|stat key}} {{o\|amount}}</samp>		\| <samp>IncrementStat {{t\|stat key}} {{o\|amount}}</samp>
	\| Increment a stat value by the given amount (default 1) for the current player. This can be a vanilla stat key (see the <samp>PLAYER_STAT</samp> [[Modding:Game state queries\|game state query]] for a list) or a custom stat key. The amount can be negative to decrement it.		\| Increment a stat value by the given amount (default 1) for the current player. This can be a vanilla stat key (see the <samp>PLAYER_STAT</samp> [[Modding:Game state queries\|game state query]] for a list) or a custom stat key. If the stat key does not already exist, it will be created. The amount can be negative to decrement it. If a stat becomes 0, it will be removed.
	\|-		\|-
	\| <samp>MarkActionApplied {{t\|player}} {{t\|answer ID}} {{o\|applied}}</samp>		\| <samp>MarkActionApplied {{t\|player}} {{t\|answer ID}} {{o\|applied}}</samp>

imported>Pathoschild: /* Data/TriggerActions */ + SkipPermanentlyCondition (added in 1.6.9)

2025-03-25T17:37:16Z

Data/TriggerActions: + SkipPermanentlyCondition (added in 1.6.9)

← Older revision		Revision as of 17:37, 25 March 2025
Line 212:		Line 212:
	\| <samp>HostOnly</samp>		\| <samp>HostOnly</samp>
	\| ''(Optional)'' Whether this trigger action can only run for the main player. If true, the action will be ignored for farmhands in [[multiplayer]].		\| ''(Optional)'' Whether this trigger action can only run for the main player. If true, the action will be ignored for farmhands in [[multiplayer]].
			\|-
			\| <samp>Condition</samp>
			\| ''(Optional)'' A [[Modding:Game state queries\|game state query]] which indicates whether this action can be applied currently. Defaults to always true.
	\|-		\|-
	\| <samp>MarkActionApplied</samp>		\| <samp>MarkActionApplied</samp>
Line 219:		Line 222:
	* If false: the action can repeat immediately when the same trigger is raised, and [[Modding:Game state queries\|queries]] like <samp>PLAYER_HAS_RUN_TRIGGER_ACTION</samp> will return false for it.		* If false: the action can repeat immediately when the same trigger is raised, and [[Modding:Game state queries\|queries]] like <samp>PLAYER_HAS_RUN_TRIGGER_ACTION</samp> will return false for it.
	\|-		\|-
	\| <samp>~~Condition~~</samp>		\| <samp>SkipPermanentlyCondition</samp>
	\| ''(Optional)'' A [[Modding:Game state queries\|game state query]] which indicates ~~whether~~ this action ~~can~~ be applied ~~currently. Defaults~~ to ~~always true~~.		\| ''(Optional)'' If set, a [[Modding:Game state queries\|game state query]] which indicates that the action should be marked applied when this condition matches. This happens before <samp>Condition</samp>, <samp>Action</samp>, and <samp>Actions</samp> are applied.

			This mainly allows optimizing cases where the action will never be applied, to avoid parsing the <samp>Condition</samp> each time.
	\|-		\|-
	\| <samp>CustomFields</samp>		\| <samp>CustomFields</samp>

imported>Pathoschild: use {{Content Patcher example}}, make example formatting consistent

2025-02-01T19:59:14Z

use {{Content Patcher example}}, make example formatting consistent

← Older revision		Revision as of 19:59, 1 February 2025
Line 80:		Line 80:

	For example, this only sends a mail if the player doesn't have it in their received, mailbox, or queued-for-tomorrow mail:		For example, this only sends a mail if the player doesn't have it in their received, mailbox, or queued-for-tomorrow mail:
	<syntaxhighlight lang="js">		<syntaxhighlight lang="json">
	"ActionsOnPurchase": [		"ActionsOnPurchase": [
	"If !PLAYER_HAS_MAIL Current SomeFlag ## AddMail Current SomeFlag"		"If !PLAYER_HAS_MAIL Current SomeFlag ## AddMail Current SomeFlag"
Line 147:		Line 147:

	For example, consider this [[Modding:Content Patcher\|Content Patcher]] patch:		For example, consider this [[Modding:Content Patcher\|Content Patcher]] patch:
	~~{{#tag:syntaxhighlight\|<nowiki>~~		{{Content Patcher example\|<nowiki>
	{
	~~"Format": "</nowiki>~~{{Content Patcher ~~version}}~~<nowiki>",
	"Changes": [		"Changes": [
	{		{
Line 167:		Line 165:
	}		}
	]		]
	}		</nowiki>}}
	</nowiki>~~\|lang=js~~}}

	You can read that like: "''When the player is going to sleep, if Leo has moved to the valley, then [[Modding:Mail data\|send a letter]] and start [[Modding:Dialogue#Conversation topics\|a conversation topic]]''".		You can read that like: "''When the player is going to sleep, if Leo has moved to the valley, then [[Modding:Mail data\|send a letter]] and start [[Modding:Dialogue#Conversation topics\|a conversation topic]]''".
Line 234:		Line 231:
	<ul>		<ul>
	<li>A [[Modding:Dialogue\|dialogue string]] using the <samp>$action</samp> command. For example:		<li>A [[Modding:Dialogue\|dialogue string]] using the <samp>$action</samp> command. For example:
	<syntaxhighlight lang="js">		<syntaxhighlight lang="json">
	"Mon": "Hi there! Here's 10g and a parsnip, don't spend it all at once.#$action AddMoney 10#$action AddItem (O)24"		"Mon": "Hi there! Here's 10g and a parsnip, don't spend it all at once.#$action AddMoney 10#$action AddItem (O)24"
	</syntaxhighlight></li>		</syntaxhighlight></li>

	<li>An [[Modding:Event data\|event script]] using the <samp>action</samp> command. For example:		<li>An [[Modding:Event data\|event script]] using the <samp>action</samp> command. For example:
	<syntaxhighlight lang="js">		<syntaxhighlight lang="json">
	"{{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"		"{{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"
	</syntaxhighlight>		</syntaxhighlight>
Line 247:		Line 244:

	<li>A [[Modding:Mail data\|mail letter]] using the <samp>%action</samp> command. For example:		<li>A [[Modding:Mail data\|mail letter]] using the <samp>%action</samp> command. For example:
	<syntaxhighlight lang="js">		<syntaxhighlight lang="json">
	"{{ModId}}_Letter": "Hey there!^Here's 10g and a parsnip. Take care!^ -Abigail%action AddMoney 10%% %action Additem (O)24%%[#]A gift from Abigail"		"{{ModId}}_Letter": "Hey there!^Here's 10g and a parsnip. Take care!^ -Abigail%action AddMoney 10%% %action Additem (O)24%%[#]A gift from Abigail"
	</syntaxhighlight></li>		</syntaxhighlight></li>
Line 267:		Line 264:
	<ul>		<ul>
	<li>Add and raise a new trigger type:		<li>Add and raise a new trigger type:
	<syntaxhighlight lang="js">		<syntaxhighlight lang="c#">
	// register custom trigger type		// register custom trigger type
	TriggerActionManager.RegisterTrigger("Some.ModId_OnItemReceived");		TriggerActionManager.RegisterTrigger("Some.ModId_OnItemReceived");
Line 276:		Line 273:

	<li>Or add a new action:		<li>Or add a new action:
	<syntaxhighlight lang="js">		<syntaxhighlight lang="c#">
	TriggerActionManager.RegisterAction("Some.ModId_PlaySound", this.PlaySound);		TriggerActionManager.RegisterAction("Some.ModId_PlaySound", this.PlaySound);

Line 295:		Line 292:

	<li>Or run an action string:		<li>Or run an action string:
	<syntaxhighlight lang="js">		<syntaxhighlight lang="c#">
	// NOTE: this is just an example of how to run an action. This is meant to support actions specified in data or content		// 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.		// packs. If you want to send mail (or perform other actions) in C#, it's better to call the C# APIs directly instead.
Line 324:		Line 321:

	For example, this patch will set alternating 'work' or 'weekend' mail flags depending on the day of week:		For example, this patch will set alternating 'work' or 'weekend' mail flags depending on the day of week:
	~~{{#tag:syntaxhighlight\|<nowiki>~~		{{Content Patcher example\|<nowiki>
	{
	~~"Format": "</nowiki>~~{{Content Patcher ~~version}}~~<nowiki>",
	"Changes": [		"Changes": [
	{		{
Line 354:		Line 349:
	"MarkActionApplied Current {{ModId}}_Work false"		"MarkActionApplied Current {{ModId}}_Work false"
	]		]
	},		}
	}		}
	}		}
	]		]
	}		</nowiki>}}
	</nowiki>~~\|lang=js~~}}

	[[Category:Modding]]		[[Category:Modding]]

	[[zh:模组:触发动作]]		[[zh:模组:触发动作]]

imported>VulpesLucida: zh link

2024-11-16T07:27:46Z

zh link

← Older revision		Revision as of 07:27, 16 November 2024
Line 362:		Line 362:

	[[Category:Modding]]		[[Category:Modding]]

			[[zh:模组:触发动作]]

imported>Selph: clarification

2024-07-31T04:32:07Z

clarification

← Older revision		Revision as of 04:32, 31 July 2024
Line 26:		Line 26:
	\|-		\|-
	\| <samp>AddBuff {{t\|buff ID}} {{o\|milliseconds duration}}</samp><br /><samp>RemoveBuff {{t\|buff ID}}</samp>		\| <samp>AddBuff {{t\|buff ID}} {{o\|milliseconds duration}}</samp><br /><samp>RemoveBuff {{t\|buff ID}}</samp>
	\| Apply or remove a buff ID for the current player. For <samp>AddBuff</samp>, ~~a second~~ duration ~~argument can be specified~~ to ~~override~~ the buff's default duration; this value can be <samp>-2</samp> to make the buff last the entire day.		\| Apply or remove a buff ID for the current player. For <samp>AddBuff</samp>, duration defaults to the buff's default duration if not specified; this value can be <samp>-2</samp> to make the buff last the entire day.
	\|-		\|-
	\| <samp>AddConversationTopic {{t\|topic ID}} {{t\|day duration}}</samp>		\| <samp>AddConversationTopic {{t\|topic ID}} {{t\|day duration}}</samp>