m (fix incorrect parameter name messing the example) |
m (fix incorrect example) |
||
Line 31: | Line 31: | ||
"label": "Locked Connection Type", | "label": "Locked Connection Type", | ||
"description": "Parameter for a locked connection. Accepted values are Locked, Unlocked, or LockedCondition.", | "description": "Parameter for a locked connection. Accepted values are Locked, Unlocked, or LockedCondition.", | ||
"example": " | "example": "Locked", | ||
"type": "string" | "type": "string" | ||
}, | }, | ||
Line 64: | Line 64: | ||
"label": "One Way Type", | "label": "One Way Type", | ||
"description": "Parameter for a one-way connection. Accepted values are NoReturn and NoEntry.", | "description": "Parameter for a one-way connection. Accepted values are NoReturn and NoEntry.", | ||
"example": "NoReturn", | |||
"type": "string" | "type": "string" | ||
}, | }, |
Revision as of 22:02, 15 November 2023
Description
Renders a link (if provided) to an area's connection, along with icons denoting its attributes, and sets a subobject that can be queried.
Parameter | Description | Type | Status | |
---|---|---|---|---|
Location | 1 | The connection's target location.
| String | required |
Alias | alias | The alias of the connection. This supersedes the location's name if specified. | String | optional |
Directions | directions | A short description on the directions to a connection within the area.
| String | optional |
Primary Image | primary_image | File name pointing to the primary image representing a connection. The file in question must have a dimension of 128x128 pixels.
| String | optional |
Secondary Image | secondary_image | File name pointing to the secondary image representing a connection. The file in question must have a dimension of 128x128 pixels.
| String | optional |
Locked Connection Type | unlock_type | Parameter for a locked connection. Accepted values are Locked, Unlocked, or LockedCondition.
| String | optional |
Effects Needed | effects_needed | The effects needed to enter the area, separated by commas.
| String | optional |
Season | season | The season at which an area is accessible. Accepted values are Winter, Spring, Summer, or Fall. | String | optional |
Chance Description | chance_description | Short description for chance-based connections.
| String | optional |
Phonebooth Type | phonebooth_type | Parameter denoting the side of a connection accessible from a phonebooth; this is applicable for areas in Yume 2kki. Accepted values are Shortcut and ExitPoint. | String | optional |
Isolation Type | isolation_type | Determines what side an isolated connection is. Accepted values are DeadEnd and Return. | String | optional |
One Way Type | one_way_type | Parameter for a one-way connection. Accepted values are NoReturn and NoEntry.
| String | optional |
Unlock Instruction Link | unlock_instruction_link | Link to a page pointing to the instructions on how to unlock an area. | String | optional |
Unlock Conditions | unlock_conditions | Description for a conditionally-locked connection. Applicable if Lock Condition is set to LockedCondition. | String | optional |
Effect Conjunction | effect_conjunction | Conjunction for the effects required; applicable if Effects Needed is specified. Defaults to And, can be changed to Or.
| String | optional |
Chance Percentage | chance_percentage | Numeric probability for a chance-based connection. Applicable if Chance Description is specified.
| String | optional |
Is Removed | is_removed | Indicates whether the connection has been removed. Defaults to false.
| Unknown | optional |
Miscellaneous Label | misc_label | Text indicating some other attribute or description regarding the connection. | String | optional |
Syntax
Connection without attributes; note that the named parameters are optional:
{{Connection|<location name>}}
Sample
{{Connection|Scrambled Egg Zone|effects_needed=Child|unlock_type=LockedCondition|unlock_conditions=Requires breaking the egg in the Guardians' Temple and having the orbs show on each pillar.|one_way_type=NoReturn}}
Scrambled Egg Zone 🔐 ✨ ➡️