m (fix incorrect parameter name messing the example) |
(substitute sample to avoid redlink) |
||
(5 intermediate revisions by the same user not shown) | |||
Line 11: | Line 11: | ||
"required": true | "required": true | ||
}, | }, | ||
" | "alias": { | ||
"label": " | "label": "Alias", | ||
"description": " | "description": "The alias of the connection. This supersedes the location's name if specified.", | ||
" | "type": "string" | ||
}, | |||
"unlock_type": { | |||
"label": "Locked Connection Type", | |||
"description": "Parameter for a locked connection. These connections are unlocked by the opposite side, are the ones unlocking the opposite side, or are accessible only after specific conditions are met.", | |||
"suggestedvalues": ["Locked","Unlock","LockedCondition"], | |||
"type": "string" | |||
}, | |||
"unlock_conditions": { | |||
"label": "Unlock Conditions", | |||
"description": "Description for a conditionally-locked connection. Applicable if Lock Condition is set to LockedCondition.", | |||
"type": "string" | |||
}, | }, | ||
" | "unlock_instruction_link": { | ||
"label": " | "label": "Unlock Instruction Link", | ||
"description": " | "description": "Link to a page pointing to the instructions on how to unlock an area.", | ||
"example": " | "example": "Yume 2kki:Unlock Guide", | ||
"type": "string" | "type": "string" | ||
}, | }, | ||
" | "chance_description": { | ||
"label": " | "label": "Chance Description", | ||
"description": " | "description": "Short description for chance-based connections.", | ||
"example": " | "example": "1/3 chance", | ||
"type": "string" | "type": "string" | ||
}, | }, | ||
" | "chance_percentage": { | ||
"label": " | "label": "Chance Percentage", | ||
"description": " | "description": "Numeric probability for a chance-based connection. Applicable if Chance Description is specified.", | ||
"example": " | "example": "33%", | ||
"type": "string" | "type": "string" | ||
}, | }, | ||
Line 39: | Line 50: | ||
"example": "Child", | "example": "Child", | ||
"type": "string" | "type": "string" | ||
}, | |||
"effect_conjunction": { | |||
"label": "Effect Conjunction", | |||
"description": "Conjunction for the effects required; applicable if Effects Needed is specified. Defaults to \"and\", can be changed to \"or\".", | |||
"type": "string", | |||
"suggestedvalues": ["and","or"], | |||
"default": "and" | |||
}, | }, | ||
"season": { | "season": { | ||
"label": "Season", | "label": "Season", | ||
"description": "The season at which an area is accessible | "description": "The season at which an area is accessible.", | ||
" | "suggestedvalues": ["Winter","Spring","Summer","Fall"], | ||
"type": "string" | "type": "string" | ||
}, | }, | ||
"phonebooth_type": { | "phonebooth_type": { | ||
"label": "Phonebooth Type", | "label": "Phonebooth Type", | ||
"description": "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.", | "description": "Parameter denoting the side of a connection accessible from a phonebooth; this is applicable for areas in Yume 2kki. Accepted values are Shortcut for connections to the Dream Apartments and ExitPoint for connections on the area's page.", | ||
"suggestedvalues": ["Shortcut","ExitPoint"], | |||
"type": "string" | "type": "string" | ||
}, | }, | ||
"isolation_type": { | "isolation_type": { | ||
"label": "Isolation Type", | "label": "Isolation Type", | ||
"description": "Determines what side an isolated connection is. Accepted values are DeadEnd and Return.", | "description": "Determines what side an isolated connection is. Accepted values are DeadEnd and Return. DeadEnd is used on the page with the isolated section, whereas Return is used on the page that takes you to the isolated section.", | ||
"suggestedvalues": ["DeadEnd","Return"], | |||
"type": "string" | "type": "string" | ||
}, | }, | ||
Line 64: | Line 79: | ||
"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.", | ||
"suggestedvalues": ["NoReturn","NoEntry"], | |||
"type": "string" | "type": "string" | ||
}, | }, | ||
" | "chaser_type": { | ||
"label": " | "label": "Chaser Type", | ||
"description": " | "description": "For chasers and chaser traps. Accepted values are Catch and Trap.", | ||
"suggestedvalues": ["Catch","Trap"], | |||
" | |||
"type": "string" | "type": "string" | ||
}, | }, | ||
Line 94: | Line 94: | ||
"type": "string" | "type": "string" | ||
}, | }, | ||
" | "primary_image": { | ||
"label": " | "label": "Primary Image", | ||
"description": "The | "description": "File name pointing to the primary image representing a connection. The file in question must have a dimension of 128x128 pixels.", | ||
"example": "Art Gallery and Dream Park_1.png", | |||
"type": "string" | |||
}, | |||
"secondary_image": { | |||
"label": "Secondary Image", | |||
"description": "File name pointing to the secondary image representing a connection. The file in question must have a dimension of 128x128 pixels.", | |||
"example": "Art Gallery and Dream Park_2.png", | |||
"type": "string" | "type": "string" | ||
}, | |||
"is_removed": { | |||
"label": "Is Removed", | |||
"description": "Indicates whether the connection has been removed. Defaults to false.", | |||
"type": "boolean", | |||
"default": "false" | |||
}, | }, | ||
"misc_label": { | "misc_label": { | ||
Line 109: | Line 122: | ||
"1", | "1", | ||
"alias", | "alias", | ||
"unlock_type", | "unlock_type", | ||
"unlock_conditions", | |||
"unlock_instruction_link", | |||
"chance_description", | |||
"chance_percentage", | |||
"effects_needed", | "effects_needed", | ||
"effect_conjunction", | |||
"season", | "season", | ||
"phonebooth_type", | "phonebooth_type", | ||
"isolation_type", | "isolation_type", | ||
"one_way_type", | "one_way_type", | ||
" | "chaser_type", | ||
" | "directions", | ||
" | "primary_image", | ||
" | "secondary_image", | ||
"is_removed", | "is_removed", | ||
"misc_label" | "misc_label" | ||
Line 129: | Line 143: | ||
} | } | ||
</templatedata> | </templatedata> | ||
== Syntax == | ==Syntax== | ||
Connection without attributes; note that the named parameters are optional: | Connection without attributes; note that the named parameters are optional: | ||
<pre> | <pre> | ||
Line 137: | Line 151: | ||
==Sample== | ==Sample== | ||
<pre> | <pre> | ||
{{Connection|Scrambled Egg Zone | {{Connection|Scrambled Egg Zone|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}} | ||
</pre> | </pre> | ||
[[Yume 2kki:Scrambled Egg Zone|Scrambled Egg Zone]] {{Unlockable|LockedCondition|Requires breaking the egg in the Guardians' Temple and having the orbs show on each pillar.|}} {{OneWay|NoReturn}} |
Latest revision as of 04:00, 15 July 2024
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 |
Locked Connection Type | unlock_type | Parameter for a locked connection. These connections are unlocked by the opposite side, are the ones unlocking the opposite side, or are accessible only after specific conditions are met.
| String | optional |
Unlock Conditions | unlock_conditions | Description for a conditionally-locked connection. Applicable if Lock Condition is set to LockedCondition. | String | optional |
Unlock Instruction Link | unlock_instruction_link | Link to a page pointing to the instructions on how to unlock an area.
| String | optional |
Chance Description | chance_description | Short description for chance-based connections.
| String | optional |
Chance Percentage | chance_percentage | Numeric probability for a chance-based connection. Applicable if Chance Description is specified.
| String | optional |
Effects Needed | effects_needed | The effects needed to enter the area, separated by commas.
| 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 |
Season | season | The season at which an area is accessible.
| 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 for connections to the Dream Apartments and ExitPoint for connections on the area's page.
| String | optional |
Isolation Type | isolation_type | Determines what side an isolated connection is. Accepted values are DeadEnd and Return. DeadEnd is used on the page with the isolated section, whereas Return is used on the page that takes you to the isolated section.
| String | optional |
One Way Type | one_way_type | Parameter for a one-way connection. Accepted values are NoReturn and NoEntry.
| String | optional |
Chaser Type | chaser_type | For chasers and chaser traps. Accepted values are Catch and Trap.
| 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 |
Is Removed | is_removed | Indicates whether the connection has been removed. Defaults to false.
| Boolean | 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|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 🔐 ➡️