Module:A/doc - Revision history

Gpe: /* Module:A Parameter Documentation */

2025-03-29T20:00:31Z

Module:A Parameter Documentation

Gpe: // via Wikitext Extension for VSCode

2025-01-06T21:13:04Z

// via Wikitext Extension for VSCode

← Older revision		Revision as of 21:13, 6 January 2025
Line 104:		Line 104:
	==== Duration (<code>duration</code>, <code>dur</code>, <code>dr</code>) ====		==== Duration (<code>duration</code>, <code>dur</code>, <code>dr</code>) ====
	* <code>instant</code>/<code>in</code>/<code>i</code>/<code>0</code> - Instant duration		* <code>instant</code>/<code>in</code>/<code>i</code>/<code>0</code> - Instant duration
	* <code>always</code> - Always active		* <code>always</code>/<code>forever</code>/<code>4</code>/<code>inf</code> - Always active
			** Note: Use one of the aliases. Entering <code>always</code> is currently bugged.
	* <code>whileUp</code>/<code>up</code>/<code>u</code> - While up		* <code>whileUp</code>/<code>up</code>/<code>u</code> - While up
	* <code>whileDown</code>/<code>dn</code>/<code>d</code> - While down		* <code>whileDown</code>/<code>dn</code>/<code>d</code> - While down

Gpe: // via Wikitext Extension for VSCode

2025-01-06T21:09:25Z

// via Wikitext Extension for VSCode

← Older revision		Revision as of 21:09, 6 January 2025
Line 104:		Line 104:
	==== Duration (<code>duration</code>, <code>dur</code>, <code>dr</code>) ====		==== Duration (<code>duration</code>, <code>dur</code>, <code>dr</code>) ====
	* <code>instant</code>/<code>in</code>/<code>i</code>/<code>0</code> - Instant duration		* <code>instant</code>/<code>in</code>/<code>i</code>/<code>0</code> - Instant duration
	* <code>always~~</code>/<code>al</code>/<code>a~~</code> - Always active		* <code>always</code> - Always active
	* <code>whileUp</code>/<code>up</code>/<code>u</code> - While up		* <code>whileUp</code>/<code>up</code>/<code>u</code> - While up
	* <code>whileDown</code>/<code>dn</code>/<code>d</code> - While down		* <code>whileDown</code>/<code>dn</code>/<code>d</code> - While down
Line 118:		Line 118:
	* Time duration format: <code>XmXhXdXwXy</code> (minutes, hours, days, weeks, years)		* Time duration format: <code>XmXhXdXwXy</code> (minutes, hours, days, weeks, years)

	===== Sustained ~~(<code>sustained</code>, <code>sus</code>)~~ =====		===== Sustained Flag =====
	* <code>sustained</code>/<code>sus</code>/<code>s~~</code>/<code>1~~</code> - ~~Mark~~ ~~this~~ ~~ability as requiring sustain~~		* <code>sustained</code>/<code>sus</code>/<code>s</code> - Ability is sustained

	==== Range (<code>range</code>, <code>rng</code>, <code>r</code>) ====		==== Range (<code>range</code>, <code>rng</code>, <code>r</code>) ====

Gpe: // via Wikitext Extension for VSCode

2025-01-06T20:45:22Z

// via Wikitext Extension for VSCode

← Older revision		Revision as of 20:45, 6 January 2025
Line 118:		Line 118:
	* Time duration format: <code>XmXhXdXwXy</code> (minutes, hours, days, weeks, years)		* Time duration format: <code>XmXhXdXwXy</code> (minutes, hours, days, weeks, years)

	===== Sustained ~~Flag~~ =====		===== Sustained (<code>sustained</code>, <code>sus</code>) =====
	* <code>sustained</code>/<code>sus</code>/<code>s</code> - ~~Ability~~ is ~~sustained~~		* <code>sustained</code>/<code>sus</code>/<code>s</code>/<code>1</code> - Mark this ability as requiring sustain

	==== Range (<code>range</code>, <code>rng</code>, <code>r</code>) ====		==== Range (<code>range</code>, <code>rng</code>, <code>r</code>) ====

Gpe: // via Wikitext Extension for VSCode

2025-01-06T20:43:51Z

// via Wikitext Extension for VSCode

@@ Line 54: / Line 54: @@
 * <code>passive</code>/<code>ps</code>/<code>p</code> - Passive maneuver
 * <code>slow</code>/<code>sl</code>/<code>s</code> - Slow maneuver
 ==== Interaction Type (<code>interaction</code>, <code>int</code>, <code>i</code>) ====

Gpe: // via Wikitext Extension for VSCode

2025-01-06T20:40:41Z

// via Wikitext Extension for VSCode

← Older revision		Revision as of 20:40, 6 January 2025
Line 106:		Line 106:
	* <code>endOfCombat</code>/<code>ec</code> - Until end of combat		* <code>endOfCombat</code>/<code>ec</code> - Until end of combat
	* Time duration format: <code>XmXhXdXwXy</code> (minutes, hours, days, weeks, years)		* Time duration format: <code>XmXhXdXwXy</code> (minutes, hours, days, weeks, years)

			===== Sustained Flag =====
			* <code>sustained</code>/<code>sus</code>/<code>s</code> - Ability is sustained

	==== Range (<code>range</code>, <code>rng</code>, <code>r</code>) ====		==== Range (<code>range</code>, <code>rng</code>, <code>r</code>) ====

Gpe: // via Wikitext Extension for VSCode

2025-01-06T20:33:34Z

// via Wikitext Extension for VSCode

← Older revision		Revision as of 20:33, 6 January 2025
Line 10:		Line 10:
	* <code>name</code> - The name of the ability (required)		* <code>name</code> - The name of the ability (required)
	* <code>e</code> - The effect/description of the ability		* <code>e</code> - The effect/description of the ability
	* <code>trigger</code> - What triggers the ability to activate ~~(required for reactive abilities)~~		* <code>trigger</code> - What triggers the ability to activate

	==== Type Flags ====		==== Type Flags ====
	* <code>skill</code> - Flag to mark this as a skill ability		* <code>skill</code> - Flag to mark this as a skill ability
			** Setting a warrior or semi class will automatically set this flag to <code>true</code>. This can be overridden by setting it to <code>0</code> or <code>false</code>.
	* <code>spell</code> - Flag to mark this as a spell ability		* <code>spell</code> - Flag to mark this as a spell ability
			** Setting a mage class will automatically set this flag to <code>true</code>. This can be overridden by setting it to <code>0</code> or <code>false</code>.
	* <code>standard</code> - Flag to mark this as a standard ability		* <code>standard</code> - Flag to mark this as a standard ability
			** Setting a class will automatically set this flag to <code>true</code>. This can be overridden by setting it to <code>0</code> or <code>false</code>.
			** Note that abilities that are provided by other class abilities are ''not'' always considered standard abilities nor abilities of that class. The main exceptions are crowns and other mage rotators.

	==== Class Information ====		==== Class Information ====

Gpe: /* Basic Information */

2025-01-06T20:27:29Z

Basic Information

← Older revision		Revision as of 20:27, 6 January 2025
Line 10:		Line 10:
	* <code>name</code> - The name of the ability (required)		* <code>name</code> - The name of the ability (required)
	* <code>e</code> - The effect/description of the ability		* <code>e</code> - The effect/description of the ability
	* <code>trigger</code> - What triggers the ability to activate		* <code>trigger</code> - What triggers the ability to activate (required for reactive abilities)

	==== Type Flags ====		==== Type Flags ====

Gpe: // via Wikitext Extension for VSCode

2025-01-06T20:26:42Z

// via Wikitext Extension for VSCode

← Older revision		Revision as of 20:26, 6 January 2025
Line 277:		Line 277:
	* Managing component requirements for invoked abilities		* Managing component requirements for invoked abilities

	[[Category:Module documentation]]		<noinclude>[[Category:Module documentation]]</noinclude>

Gpe: // via Wikitext Extension for VSCode

2025-01-06T20:26:08Z

// via Wikitext Extension for VSCode

← Older revision		Revision as of 20:26, 6 January 2025
Line 1:		Line 1:
	== Module:A Parameter Documentation ==		== Module:A Parameter Documentation ==

	This page details all the parameters and their aliases accepted by the Module:A Scribunto module for formatting TTRPG abilities.		This page details all the parameters and their aliases accepted by the Module:A Scribunto module for formatting TTRPG abilities. Call the module using:

			<pre>{{#invoke:A\|a\|name=Example Ability\|<other parameters>}}</pre>

	=== Core Parameters ===		=== Core Parameters ===
Line 16:		Line 18:

	==== Class Information ====		==== Class Information ====
	* <code>class</code> - The class this ability belongs to. Supported values:		* <code>class</code> - The class this ability belongs to<br />Supported values:
	** <code>bar</code>/<code>ber</code> (Berserker)		** <code>bar</code>/<code>ber</code> (Berserker)
	** <code>sam</code>/<code>due</code> (Duelist)		** <code>sam</code>/<code>due</code> (Duelist)
Line 32:		Line 34:
	** <code>nec</code> (Necromancer)		** <code>nec</code> (Necromancer)
	** <code>nat</code> (Nature Mage)		** <code>nat</code> (Nature Mage)
	* <code>arch</code> - Override the default archetype for a class. Supported values:		* <code>arch</code> - Override the default archetype for a class<br />Supported values:
	** <code>warr</code> (Warrior)		** <code>warr</code> (Warrior)
	** <code>semi</code> (Semi)		** <code>semi</code> (Semi)
	** <code>mage</code> (Mage)		** <code>mage</code> (Mage)
	* <code>rank</code> - The rank requirement for the ability		* <code>rank</code> - The rank requirement for the ability<br />Supported values:
			** <code>1</code> (Rank 1)
			** <code>2</code> (Rank 2)
			** <code>3</code> (Rank 3+)

	=== Ability Properties ===		=== Ability Properties ===
Line 61:		Line 66:
	* <code>weapon</code>/<code>wep</code>/<code>w</code> - Weapon delivery		* <code>weapon</code>/<code>wep</code>/<code>w</code> - Weapon delivery
	* <code>shield</code>/<code>shl</code>/<code>sh</code> - Shield delivery		* <code>shield</code>/<code>shl</code>/<code>sh</code> - Shield delivery
	* <code>armor</code>/<code>rmr</code>/<code>a</code> - Armor delivery		* <code>armor</code>/<code>rmr</code>/<code>r</code> - Armor delivery
	* <code>sight</code>/<code>sit</code>/<code>eye</code>/<code>e</code> - Sight delivery		* <code>sight</code>/<code>sit</code>/<code>eye</code>/<code>e</code> - Sight delivery
	* <code>aura</code>/<code>aur</code>/<code>a</code> - Aura delivery		* <code>aura</code>/<code>aur</code>/<code>a</code> - Aura delivery
Line 78:		Line 83:
	* <code>weapon</code>/<code>wep</code>/<code>w</code> - Weapon target		* <code>weapon</code>/<code>wep</code>/<code>w</code> - Weapon target
	* <code>shield</code>/<code>shl</code>/<code>sh</code> - Shield target		* <code>shield</code>/<code>shl</code>/<code>sh</code> - Shield target
	* <code>armor</code>/<code>rmr</code>/<code>a</code> - Armor target		* <code>armor</code>/<code>rmr</code>/<code>r</code> - Armor target
	* <code>attack</code>/<code>atk</code>/<code>a</code> - Attack target		* <code>attack</code>/<code>atk</code>/<code>a</code> - Attack target
	* <code>other</code>/<code>oth</code>/<code>o</code> - Other target		* <code>other</code>/<code>oth</code>/<code>o</code> - Other target
Line 172:		Line 177:
	* <code>summon</code> - Summoning effect		* <code>summon</code> - Summoning effect
	* <code>heal</code> - Healing effect		* <code>heal</code> - Healing effect

			=== State Parameters ===
			* <code>end</code> - The condition under which the ability ends

	=== Results Parameters ===		=== Results Parameters ===

← Older revision		Revision as of 20:00, 29 March 2025
Line 49:		Line 49:
	=== Ability Properties ===		=== Ability Properties ===

	==== Maneuver Type (<code>maneuver</code>, <code>man</code>, <code>m</code>) ====		==== Maneuver Type (<code>maneuver</code>/<code>man</code>/<code>m</code>) ====
	* <code>active</code>/<code>ac</code>/<code>a</code> - Active maneuver		* <code>active</code>/<code>ac</code>/<code>a</code> - Active maneuver
	* <code>reactive</code>/<code>re</code>/<code>r</code> - Reactive maneuver		* <code>reactive</code>/<code>re</code>/<code>r</code> - Reactive maneuver
Line 55:		Line 55:
	* <code>slow</code>/<code>sl</code>/<code>s</code> - Slow maneuver		* <code>slow</code>/<code>sl</code>/<code>s</code> - Slow maneuver

	===== Execution Time (<code>executionTime</code>, <code>time</code>, <code>et</code>, <code>x</code>) =====		===== Execution Time (<code>executionTime</code>/<code>time</code>/<code>et</code>/<code>x</code>) =====
	* <code>0a</code>/<code>freeAction</code>/<code>fa</code> - Free action		* <code>0a</code>/<code>freeAction</code>/<code>fa</code> - Free action
	* <code>1a</code>/<code>a</code>/<code>singleAction</code>/<code>sa</code> - Single action		* <code>1a</code>/<code>a</code>/<code>singleAction</code>/<code>sa</code> - Single action
Line 66:		Line 66:
	* Time duration format: <code>XmXhXdXwXy</code> (minutes, hours, days, weeks, years)		* Time duration format: <code>XmXhXdXwXy</code> (minutes, hours, days, weeks, years)

	==== Interaction Type (<code>interaction</code>, <code>int</code>, <code>i</code>) ====		==== Interaction Type (<code>interaction</code>/<code>int</code>/<code>i</code>) ====
	* <code>attack</code>/<code>atk</code>/<code>a</code> - Attack interaction		* <code>attack</code>/<code>atk</code>/<code>a</code> - Attack interaction
	* <code>block</code>/<code>blk</code>/<code>b</code> - Block interaction		* <code>block</code>/<code>blk</code>/<code>b</code> - Block interaction
Line 72:		Line 72:
	* <code>feat</code>/<code>fea</code>/<code>f</code> - Feat interaction		* <code>feat</code>/<code>fea</code>/<code>f</code> - Feat interaction

	==== Delivery Method (<code>delivery</code>, <code>del</code>, <code>d</code>) ====		==== Delivery Method (<code>delivery</code>/<code>del</code>/<code>d</code>) ====
	* <code>self</code>/<code>sel</code>/<code>s</code> - Self delivery		* <code>self</code>/<code>sel</code>/<code>s</code> - Self delivery
	* <code>missile</code>/<code>mis</code>/<code>m</code> - Missile delivery		* <code>missile</code>/<code>mis</code>/<code>m</code> - Missile delivery
Line 87:		Line 87:
	* <code>other</code>/<code>oth</code>/<code>o</code> - Other delivery		* <code>other</code>/<code>oth</code>/<code>o</code> - Other delivery

	==== Target Type (<code>target</code>, <code>tar</code>, <code>t</code>) ====		==== Target Type (<code>target</code>/<code>tar</code>/<code>t</code>) ====
	* <code>self</code>/<code>sel</code>/<code>s</code> - Self target		* <code>self</code>/<code>sel</code>/<code>s</code> - Self target
	* <code>creature</code>/<code>cre</code>/<code>c</code> - Creature target		* <code>creature</code>/<code>cre</code>/<code>c</code> - Creature target
Line 102:		Line 102:
	* <code>other</code>/<code>oth</code>/<code>o</code> - Other target		* <code>other</code>/<code>oth</code>/<code>o</code> - Other target

	==== Duration (<code>duration</code>, <code>dur</code>, <code>dr</code>) ====		==== Duration (<code>duration</code>/<code>dur</code>/<code>dr</code>) ====
	* <code>instant</code>/<code>in</code>/<code>i</code>/<code>0</code> - Instant duration		* <code>instant</code>/<code>in</code>/<code>i</code>/<code>0</code> - Instant duration
	* <code>always</code>/<code>forever</code>/<code>4</code>/<code>inf</code> - Always active		* <code>always</code>/<code>forever</code>/<code>4</code>/<code>inf</code> - Always active
Line 122:		Line 122:
	* <code>sustained</code>/<code>sus</code>/<code>s</code> - Ability is sustained		* <code>sustained</code>/<code>sus</code>/<code>s</code> - Ability is sustained

	==== Range (<code>range</code>, <code>rng</code>, <code>r</code>) ====		==== Range (<code>range</code>/<code>rng</code>/<code>r</code>) ====
	* <code>melee</code>/<code>m</code> - Melee range		* <code>melee</code>/<code>m</code> - Melee range
	* <code>weapon</code>/<code>w</code> - Weapon range		* <code>weapon</code>/<code>w</code> - Weapon range
Line 134:		Line 134:
	* Distance format: <code>Xf</code> or <code>Xm</code> (feet or miles)		* Distance format: <code>Xf</code> or <code>Xm</code> (feet or miles)

	==== Attribute Saves (<code>attribute</code>, <code>attr</code>, <code>a</code>) ====		==== Attribute Saves (<code>attribute</code>/<code>attr</code>/<code>a</code>) ====
	* <code>int</code>/<code>INT</code>/<code>i</code> - Intelligence save		* <code>int</code>/<code>INT</code>/<code>i</code> - Intelligence save
	* <code>str</code>/<code>STR</code>/<code>s</code> - Strength save		* <code>str</code>/<code>STR</code>/<code>s</code> - Strength save
Line 141:		Line 141:
	* <code>snk</code>/<code>SNK</code>/<code>s</code> - Sneak save		* <code>snk</code>/<code>SNK</code>/<code>s</code> - Sneak save

	==== Expansion Type (<code>expansion</code>, <code>exp</code>) ====		==== Expansion Type (<code>expansion</code>/<code>exp</code>) ====
	* <code>detonate</code>/<code>det</code>/<code>d</code> - Detonate expansion		* <code>detonate</code>/<code>det</code>/<code>d</code> - Detonate expansion
	* <code>ripple</code>/<code>rip</code>/<code>r</code> - Ripple expansion		* <code>ripple</code>/<code>rip</code>/<code>r</code> - Ripple expansion
Line 147:		Line 147:
	* <code>fork</code>/<code>for</code>/<code>f</code> - Fork expansion		* <code>fork</code>/<code>for</code>/<code>f</code> - Fork expansion

	==== Piercing (<code>piercing</code>, <code>prc</code>, <code>p</code>) ====		==== Piercing (<code>piercing</code>/<code>prc</code>/<code>p</code>) ====
	* <code>av0</code>/<code>a</code> - AV0 piercing		* <code>av0</code>/<code>a</code> - AV0 piercing
	* <code>unblockable</code>/<code>ub</code>/<code>u</code> - Unblockable		* <code>unblockable</code>/<code>ub</code>/<code>u</code> - Unblockable