imported>Sunbeam135: added ru link

2026-03-13T18:42:26Z

added ru link

← Older revision		Revision as of 18:42, 13 March 2026
Line 72:		Line 72:
	[[Category:Modding]]		[[Category:Modding]]

			[[ru:Модификации:Телефонные звонки]]
	[[zh:模组:电话]]		[[zh:模组:电话]]

imported>VulpesLucida: zh link

2025-01-20T13:05:24Z

zh link

← Older revision		Revision as of 13:05, 20 January 2025
Line 71:		Line 71:

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

			[[zh:模组:电话]]

imported>VulpesLucida at 01:28, 19 January 2025

2025-01-19T01:28:32Z

← Older revision		Revision as of 01:28, 19 January 2025
Line 1:		Line 1:
	~~==Copied from~~ [[Modding:~~Migrate to Stardew Valley 1.6~~]]==		← [[Modding:Index\|Index]]
	~~===Custom phone calls===~~
	~~{{Migration guide doc status\|a new doc page\|done=false}}~~

	~~Mods can now extend the [[telephone]] with custom~~ calls ~~(both incoming calls, and phone numbers which the player can call)~~.		This page explains phone calls. This is an advanced guide for mod developers.

	====Incoming calls====		==Incoming calls format==
	You can add or customize incoming calls by editing the <samp>Data/IncomingPhoneCalls</samp> asset.		You can add or customize incoming calls by editing the <samp>Data/IncomingPhoneCalls</samp> asset.

Line 49:		Line 47:
	\|}		\|}

	====Custom handlers in C#====		==Custom handlers in C#==
	C# mods can implement <samp>StardewValley.PhoneCalls.IPhoneHandler</samp> and add it to <samp>Phone.PhoneHandlers</samp> for full control over both incoming and outgoing calls:		C# mods can implement <samp>StardewValley.PhoneCalls.IPhoneHandler</samp> and add it to <samp>Phone.PhoneHandlers</samp> for full control over both incoming and outgoing calls:

Line 71:		Line 69:

	See <samp>StardewValley.PhoneCalls.DefaultPhoneHandler</samp> in the [[Modding:Modder Guide/Get Started#decompile\|decompiled game code]] for an example implementation.		See <samp>StardewValley.PhoneCalls.DefaultPhoneHandler</samp> in the [[Modding:Modder Guide/Get Started#decompile\|decompiled game code]] for an example implementation.

			[[Category:Modding]]

imported>VulpesLucida: add info from Modding:Migrate to Stardew Valley 1.6 (main author Pathoschild, with formatting fixes by Margotbean)

2025-01-19T01:28:15Z

add info from Modding:Migrate to Stardew Valley 1.6 (main author Pathoschild, with formatting fixes by Margotbean)

New page

==Copied from [[Modding:Migrate to Stardew Valley 1.6]]==
===Custom phone calls===
{{Migration guide doc status|a new doc page|done=false}}

Mods can now extend the [[telephone]] with custom calls (both incoming calls, and phone numbers which the player can call).

====Incoming calls====
You can add or customize incoming calls by editing the <samp>Data/IncomingPhoneCalls</samp> asset.

This consists of a string → model lookup, where...
* The key is a [[Modding:Common data field types#Unique string ID|unique string ID]] for the incoming call data.
* The value is a model with the fields listed below.

{| class="wikitable"
|-
! field
! effect
|-
| <samp>Dialogue</samp>
| The dialogue text to show when the player answers the phone. This can use the full [[Modding:Dialogue|dialogue format]] (including questions and different dialogue based on the selected answer).
|-
| <samp>FromNpc</samp>
| ''(Optional)'' The internal name of the NPC making the call. If specified, that NPC's name and portrait will be shown.
|-
| <samp>FromPortrait</samp>
| ''(Optional)'' The asset name for the portrait spritesheet to display (like <samp>Portraits/Abigail</samp>). If <samp>FromNpc</samp> is specified too, this overrides the portrait from that NPC. If both <samp>FromNpc</samp> and <samp>FromDisplayName</samp> are null, this portrait will be shown with the display name "???".
|-
| <samp>FromDisplayName</samp>
| ''(Optional)'' A [[Modding:Tokenizable strings|tokenizable string]] for the calling NPC's display name. If <samp>FromNpc</samp> is specified too, this overrides the display name from that NPC.
|-
| <samp>MaxCalls</samp>
| ''(Optional)'' The maximum number of times a player can receive this phone call, or <samp>-1</samp> for no limit. Default 1.
|-
| <samp>TriggerCondition</samp><br /><samp>RingCondition</samp>
| ''(Optional)'' If set, a game state query which indicates whether to trigger this phone call (<samp>TriggerCondition</samp>) or whether the phone rings when this call is received (<samp>RingCondition</samp>).

Whether a player receives this call depends on both fields: <samp>TriggerCondition</samp> is checked on the main player before sending the call to all players, then <samp>RingCondition</samp> is checked on each player to determine whether the phone rings for them.
|-
| <samp>IgnoreBaseChance</samp>
| ''(Optional)'' Whether to ignore the 1% base chance when checking whether to trigger an incoming call. If true, the game will check if this call can be received regardless of the base chance. Default false.
|-
| <samp>SimpleDialogueSplitBy</samp>
| ''(Optional, specialized)'' If set, marks the call as having a simple dialogue string without an NPC name and portrait, with lines split into multiple boxes by this substring. For example, <code>"SimpleDialogueSplitBy": "#"</code> will split <code>Box A#Box B#Box C</code> into three consecutive dialogue boxes.

You should omit this in most cases, and use the regular dialogue format in <samp>Dialogue</samp> to split lines if needed. This is mainly intended to support some older vanilla phone calls.
|-
| <samp>CustomFields</samp>
| The [[Modding:Common data field types#Custom fields|custom fields]] for this entry.
|}

====Custom handlers in C#====
C# mods can implement <samp>StardewValley.PhoneCalls.IPhoneHandler</samp> and add it to <samp>Phone.PhoneHandlers</samp> for full control over both incoming and outgoing calls:

<syntaxhighlight lang="c#">
/// <summary>The mod entry point.</summary>
internal sealed class ModEntry : Mod
{
/// <inheritdoc />
public override void Entry(IModHelper helper)
{
Phone.PhoneHandlers.Add(new CustomPhoneHandler());
}
}

/// <summary>A custom phone handler.</summary>
internal sealed class CustomPhoneHandler : IPhoneHandler
{
...
}
</syntaxhighlight>

See <samp>StardewValley.PhoneCalls.DefaultPhoneHandler</samp> in the [[Modding:Modder Guide/Get Started#decompile|decompiled game code]] for an example implementation.

Modding:Phone calls - Revision history

imported>Sunbeam135: added ru link

imported>VulpesLucida: zh link

imported>VulpesLucida at 01:28, 19 January 2025

imported>VulpesLucida: add info from Modding:Migrate to Stardew Valley 1.6 (main author Pathoschild, with formatting fixes by Margotbean)