• Welcome to the Kancolle Wiki!
  • If you have any questions regarding site content, account registration, etc., please visit the KanColle Wiki Discord

Difference between revisions of "Template:MapBranchingTable/doc"

From Kancolle Wiki
Jump to navigation Jump to search
(→‎Parameters: Adding documentation for ordering.)
Line 1: Line 1:
==Parameters==
+
==Usage==
 
Below is a list of all parameters available for this template.
 
Below is a list of all parameters available for this template.
 
Keep in mind that invalid parameters and/or arguments will be ignored.
 
Keep in mind that invalid parameters and/or arguments will be ignored.
Line 40: Line 40:
 
{{MapBranchingTable
 
{{MapBranchingTable
 
|width = <value>
 
|width = <value>
 +
}}
 +
</pre>
 +
 +
===Order===
 +
* Allows you to manually set the order of the starting nodes listed from top to bottom.
 +
* '''Note''': Make sure you list all the relevant nodes!
 +
* '''OPTIONAL'''
 +
* Default is alphabetical ordering. This is not desirable if the first node happens to be G, while the second node is C for example.
 +
<pre>
 +
{{MapBranchingTable
 +
|order = G, D, C, Z
 +
|G -> A = *Text...
 +
|D -> A = *Text...
 +
|C -> A = *Text...
 +
|Z -> A = *Text...
 
}}
 
}}
 
</pre>
 
</pre>
Line 93: Line 108:
 
|2 -> C = * Fleet contains a CL
 
|2 -> C = * Fleet contains a CL
 
|2 -> D/empty = * Does not meet the requirements to go to C
 
|2 -> D/empty = * Does not meet the requirements to go to C
 +
}}
 +
<pre>
 +
{{MapBranchingTable
 +
|order = D, Z, C, G
 +
|G -> A = *Text...
 +
|D -> A = *Text...
 +
|C -> A = *Text...
 +
|Z -> A = *Text...
 +
}}
 +
</pre>
 +
{{MapBranchingTable
 +
|order = D, Z, C, G
 +
|G -> A = *Text...
 +
|D -> A = *Text...
 +
|C -> A = *Text...
 +
|Z -> A = *Text...
 
}}
 
}}
  

Revision as of 00:59, 14 February 2017

Usage

Below is a list of all parameters available for this template. Keep in mind that invalid parameters and/or arguments will be ignored.

To invoke this template, simply start with:

{{MapBranchingTable
|<parameters>
|<parameters>
|<parameters>
}}

Title

  • Allows you to set the title of the table
  • OPTIONAL
  • Default value is "Branching Rules" if not specified
{{MapBranchingTable
|title = <value>
}}

Id

  • Allows you to manually set the id of the table. Rarely useful, unless you want multiple tables to be affected by the same button.
  • OPTIONAL
  • Default value is a RNG generated through the RemiLib if not specified.
{{MapBranchingTable
|id = <value>
}}

Width

  • Allows you to set the width of the table. Value has to be a valid css width property.
  • Check the following link if you're unfamiliar with css width properties.
  • OPTIONAL
  • Default is "auto" if not specified or if the value given is invalid.
{{MapBranchingTable
|width = <value>
}}

Order

  • Allows you to manually set the order of the starting nodes listed from top to bottom.
  • Note: Make sure you list all the relevant nodes!
  • OPTIONAL
  • Default is alphabetical ordering. This is not desirable if the first node happens to be G, while the second node is C for example.
{{MapBranchingTable
|order = G, D, C, Z
|G -> A = *Text...
|D -> A = *Text...
|C -> A = *Text...
|Z -> A = *Text...
}}

Branching Rules

  • Creates nodes for your branching table.
  • REQUIRED

<"From" Node/[color]> -> <"To" Node/[color]> = <argument value> for single rows for each node
OR
<"From" Node/[color]> -> <"To" Node/[color]>,<"To" Node/[color]> = <argument value> for joint rows.

  • Valid node values are:
    • 0 = Start
    • 1, 2, 3, etc = Starting points, when a map has multiple starting points.
    • A single alphabetical letter from A to Z
  • To add a color to a node (OPTIONAL), add the following value behind the node:
    • /battle, default if not specified
    • /empty
    • /storm
    • /resource
    • Any other valid color value.
{{MapBranchingTable
|title = Example
|width = 50%
|0 -> 1 =
* Fleet contains a CL
* Fleet does not meet the requirements to start at 2
|0 -> 2 = 
* Fleet contains no CL
* Fleet contains CV(L)
* Fleet contains CLT

|1 -> A/storm, B/resource = * Random
|2 -> C = * Fleet contains a CL
|2 -> D/empty = * Does not meet the requirements to go to C
}}
Example
Nodes Rules
Start
1
  • Fleet contains a CL
  • Fleet does not meet the requirements to start at 2
2
  • Fleet contains no CL
  • Fleet contains CV(L)
  • Fleet contains CLT
1
A
  • Random
B
2
C
  • Fleet contains a CL
D
  • Does not meet the requirements to go to C
{{MapBranchingTable
|order = D, Z, C, G
|G -> A = *Text...
|D -> A = *Text...
|C -> A = *Text...
|Z -> A = *Text...
}}
Branching Rules
Nodes Rules
D
A
  • Text...
Z
A
  • Text...
C
A
  • Text...
G
A
  • Text...


Examples

Example 1

{{MapBranchingTable
|title = Example 1
|0 -> 1, 2 = Some text...
|1 -> A = Some text...
|1 -> B/resource = [[DD]], [[CL]]
|1 -> C/storm =
* A
* list
|C/storm -> D/empty = ...
}}
Example 1
Nodes Rules
Start
1

Some text...

2
1
A

Some text...

B

DD, CL

C
  • A
  • list
C
D

...


Example 2

{{MapBranchingTable
|width = auto
|0 -> 1 = Some text...
|0 -> 2 = Some text...
|1 -> A = Some text...
|1 -> B/resource = [[DD]], [[CL]]
|1 -> C/storm =
* A
* list
|C/storm -> D/empty = ...
}}
Branching Rules
Nodes Rules
Start
1

Some text...

2

Some text...

1
A

Some text...

B

DD, CL

C
  • A
  • list
C
D

...


Example 3

{{MapBranchingTable
|id = E-1
|width = auto
|0 -> 1, 2, 3 = * Random
|Q -> = Invalid because there is no destination node
|QW -> SD = Invalid because there are more than 1 letters assigned per node
}}

}}
Branching Rules
Nodes Rules
Start
1
  • Random
2
3
QW
SD

Invalid because there are more than 1 letters assigned per node. Ignored


Credits

Special thanks to がか(gaka) for writing this module.