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



YumeWiki
3,068Articles

Template:Connection/doc: Difference between revisions

No edit summary
No edit summary
Line 30: Line 30:
"unlock_type": {
"unlock_type": {
"label": "Locked Connection Type",
"label": "Locked Connection Type",
"description": "Parameter for a locked connection. Accepted values are Locked, Unlocked, or UnlockCondition.",
"description": "Parameter for a locked connection. Accepted values are Locked, Unlocked, or LockedCondition.",
"example": "NoReturn",
"example": "NoReturn",
"type": "string"
"type": "string"
Line 85: Line 85:
"unlock_conditions": {
"unlock_conditions": {
"label": "Unlock Conditions",
"label": "Unlock Conditions",
"description": "Description for a conditionally-locked connection. Applicable if Lock Condition is set to UnlockCondition.",
"description": "Description for a conditionally-locked connection. Applicable if Lock Condition is set to LockedCondition.",
"type": "string"
"type": "string"
},
},

Revision as of 14:12, 8 December 2022

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
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
Locked Connection Typeunlock_type

Parameter for a locked connection. Accepted values are Locked, Unlocked, or LockedCondition.

Example
NoReturn
Stringoptional
Effects Neededeffects_needed

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

Example
Child
Stringoptional
Seasonseason

The season at which an area is accessible. Accepted values are Winter, Spring, Summer, or Fall.

Stringoptional
Chance Descriptionchance_description

Short description for chance-based connections.

Example
1/3 chance
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 and ExitPoint.

Stringoptional
Isolation Typeisolation_type

Determines what side an isolated connection is. Accepted values are DeadEnd and Return.

Stringoptional
One Way Typeone_way_type

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

Stringoptional
Unlock Instruction Linkunlock_instruction_link

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

Stringoptional
Unlock Conditionsunlock_conditions

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

Stringoptional
Effect Conjunctioneffect_conjunction

Conjunction for the effects required; applicable if Effects Needed is specified. Defaults to And, can be changed to Or.

Default
And
Stringoptional
Chance Percentagechance_percentage

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

Example
33%
Stringoptional
Is Removedis_removed

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

Default
false
Unknownoptional
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 output

{{Connection|Scrambled Egg Zone|effects_needed=Child|unlock_type=LockedCondition|unlock_instructions=Requires breaking the egg in the Guardians' Temple and having the orbs show on each pillar.|one_way_type=NoReturn}}

Scrambled Egg Zone Child NoReturn➡️