Template:Connection: Difference between revisions

Revision as of 19:55, 23 June 2024

Documentation (for the above template, sometimes hidden or invisible)

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.
Parameter		Description	Type	Status
Location	`1`	The connection's target location. Example Dream Park	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. Suggested values `Locked` `Unlock` `LockedCondition`	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. Example Yume 2kki:Unlock Guide	String	optional
Chance Description	`chance_description`	Short description for chance-based connections. Example 1/3 chance	String	optional
Chance Percentage	`chance_percentage`	Numeric probability for a chance-based connection. Applicable if Chance Description is specified. Example 33%	String	optional
Effects Needed	`effects_needed`	The effects needed to enter the area, separated by commas. Example Child	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". Suggested values `and` `or` Default and	String	optional
Season	`season`	The season at which an area is accessible. Suggested values `Winter` `Spring` `Summer` `Fall`	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. Suggested values `Shortcut` `ExitPoint`	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. Suggested values `DeadEnd` `Return`	String	optional
One Way Type	`one_way_type`	Parameter for a one-way connection. Accepted values are NoReturn and NoEntry. Suggested values `NoReturn` `NoEntry`	String	optional
Chaser Type	`chaser_type`	For chasers and chaser traps. Accepted values are Catch and Trap. Suggested values `Catch` `Trap`	String	optional
Directions	`directions`	A short description on the directions to a connection within the area. Example Climb the ladder from the barricaded doorway.	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. Example Art Gallery and Dream Park_1.png	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. Example Art Gallery and Dream Park_2.png	String	optional
Is Removed	`is_removed`	Indicates whether the connection has been removed. Defaults to false. Default 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 🔐 ➡️

Visit Template:Connection/doc to edit this text! (How does this work?)

@@ Line 52: / Line 52: @@
 |Trap = {{Chaser|Trap}}
 |Catch = {{Chaser|Catch}}
-}} {{#ifeq:{{PAGENAME}}|{{DREAMROOM}}||{{#if:{{#switch:{{#replace:{{{1}}}|The|}}|{{NEXUSNAME}} = |default}}||[[Category:{{NAMESPACE}} {{NEXUSNAME}} Worlds]]}}{{#if:{{#switch:{{NAMESPACE}}|Uneven Dream|Yume Tagai= |default}}||{{#ifeq:{{PAGENAME}}|Kubotsuki's Dream Room||{{#if:{{#pos:{{{1}}}|Nexus}}|[[Category:{{{1}}} Worlds]][[Category:{{NAMESPACE}} Nexus Worlds]]}}}}}}}} {{#if: {{{misc_label|}}}|({{{misc_label}}})}}|<span title="Please enter the location as the first parameter." style="font-size:125%; color:#FFFF00; background-color:#000000">⚠</span>}}</includeonly>
+}}<!-- Begin nexus world category checks
+-->{{#ifeq: {{PAGENAME}}<!-- No category if location is DREAMROOM
+-->|        {{DREAMROOM}}<!--
+-->|<!--
+-->|  {{#if:<!-- Place category only if input is empty
+      -->{{#switch:<!-- Returns empty if connection matches {{NEXUSNAME}}
+         -->{{#replace:{{{1}}}|The|}}<!--
+      -->|{{NEXUSNAME}} = <!--
+      -->|default<!--
+      -->}}<!--
+      -->{{{one_way_type|}}}<!-- One-ways do not place category
+   -->|<!--
+   -->|[[Category:{{NAMESPACE}} {{NEXUSNAME}} Worlds]]<!--
+   -->}}<!--
+   -->{{#if:<!-- Handling character-specific nexus worlds category. Wiki-dependent!
+      -->{{#switch: {{NAMESPACE}}<!-- Returns empty if wiki is UD or Tagai
+      -->|Uneven Dream|Yume Tagai = <!--
+      -->|default<!--
+      -->}}<!--
+   -->|<!-- No category unless empty
+   -->|  {{#ifeq:{{PAGENAME}}<!--
+      -->|Kubotsuki's Dream Room<!-- DREAMROOM allows us to exclude Totsutsuki's Dream Room, but we must repeat this check for Kubotsuki. Yume Tagai has one shared Bedroom location so it does not need such a check.
+      -->|<!-- No category if location is the other dream room
+      -->|  {{#if: {{#pos:{{{1}}}|Nexus}}<!-- Check if the connection is to any "Nexus"
+         -->|[[Category:{{{1}}} Worlds]]<!-- Category using the connection name
+          -->[[Category:{{NAMESPACE}} Nexus Worlds]]<!-- Generic wiki nexus world category
+         -->}}<!-- End: "Nexus" in connection name
+      -->}}<!-- End: secondary dream room check
+   -->}}<!-- End: character-specific nexus worlds category
+-->}}<!-- End: DREAMROOM check. This ends the nexus world section.
+-->{{#if: {{{misc_label|}}}|({{{misc_label}}})}}|<span title="Please enter the location as the first parameter." style="font-size:125%; color:#FFFF00; background-color:#000000">⚠</span>}}</includeonly>
 <noinclude>
 {{Documentation}}