3
edits
Changes
Jump to navigation
Jump to search
mLine 17:
Line 17: − + Line 60:
Line 60: + + + Line 69:
Line 72: + + + Line 77:
Line 83: − + Line 89:
Line 95: − + Line 99:
Line 105: + + Line 158:
Line 166: − + + + + Line 242:
Line 253: − + Line 248:
Line 259: − + − + − + Line 258:
Line 269: − + − + − + Line 283:
Line 294: − + − + + + Line 332:
Line 345: − + Line 389:
Line 402: − + Line 417:
Line 430: + + + Line 423:
Line 439: + + + − + Line 434:
Line 453: − + Line 449:
Line 468: − + Line 474:
Line 493: − + + + Line 512:
Line 533: − + − + Line 528:
Line 549: − + Line 548:
Line 569: − + Line 578:
Line 599: − + Line 588:
Line 609: − + + + + Line 616:
Line 640: − If a command begins with the two characters '--', it is ignored. This can be used to insert comments or to disable commands temporarily while debugging an event.+ + + + + + + Line 688:
Line 718: + + + Line 698:
Line 731: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
→Basic format
Each event has a key which includes an event ID and any preconditions. Event IDs are a max of 10 digits, with a maximum value of 2147483647 (based on the game coding).
Each event has a key which includes an event ID and any preconditions. Event IDs are a max of 10 digits, with a maximum value of 2147483647 (based on the game coding).
You may use any ID for testing '''BUT When you are ready to publish, you are recommended to use the four digit mod ID you get from Nexus (found in the mod page URL) as the prefix instead'''. ''Note that any other id (like last 4 digit of user id is not guarenteed to be unique across other mods)'' You can actually reserve an ID for your mod in Nexus by creating the page without clicking "Publish". Of course, this is not a rule, but a good convention to prevent mods from clashing. If uploading to Moddrop or another site instead, adjust according to the number of digits found in that site's IDs.
You may use any ID for testing '''BUT When you are ready to publish, you are recommended to use the four or five digit mod ID you get from Nexus (found in the mod page URL) as the prefix instead'''. ''Note that any other id (like last 4 digit of user id is not guarenteed to be unique across other mods)'' You can actually reserve an ID for your mod in Nexus by creating the page without clicking "Publish". Of course, this is not a rule, but a good convention to prevent mods from clashing. If uploading to Moddrop or another site instead, adjust according to the number of digits found in that site's IDs.
Event preconditions include any number of the following arguments (separated by <samp>/</samp>). For example, Clint's Saloon heart event preconditions are <code>97/f Clint 750/t 1900 2300/d Tue Wed Thu Fri Sat Sun</code>, which (per the tables below) means ''event #97, requires 3 hearts with Clint, between 7pm and 11pm on Monday''.
Event preconditions include any number of the following arguments (separated by <samp>/</samp>). For example, Clint's Saloon heart event preconditions are <code>97/f Clint 750/t 1900 2300/d Tue Wed Thu Fri Sat Sun</code>, which (per the tables below) means ''event #97, requires 3 hearts with Clint, between 7pm and 11pm on Monday''.
| <samp>z {{t|season}}</samp>
| <samp>z {{t|season}}</samp>
| Current season is '''not''' {{t|season}}.
| Current season is '''not''' {{t|season}}.
|-
| <samp>N {{t|number}}</samp>
| The players in total have found at least this many golden walnuts.
|}
|}
! syntax
! syntax
! precondition
! precondition
|-
| <samp>B</samp>
| Current player has a double bed in the farmhouse if married; single bed if roommates (Krobus excluded).
|-
|-
| <samp>D {{t|name}}</samp>
| <samp>D {{t|name}}</samp>
|-
|-
| <samp>L</samp>
| <samp>L</samp>
| Event is in the FarmHouse and the FarmHouse has been upgraded at least twice (has nursery but not necessarily cellar).
| Event is in the FarmHouse and the FarmHouse has been upgraded at least twice (has nursery but not necessarily cellar). Only works inside the FarmHouse, always false outside.
|-
|-
| <samp>M {{t|number}}</samp>
| <samp>M {{t|number}}</samp>
|-
|-
| <samp>a {{t|x}} {{t|y}}</samp>
| <samp>a {{t|x}} {{t|y}}</samp>
| Current player is on that tile position.
| Current player entered the map on that tile position. Note that since events are only checked for while entering a map, you can only use tiles that other maps warp to.
|-
|-
| <samp>b {{t|number}}</samp>
| <samp>b {{t|number}}</samp>
| <samp>e {{t|event ID}}</samp>
| <samp>e {{t|event ID}}</samp>
| Current player has seen the specified event (may contain multiple event IDs).
| Current player has seen the specified event (may contain multiple event IDs).
Usage:
''/e <event ID>'' means has seen that event, then ''/e <event ID> <event ID>'' means has seen EITHER events, and ''/e <event ID>/e <event ID>'' means has seen BOTH events.
|-
|-
| <samp>f {{t|name}} {{t|number}}</samp>
| <samp>f {{t|name}} {{t|number}}</samp>
|-
|-
| <samp>C</samp>
| <samp>C</samp>
| Host player has finished the [[Community Center]].
| Host player has finished the [[Community Center]] or [[Joja Warehouse]].
|-
| <samp>X</samp>
| Host player has not finished the [[Community Center]] or [[Joja Warehouse]].
|-
|-
| <samp>H</samp>
| <samp>H</samp>
|-
|-
| <samp>addToTable {{t|x}} {{t|y}} {{t|object ID}}</samp>
| <samp>addToTable {{t|x}} {{t|y}} {{t|object ID}}</samp>
| Places on object on the furniture at a position. If the location is FarmHouse, then it will always be placed on the initial table.
| Places on object on the furniture at a position. UNLESS the location is FarmHouse, then it will always try to place an item onto the first piece of furniture, regardless if it's a table or not (and probably throw an error if there's no furniture.) It'll also actually replace the item on that piece of furniture if there was one previously. Not recommended for use in the farmhouse. May not be used by vanilla at all.
|-
|-
| <samp>addTool {{t|Sword|Wand}}</samp>
| <samp>addTool {{t|Sword|Wand}}</samp>
|-
|-
| <samp>advancedMove {{t|actor}} {{t|loop}} {{t|x y}}... OR {{t|direction duration}}</samp>
| <samp>advancedMove {{t|actor}} {{t|loop}} {{t|x y}}... OR {{t|direction duration}}</samp>
| Set multiple movements for an actor. You can set True to have the actor walk the path continuously. Example: <samp>/advancedMove Robin false 0 3 2 0 0 2 -2 0 0 -2 2 0/</samp>
| Set multiple movements for an actor. You can set True to have the actor walk the path continuously. Example: <code>/advancedMove Robin false 0 3 2 0 0 2 -2 0 0 -2 2 0/</code>
To make the actor move along the x axis (left/right), use the number of tiles to move and 0. For example, <samp>-3 0</samp> will cause the actor to walk three tiles to the left while facing left. <samp>2 0</samp> will cause the actor to walk two tiles to the right while facing right.
To make the actor move along the x axis (left/right), use the number of tiles to move and 0. For example, <code>-3 0</code> will cause the actor to walk three tiles to the left while facing left. <code>2 0</code> will cause the actor to walk two tiles to the right while facing right.
To make the actor move along the y axis (up/down), use 0 and the number of tiles to move. For example, <samp>0 1</samp> will cause the actor to walk one tile down while facing down. <samp>0 -5</samp> will cause the actor to walk five tiles up while facing up.
To make the actor move along the y axis (up/down), use 0 and the number of tiles to move. For example, <code>0 1</code> will cause the actor to walk one tile down while facing down. <code>0 -5</code> will cause the actor to walk five tiles up while facing up.
To make an actor pause, use the direction to face and the number of milliseconds to pause. 1 is right, 2 is down, 3 is left, and 4 is up. The reason 4 is up and not 0 is so that advancedMove can tell the difference between a pause command and a move up/down command.
To make an actor pause, use the direction to face and the number of milliseconds to pause. 1 is right, 2 is down, 3 is left, and 4 is up. The reason 4 is up and not 0 is so that advancedMove can tell the difference between a pause command and a move up/down command.
The code can tell the difference between a move command and a pause command because a move command must have 0 for either x or y. A pause command must have non-zero numbers for both numbers in the pair.
The code can tell the difference between a move command and a pause command because a move command must have 0 for either x or y. A pause command must have non-zero numbers for both numbers in the pair.
Example: <samp>/advancedMove Clint true 4 0 2 5000 -4 0 1 3000</samp> Clint will have continuous movement moving 4 tiles to the right, facing down upon arriving, waiting for 5 seconds, then moving 4 tiles to the left, facing right upon arriving, then waiting for 3 seconds, then loops because the loop was set to true(see above).
Example: <code>/advancedMove Clint true 4 0 2 5000 -4 0 1 3000/</code> Clint will have continuous movement moving 4 tiles to the right, facing down upon arriving, waiting for 5 seconds, then moving 4 tiles to the left, facing right upon arriving, then waiting for 3 seconds, then loops because the loop was set to true(see above).
Example: <samp>advancedMove Pam true 5 0 0 3 3 5000 -6 0 0 -4</samp> Pam first moves 5 tiles to the right, then directly moves 3 tiles downward, faces the to the left upon arriving then waits 5 seconds before moving 6 tiles to the left then moves up 4 tiles directly.
Example: <code>/advancedMove Pam true 5 0 0 3 3 5000 -6 0 0 -4/</code> Pam first moves 5 tiles to the right, then directly moves 3 tiles downward, faces the to the left upon arriving then waits 5 seconds before moving 6 tiles to the left then moves up 4 tiles directly.
|-
|-
| <samp>ambientLight {{t|r}} {{t|g}} {{t|b}}</samp>
| <samp>ambientLight {{t|r}} {{t|g}} {{t|b}}</samp>
| Modifies the ambient light level, with RGB values from 0 to 255. Note that it works by ''removing'' colors from the existing light ambience, so <samp>ambientLight 1 80 80</samp> would reduce green and blue and leave the light with a reddish hue.
| Modifies the ambient light level, with RGB values from 0 to 255.
|-
|-
| <samp>animalNaming</samp>
| <samp>animalNaming</samp>
| This command states that the next event commands will all be done at the same time. Must also have endSimultaneousCommand after the commands needed to execute at the same time.
| This command states that the next event commands will all be done at the same time. Must also have endSimultaneousCommand after the commands needed to execute at the same time.
|-
|-
| <samp>broadcastEvent</samp>
| <samp>broadcastEvent [local]</samp>
| TODO: Explain broadcastEvent.
| Makes the event a "broadcast event", forcing others players connected to also see it. Any players connected will be forced to warp to this event. This is used in some vanilla events like when Lewis shows the farmer the abandoned Community Center.
If the "local" option is given (not a boolean), then client players will see the event as if the "farmer" actor was their own farmer instead of the Host farmer. The "local" option isn't used anywhere in the vanilla game.
|-
|-
| <samp>catQuestion</samp>
| <samp>catQuestion</samp>
|-
|-
| <samp>emote {{t|actor}} {{t|emote ID}}</samp>
| <samp>emote {{t|actor}} {{t|emote ID}}</samp>
| Make the given NPC name perform an emote, which is a little icon shown above the NPC's head. Emotes are stored in <samp>Content\TileSheets\emotes.xnb</samp> (see [https://www.reddit.com/r/StardewValley/comments/5s5m9g/help_annoyed_squiggle/ddd33qg/ list of emotes]).
| Make the given NPC name perform an emote, which is a little icon shown above the NPC's head. Emotes are stored in <samp>Content\TileSheets\emotes.xnb</samp>; see [[#Emotes|list of emotes]].
|-
|-
| <samp>end</samp>
| <samp>end</samp>
|-
|-
| <samp>farmerEat {{t|object ID}}</samp>
| <samp>farmerEat {{t|object ID}}</samp>
| Make the player eat an object
| Make the player eat an object. (The farmer actually does eat the object, so buffs will apply, healing will occur, etc.)
|-
|-
| <samp>fork {{o|req}} {{t|event ID}}</samp>
| <samp>fork {{o|req}} {{t|event ID}}</samp>
| <samp>halt</samp>
| <samp>halt</samp>
| Make everyone stop.
| Make everyone stop.
|-
| <samp>hideShadow {{t|actor}} {{t|true/false}}</samp>
| Hide the shadow of the named actor. False unhides it.
|-
|-
| <samp>hospitaldeath</samp>
| <samp>hospitaldeath</samp>
| <samp>ignoreCollisions {{t|character ID}}</samp>
| <samp>ignoreCollisions {{t|character ID}}</samp>
| Make a character ignore collisions when moving for the remainder of the event. For example, they'll walk through walls if needed to reach their destination. The character ID can be <samp>farmer</samp> or an NPC name like <samp>Abigail</samp>.
| Make a character ignore collisions when moving for the remainder of the event. For example, they'll walk through walls if needed to reach their destination. The character ID can be <samp>farmer</samp> or an NPC name like <samp>Abigail</samp>.
|-
| <samp>ignoreEventTileOffset</samp>
| Tile positions in farm events are offset to match the farmhouse position. If an event shouldn't be based on the farmhouse position, add an ignoreEventTileOffset command to disable the offset for that event. This must be the 4th command (after the 3 initial setup ones) to take effect.
|-
|-
| <samp>itemAboveHead {{o|type}}</samp>
| <samp>itemAboveHead {{o|type}}</samp>
| Show an item above the player's head. The {{o|type}} can be "pan", "hero", "sculpture", "joja", "slimeEgg", "rod", "sword", or "ore". If no item is specified, then they will 'hold' nothing?
| Show an item above the player's head. The {{o|type}} can be "pan", "hero", "sculpture", "joja", "slimeEgg", "rod", "sword", or "ore". If no item is specified, then they will 'hold' nothing? Arbitrary items are not supported.
|-
|-
| <samp>jump {{t|actor}} {{o|intensity}}</samp>
| <samp>jump {{t|actor}} {{o|intensity}}</samp>
|-
|-
| <samp>makeInvisible {{t|x}} {{t|y}} {{o|x-dimension}} {{o|y-dimension}}</samp>
| <samp>makeInvisible {{t|x}} {{t|y}} {{o|x-dimension}} {{o|y-dimension}}</samp>
| Temporarily hides selected objects or terrain features: the tile(s) will become passable for the duration of the event. Useful for clearing a walking area during events, especially in the FarmHouse. (Example: <samp>/makeInvisible 8 14</samp> hides any object or terrain feature at tile 8, 14 in the current map.) The optional {{o|x-dimension}} and {{o|y-dimension}} arguments allow you to specify a larger area to be cleared. (Example: <samp>/makeInvisible 68 36 13 7</samp> in Leah's 14-heart event clears a 13 × 7 tile rectangular area with the top-left corner at coordinate 68, 36.)
| Temporarily hides selected objects or terrain features: the tile(s) will become passable for the duration of the event. Useful for clearing a walking area during events, especially in the FarmHouse. (Example: <samp>/makeInvisible 8 14</samp> hides any object or terrain feature at tile 8, 14 in the current map.) The optional {{o|x-dimension}} and {{o|y-dimension}} arguments allow you to specify a larger area to be cleared. (Example: <samp>/makeInvisible 68 36 13 7</samp> in Leah's 14-heart event clears a 13 × 7 tile rectangular area with the top-left corner at coordinate 68, 36.). Known bugs: some furniture may not re-appear immediately?
|-
|-
| <samp>mail {{t|letter ID}}</samp>
| <samp>mail {{t|letter ID}}</samp>
|-
|-
| <samp>move {{t|actor}} {{t|x}} {{t|y}} {{t|facing}} {{t|continue}}</samp>
| <samp>move {{t|actor}} {{t|x}} {{t|y}} {{t|facing}} {{t|continue}}</samp>
| Make a named NPC move by the given tile offset from their current position (along one axis ''only''), and face the given [[#Directions|direction]] when they're done. To move along multiple axes, you must specify multiple <samp>move</samp> commands. By default the event pauses while a move command is occurring, but if {{t|continue}} is set to ''true'' the movement is asynchronous and will run simultaneously with other event commands.
| Make a named NPC move by the given tile offset from their current position (along one axis ''only''), and face the given [[#Directions|direction]] when they're done. To move along multiple axes, you must specify multiple <samp>move</samp> commands. By default the event pauses while a move command is occurring, but if {{t|continue}} is set to ''true'' the movement is asynchronous and will run simultaneously with other event commands. You can also move multiple people at a time in a single event command with move - an example of <samp>/move Abigail 1 0 1 Sam 0 1 1 Sebastian 2 0 1/</samp> will have Abigail, Sam, and Sebastian all move at the same time in their respective directions.
|-
|-
|-
|-
| <samp>question fork{{t|answer index}} "{{t|question}}#{{t|answer 0}}#{{t|answer 1}}#..."</samp>
| <samp>question fork{{t|answer index}} "{{t|question}}#{{t|answer 0}}#{{t|answer 1}}#..."</samp>
| Show a dialogue with some answers and an optional question. When the player chooses the answer matching the <samp>fork{{t|answer index}}</samp> (like <samp>fork0</samp> for the first answer), the <samp>specialEventVariable1</samp> variable is set. Usually followed by a <samp>fork</samp> command.
| Show a dialogue with some answers and an optional question. When the player chooses the answer matching the <samp>fork{{t|answer index}}</samp> (like <samp>fork0</samp> for the first answer), the <samp>specialEventVariable1</samp> variable is set. Usually followed by a <samp>fork</samp> command. Example:
<syntaxhighlight lang="json">.../question fork0 \"#answer0#answer1#answer3\"/fork eventidhere/..."</syntaxhighlight>
|-
|-
| <samp>quickQuestion {{t|question}}#{{t|answer1}}#{{t|answer2}}#{{t|answer3}}(break){{t|answer1 script}}(break){{t|answer2 script}}(break){{t|answer3 script}}</samp>
| <samp>quickQuestion {{t|question}}#{{t|answer1}}#{{t|answer2}}#{{t|answer3}}(break){{t|answer1 script}}(break){{t|answer2 script}}(break){{t|answer3 script}}</samp>
| Show a dialogue box with an optional question and some answers. The answer scripts are sequences of commands separated by <samp>\\</samp>. When the player chooses an answer, the relevant answer script is executed and then the event continues. Usually used when an NPC's response will depend on the answer chosen but nothing else in the event has to depend on it.
| Show a dialogue box with an optional question and some answers. The answer scripts are sequences of commands separated by <samp>\\</samp>. When the player chooses an answer, the relevant answer script is executed and then the event continues. Usually used when an NPC's response will depend on the answer chosen but nothing else in the event has to depend on it.
*Note: If quickQuestion is used immediately at the start of an event block (Example: "ExampleEvent": "quickQuestion [rest of the event]"), it will cause a dialogue loop. Adding another command in front of quickQuestion resolves this issue (Example: "ExampleEvent": "pause 1/quickQuestion [rest of the event]").
|-
|-
| <samp>removeItem {{t|object ID}}</samp>
| <samp>removeItem {{t|object ID}}</samp>
| Shake the named NPC for the given number of milliseconds.
| Shake the named NPC for the given number of milliseconds.
|-
|-
| <samp>showFrame farmer flip</samp>
| <samp>showFrame farmer {{t|frame}} {{t|flip}}</samp>
| Flip the farmer's current sprite along the Y axis. TODO: Behavior with farmer looks strange?
| Flip the farmer's current sprite along the Y axis. Farmer looks strange if not facing the correct direction prior to 1.6. Flip is a true/false value.
|-
|-
| <samp>showFrame {{t|actor}} {{t|frame ID}}</samp>
| <samp>showFrame {{t|actor}} {{t|frame ID}}</samp>
|-
|-
| <samp>specificTemporarySprite {{t|sprite}} {{o|other params}}</samp>
| <samp>specificTemporarySprite {{t|sprite}} {{o|other params}}</samp>
| Shows the given temporary sprite. Parameters change depending on the sprite.
| Shows the given temporary sprite. Parameters change depending on the sprite. '''These are quite hardcoded and probably not easily reusable, other than the little heart.'''
|-
|-
| <samp>speed farmer {{t|modifier}}</samp>
| <samp>speed farmer {{t|modifier}}</samp>
| Stop the farmer's current animation.
| Stop the farmer's current animation.
|-
|-
| <samp>stopAnimation {{t|actor}} {{t|end frame}}</samp>
| <samp>stopAnimation {{t|actor}} {{o|end frame}}</samp>
| Stop the named NPC's current animation. Not applicable to the farmer.
| Stop the named NPC's current animation. Not applicable to the farmer.
|-
|-
| Create a temporary sprite with the given parameters, from the resource <samp>TileSheets/animations</samp>.
| Create a temporary sprite with the given parameters, from the resource <samp>TileSheets/animations</samp>.
|-
|-
| <samp>textAboveHead {{t|actor}} "{{t|text}}"</samp>
| <samp>textAboveHead {{t|actor}} \"{{t|text}}\"</samp>
| Show a small text bubble over the named NPC's head with the given text; see [[#Dialogue format|dialogue format]].
| Show a small text bubble over the named NPC's head with the given text; see [[#Dialogue format|dialogue format]].
|-
|-
|-
|-
| <samp>viewport move {{t|x}} {{t|y}} {{t|duration}}</samp>
| <samp>viewport move {{t|x}} {{t|y}} {{t|duration}}</samp>
| Pan the the camera in the direction (and with the velocity) defined by ''x/y'' for the given duration in milliseconds. Example: ''"viewport move 2 -1 5000"'' moves the camera 2 pixels right and 1 pixel up for 5 seconds.
| Pan the the camera in the direction (and with the velocity) defined by ''x/y'' for the given duration in milliseconds. Example: ''"viewport move 2 -1 5000"'' moves the camera 2 pixels right and 1 pixel up for 5 seconds. The total distance moved is based on framerate, rather than time, and may be inconsistent.
|-
|-
| <samp>viewport {{t|x}} {{t|y}} [true [unfreeze]|clamp [true|unfreeze]]</samp>
| <samp>viewport {{t|x}} {{t|y}} [true [unfreeze]|clamp [true|unfreeze]]</samp>
| Instantly reposition the camera to center on the given X, Y tile position. TODO: explain other parameters.
| Instantly reposition the camera to center on the given X, Y tile position. TODO: explain other parameters.
|-
| <samp>waitForAllStationary</samp>
| Waits for all actors to stop moving before executing the next command.
|-
|-
| <samp>waitForOtherPlayers</samp>
| <samp>waitForOtherPlayers</samp>
|}
|}
===Comments===
A command which begins with <code>--</code> is ignored. This can be used to insert comments or to disable commands temporarily while debugging an event. The comment ends at the next slash delimiter (<code>/</code>), so it can't contain slashes.
For example:
<syntaxhighlight lang="js">
"666/": "none/-1000 -1000/farmer 5 7 0/skippable/viewport 5 7 10/--set viewport near door/pause 2000/end"
</syntaxHighlight>
===Directions===
===Directions===
| linusMoneyGone
| linusMoneyGone
| ??? (seems to be unused)
| ??? (seems to be unused)
|-
| marucomet
| Maru Comet scene from her 14 heart event
|-
|-
| plane
| plane
===Dialogue format===
===Dialogue format===
See [[Modding:Dialogue#Format]].
See [[Modding:Dialogue#Format]].
==Common values==
===Emotes===
An ''emote'' is an animated icon bubble shown above an NPC's head to indicate a mood or reaction. Emote icons are stored in the <samp>TileSheets\emotes</samp> asset.
{| class="wikitable"
|-
! ID
! <samp>Character</samp> constant
|-
| 4
| <samp>emptyCanEmote</samp>
|-
| 8
| <samp>questionMarkEmote</samp>
|-
| 12
| <samp>angryEmote</samp>
|-
| 16
| <samp>exclamationEmote</samp>
|-
| 20
| <samp>heartEmote</samp>
|-
| 24
| <samp>sleepEmote</samp>
|-
| 28
| <samp>sadEmote</samp>
|-
| 32
| <samp>happyEmote</samp>
|-
| 36
| <samp>xEmote</samp>
|-
| 40
| <samp>pauseEmote</samp>
|-
| 44
| ''unused''
|-
| 48
| ''unused''
|-
| 52
| <samp>videoGameEmote</samp>
|-
| 56
| <samp>musicNoteEmote</samp>
|-
| 60
| <samp>blushEmote</samp>
|}
==See also==
==See also==