×
Create a new article
Write your page title here:
We currently have 2,806 articles on YumeWiki. Type your article name above or click on one of the titles below and start writing!



YumeWiki
2,806Articles

Template:Connection/doc: Difference between revisions

m (fix mistake in possible values + improve the vague descriptions)
(add chaser_type, add suggested values for some parameters, change paramOrder)
Line 11: Line 11:
"required": true
"required": true
},
},
"is_removed": {
"alias": {
"label": "Is Removed",
"label": "Alias",
"description": "Indicates whether the connection has been removed. Defaults to false.",
"description": "The alias of the connection. This supersedes the location's name if specified.",
"default": "false"
},
"primary_image": {
"label": "Primary Image",
"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"
},
},
Line 32: Line 20:
"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.",
"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"],
"suggestedvalues": ["Locked","Unlock","LockedCondition"],
"example": "Locked",
"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": "Unlock Instruction Link",
"description": "Link to a page pointing to the instructions on how to unlock an area.",
"example": "Yume 2kki:Unlock Guide",
"type": "string"
},
"chance_description": {
"label": "Chance Description",
"description": "Short description for chance-based connections.",
"example": "1/3 chance",
"type": "string"
},
"chance_percentage": {
"label": "Chance Percentage",
"description": "Numeric probability for a chance-based connection. Applicable if Chance Description is specified.",
"example": "33%",
"type": "string"
"type": "string"
},
},
Line 40: 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": {
Line 45: Line 62:
"description": "The season at which an area is accessible.",
"description": "The season at which an area is accessible.",
"suggestedvalues": ["Winter","Spring","Summer","Fall"],
"suggestedvalues": ["Winter","Spring","Summer","Fall"],
"type": "string"
},
"chance_description": {
"label": "Chance Description",
"description": "Short description for chance-based connections.",
"example": "1/3 chance",
"type": "string"
"type": "string"
},
},
Line 56: Line 67:
"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 for connections to the Dream Apartments and ExitPoint for connections on the area's page.",
"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"
},
},
Line 61: Line 73:
"label": "Isolation Type",
"label": "Isolation Type",
"description": "Determines what side an isolated connection is. Accepted values are DeadEnd and Return. The former is used on the page containing the isolated section itself.",
"description": "Determines what side an isolated connection is. Accepted values are DeadEnd and Return. The former is used on the page containing the isolated section itself.",
"suggestedvalues": ["DeadEnd","Return"],
"type": "string"
"type": "string"
},
},
Line 66: 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.",
"example": "NoReturn",
"suggestedvalues": ["NoReturn","NoEntry"],
"type": "string"
},
"unlock_instruction_link": {
"label": "Unlock Instruction Link",
"description": "Link to a page pointing to the instructions on how to unlock an area.",
"example": "Yume 2kki:Unlock Guide",
"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",
"default": "And"
},
"chance_percentage": {
"label": "Chance Percentage",
"description": "Numeric probability for a chance-based connection. Applicable if Chance Description is specified.",
"example": "33%",
"type": "string"
"type": "string"
},
},
"unlock_conditions": {
"chaser_type": {
"label": "Unlock Conditions",
"label": "Chaser Type",
"description": "Description for a conditionally-locked connection. Applicable if Lock Condition is set to LockedCondition.",
"description": "For chasers and chaser traps. Accepted values are Catch and Trap.",
"suggestedvalues": ["Catch","Trap"],
"type": "string"
"type": "string"
},
},
Line 98: Line 94:
"type": "string"
"type": "string"
},
},
"alias": {
"primary_image": {
"label": "Alias",
"label": "Primary Image",
"description": "The alias of the connection. This supersedes the location's name if specified.",
"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 113: Line 122:
"1",
"1",
"alias",
"alias",
"directions",
"primary_image",
"secondary_image",
"unlock_type",
"unlock_type",
"unlock_conditions",
"unlock_instruction_link",
"chance_description",
"chance_percentage",
"effects_needed",
"effects_needed",
"effect_conjunction",
"season",
"season",
"chance_description",
"phonebooth_type",
"phonebooth_type",
"isolation_type",
"isolation_type",
"one_way_type",
"one_way_type",
"unlock_instruction_link",
"chaser_type",
"unlock_conditions",
"directions",
"effect_conjunction",
"primary_image",
"chance_percentage",
"secondary_image",
"is_removed",
"is_removed",
"misc_label"
"misc_label"
Line 133: 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>

Revision as of 22:42, 20 June 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.

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
Location1

The connection's target location.

Example
Dream Park
Stringrequired
Aliasalias

The alias of the connection. This supersedes the location's name if specified.

Stringoptional
Locked Connection Typeunlock_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.

Suggested values
Locked Unlock LockedCondition
Stringoptional
Unlock Conditionsunlock_conditions

Description for a conditionally-locked connection. Applicable if Lock Condition is set to LockedCondition.

Stringoptional
Unlock Instruction Linkunlock_instruction_link

Link to a page pointing to the instructions on how to unlock an area.

Example
Yume 2kki:Unlock Guide
Stringoptional
Chance Descriptionchance_description

Short description for chance-based connections.

Example
1/3 chance
Stringoptional
Chance Percentagechance_percentage

Numeric probability for a chance-based connection. Applicable if Chance Description is specified.

Example
33%
Stringoptional
Effects Neededeffects_needed

The effects needed to enter the area, separated by commas.

Example
Child
Stringoptional
Effect Conjunctioneffect_conjunction

Conjunction for the effects required; applicable if Effects Needed is specified. Defaults to "and", can be changed to "or".

Suggested values
and or
Default
and
Stringoptional
Seasonseason

The season at which an area is accessible.

Suggested values
Winter Spring Summer Fall
Stringoptional
Phonebooth Typephonebooth_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.

Suggested values
Shortcut ExitPoint
Stringoptional
Isolation Typeisolation_type

Determines what side an isolated connection is. Accepted values are DeadEnd and Return. The former is used on the page containing the isolated section itself.

Suggested values
DeadEnd Return
Stringoptional
One Way Typeone_way_type

Parameter for a one-way connection. Accepted values are NoReturn and NoEntry.

Suggested values
NoReturn NoEntry
Stringoptional
Chaser Typechaser_type

For chasers and chaser traps. Accepted values are Catch and Trap.

Suggested values
Catch Trap
Stringoptional
Directionsdirections

A short description on the directions to a connection within the area.

Example
Climb the ladder from the barricaded doorway.
Stringoptional
Primary Imageprimary_image

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
Stringoptional
Secondary Imagesecondary_image

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
Stringoptional
Is Removedis_removed

Indicates whether the connection has been removed. Defaults to false.

Default
false
Booleanoptional
Miscellaneous Labelmisc_label

Text indicating some other attribute or description regarding the connection.

Stringoptional

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 LockedCondition🔐 Child NoReturn➡️