Effects - Revision history

Pbelanger: Added link to Tag Reference

2020-10-14T02:02:04Z

Added link to Tag Reference

← Older revision		Revision as of 02:02, 14 October 2020
Line 1:		Line 1:
	[[File:Effects.PNG]]		[[File:Effects.PNG]]

	This page contains some of the more technical aspects of creating Effects. It ties in closely with [[Comic Editor Reference]] and [[Story Inputs and Outputs]]. In some Effects, you may want to know about certain [[Expressions]] for calculating values via functions or information from the game.		This page contains some of the more technical aspects of creating Effects. It ties in closely with [[Comic Editor Reference]] and [[Story Inputs and Outputs]]. In some Effects, you may want to know about certain [[Expressions]] for calculating values via functions or information from the game, or [[Tag Reference\|Tags]] to display certain information to the player.

	Note that the [[Comic Editor Reference\|comic editor]] has buttons that can add some of these things (New Story Role, New Target, New NPC, and New Choice), so if you've used that, you're already familiar with some of this!		Note that the [[Comic Editor Reference\|comic editor]] has buttons that can add some of these things (New Story Role, New Target, New NPC, and New Choice), so if you've used that, you're already familiar with some of this!

Pbelanger: /* How many, and how to choose them */ Removed hideCapstoneAnnouncement

2020-02-27T15:16:30Z

How many, and how to choose them: Removed hideCapstoneAnnouncement

← Older revision		Revision as of 15:16, 27 February 2020
Line 140:		Line 140:
	*** '''customText:''' Custom text to show on the buttons of specified heroes		*** '''customText:''' Custom text to show on the buttons of specified heroes
	*** '''customTextTooltip:''' Tooltip that will be shown if the custom text is hovered over		*** '''customTextTooltip:''' Tooltip that will be shown if the custom text is hovered over
	** '''hideCapstoneAnnouncement:''' If true, this slots dialog won't show the special "capstone" announcement for capstone sites. Useful if there are non-capstone-battle choices being made on the capstone site
	** '''mustSelect:''' If true, the player must select someone; no back button is shown, and the window cannot be exited		** '''mustSelect:''' If true, the player must select someone; no back button is shown, and the window cannot be exited
	** '''onlyShowEligibleHeroes:''' If true, only eligible heroes will be shown in the "All Heroes" roster. (If false, ineligible hero buttons will be disabled but still shown)		** '''onlyShowEligibleHeroes:''' If true, only eligible heroes will be shown in the "All Heroes" roster. (If false, ineligible hero buttons will be disabled but still shown)

Pbelanger: /* How many, and how to choose them */ Added slots hideCapstoneAnnouncement, mustSelect, onlyShowEligibleHeroes, and hideCosts

2020-02-26T21:28:21Z

How many, and how to choose them: Added slots hideCapstoneAnnouncement, mustSelect, onlyShowEligibleHeroes, and hideCosts

← Older revision		Revision as of 21:28, 26 February 2020
Line 140:		Line 140:
	*** '''customText:''' Custom text to show on the buttons of specified heroes		*** '''customText:''' Custom text to show on the buttons of specified heroes
	*** '''customTextTooltip:''' Tooltip that will be shown if the custom text is hovered over		*** '''customTextTooltip:''' Tooltip that will be shown if the custom text is hovered over
			** '''hideCapstoneAnnouncement:''' If true, this slots dialog won't show the special "capstone" announcement for capstone sites. Useful if there are non-capstone-battle choices being made on the capstone site
			** '''mustSelect:''' If true, the player must select someone; no back button is shown, and the window cannot be exited
			** '''onlyShowEligibleHeroes:''' If true, only eligible heroes will be shown in the "All Heroes" roster. (If false, ineligible hero buttons will be disabled but still shown)
			** '''hideCosts:''' If true, won't show the costs table
	* '''scoreFunction:''' When choose=BY_SCORE, this score function is used to pick from among multiple potential matches.		* '''scoreFunction:''' When choose=BY_SCORE, this score function is used to pick from among multiple potential matches.
	* '''scoreThreshold:''' when choose=BY_SCORE, scoreFunction must be at least this value for this to match		* '''scoreThreshold:''' when choose=BY_SCORE, scoreFunction must be at least this value for this to match

Pbelanger: /* Ability */ Added jobType

2020-02-26T21:25:34Z

Ability: Added jobType

← Older revision		Revision as of 21:25, 26 February 2020
Line 82:		Line 82:
	** '''helperContributionSpeed:''' Each additional participant's contribution is multiplied by this number (generally used to produce diminishing returns)		** '''helperContributionSpeed:''' Each additional participant's contribution is multiplied by this number (generally used to produce diminishing returns)
	* '''resourceCosts:''' jobs may also consume resources.		* '''resourceCosts:''' jobs may also consume resources.
			* '''jobType:''' Is this a special type of job? (e.g. a capstone mission)
	* '''encounterScore:''' Encounters with higher scores will always happen instead of ones with lower scores, if possible.		* '''encounterScore:''' Encounters with higher scores will always happen instead of ones with lower scores, if possible.
	* '''encounterWeight:''' How likely is it for this encounter to happen vs other encounters with the same score? i.e. A weight of 2 is twice as likely as a weight of 1.		* '''encounterWeight:''' How likely is it for this encounter to happen vs other encounters with the same score? i.e. A weight of 2 is twice as likely as a weight of 1.

Pbelanger: /* Feedback to player */ Added movementFeedbackRoleOverride

2020-02-10T20:04:42Z

Feedback to player: Added movementFeedbackRoleOverride

← Older revision		Revision as of 20:04, 10 February 2020
Line 165:		Line 165:
	** '''feedbackSource:''' Overrides the source of the feedback. This is useful for AOE attacks, like splinterblast. This can usually be left null for direct attacks.		** '''feedbackSource:''' Overrides the source of the feedback. This is useful for AOE attacks, like splinterblast. This can usually be left null for direct attacks.
	** '''showMovementFeedback:''' Should FEEDBACK_MOVEMENT and FEEDBACK_MOVEMENT_PREDICTION effect feedback be shown for this target? Should generally be true if this target is a movement destination. (e.g. Zealous Leap)		** '''showMovementFeedback:''' Should FEEDBACK_MOVEMENT and FEEDBACK_MOVEMENT_PREDICTION effect feedback be shown for this target? Should generally be true if this target is a movement destination. (e.g. Zealous Leap)
			** '''movementFeedbackRoleOverride:''' If showMovementFeedback is true, this will override the role that we're showing movement feedback for. (If null, uses the relativeTo role by default)
	* '''overlandFeedback:''' Feedback shown on the Overland map		* '''overlandFeedback:''' Feedback shown on the Overland map
	* '''cardChoice:''' Special case choices		* '''cardChoice:''' Special case choices

Pbelanger: /* Feedback to player */ Added showMovementFeedback

2020-01-29T00:13:12Z

Feedback to player: Added showMovementFeedback

← Older revision		Revision as of 00:13, 29 January 2020
Line 164:		Line 164:
	** '''applyRoleFootprint:''' If set, the footprint of this role will be applied to tile feedback. Useful when providing feedback that involves moving multi-tiled entities, so the feedback shows the full entity footprint size instead of just the origin tile. (Often used with AbilityTarget.roleMustFit)		** '''applyRoleFootprint:''' If set, the footprint of this role will be applied to tile feedback. Useful when providing feedback that involves moving multi-tiled entities, so the feedback shows the full entity footprint size instead of just the origin tile. (Often used with AbilityTarget.roleMustFit)
	** '''feedbackSource:''' Overrides the source of the feedback. This is useful for AOE attacks, like splinterblast. This can usually be left null for direct attacks.		** '''feedbackSource:''' Overrides the source of the feedback. This is useful for AOE attacks, like splinterblast. This can usually be left null for direct attacks.
			** '''showMovementFeedback:''' Should FEEDBACK_MOVEMENT and FEEDBACK_MOVEMENT_PREDICTION effect feedback be shown for this target? Should generally be true if this target is a movement destination. (e.g. Zealous Leap)
	* '''overlandFeedback:''' Feedback shown on the Overland map		* '''overlandFeedback:''' Feedback shown on the Overland map
	* '''cardChoice:''' Special case choices		* '''cardChoice:''' Special case choices

Pbelanger: /* Ability */ Added customSpecialAnimationEffect

2020-01-23T15:47:25Z

Ability: Added customSpecialAnimationEffect

← Older revision		Revision as of 15:47, 23 January 2020
Line 64:		Line 64:
	* '''specialAnimationEffect:''' Should there be a specific effect on the ability use animation?		* '''specialAnimationEffect:''' Should there be a specific effect on the ability use animation?
	* '''specialAnimationExpression:''' Any float that goes along with the special effect (like "Bloodrage (+2)" needing to pass in the "2")		* '''specialAnimationExpression:''' Any float that goes along with the special effect (like "Bloodrage (+2)" needing to pass in the "2")
			* '''customSpecialAnimationEffect:''' Allows for a custom special animation effect when used in a roll effect like DAMAGE_ROLL or DEFENSE_ROLL. Useful for showing extra damage or defense provided by an effect, e.g. "Bloodrage (+2)"
			** '''text:''' Text to display as a special effect. This can include parameters in the form of {0}, {1}, etc.
			** '''parameters:''' Values to replace the parameters in the text field. ex: putting COUNT.target here could make the text "Targets ({0})" show up as "Targets (2)"
			** '''scriptName:''' The animation script to use for the special effect
			** '''textColor:''' The text color for the special effect
	* '''disallowStunt:''' If true, this ability and any abilities branching from it won't use stunt. Useful for things like Guardian and Sentinel.		* '''disallowStunt:''' If true, this ability and any abilities branching from it won't use stunt. Useful for things like Guardian and Sentinel.
	* '''specialTreatment:''' Special cases for certain events		* '''specialTreatment:''' Special cases for certain events

Pbelanger: /* Ability */ Added extraUI class and fields

2019-12-20T19:14:30Z

Ability: Added extraUI class and fields

← Older revision		Revision as of 19:14, 20 December 2019
Line 54:		Line 54:
	* '''showInCharacterSheet:''' If true, this ability will show up in the character sheet's combat tab, as well as hero/monster tooltips		* '''showInCharacterSheet:''' If true, this ability will show up in the character sheet's combat tab, as well as hero/monster tooltips
	* '''onlyShowIfPossibleInCharacterSheet:''' If true, (and showInCharacterSheet is true) this ability will show up in the character sheet's combat tab, as well as hero/monster tooltips, but ONLY if it's currently possible to execute this ability		* '''onlyShowIfPossibleInCharacterSheet:''' If true, (and showInCharacterSheet is true) this ability will show up in the character sheet's combat tab, as well as hero/monster tooltips, but ONLY if it's currently possible to execute this ability
			* '''extraUI:''' Extra and override information related to the UI shown for this ability (useful when damage or range isn't showing up automatically for the ability, either because it doesn't deal any damage (e.g. bogmoor's Noxious Tongue), the damage isn't dealt immediately (e.g. Jumpjaw), or for some other reason
			** '''overrideDamageShown:''' Overrides the damage shown in tooltips
			** '''overrideDamageType:''' If overrideDamageShown is set, shows it as this damage type
			** '''overrideShredShown:''' If overrideDamageShown is set, overrides the shred shown in tooltips
			** '''overrideRangeShown:''' Overrides the range shown in tooltips
			** '''overrideMinRangeShown:''' If overrideRangeShown is set, overrides the min range shown in tooltips
	* '''hideOnAbilityBar:''' If true, this ability won't show up on the Ability Bar. Useful for AI-only abilities.		* '''hideOnAbilityBar:''' If true, this ability won't show up on the Ability Bar. Useful for AI-only abilities.
	* '''showDescriptionInTooltip:''' If true, tooltips including this ability will show its description. Useful for explaining more complex abilities.		* '''showDescriptionInTooltip:''' If true, tooltips including this ability will show its description. Useful for explaining more complex abilities.

Pbelanger: /* Filter: Tests that we apply to each potential match */ Added aspectValues fields

2019-12-20T15:59:14Z

Filter: Tests that we apply to each potential match: Added aspectValues fields

← Older revision		Revision as of 15:59, 20 December 2019
Line 178:		Line 178:
	* '''aspects:''' A list of aspects the target should have, by id. This can be used to check foe flavor (drauven, gorgon), hero aspects (humanFemale, mystic), and anything else that's an aspect.		* '''aspects:''' A list of aspects the target should have, by id. This can be used to check foe flavor (drauven, gorgon), hero aspects (humanFemale, mystic), and anything else that's an aspect.
	* '''aspectValues:''' An extended version of aspects. Allows for forbidding aspects, checking aspects relative to a different role, and setting a min and max value the aspect must be within.		* '''aspectValues:''' An extended version of aspects. Allows for forbidding aspects, checking aspects relative to a different role, and setting a min and max value the aspect must be within.
			** '''id:''' The aspect id
			** '''forbidden:''' If true, this aspect must NOT exist
			** '''relativeTo:''' Match a relationship aspect between the target and the given role (i.e. the aspect has a parameter storing the given entity id) ''(ex: see how sentinelAttack checks the "sentinelAttackedThisTurnBy" aspect to make sure it doesn't target an enemy it already attacked this turn)''
			** '''minValue:''' The aspect value must be at least this much
			** '''maxValue:''' The aspect value can be at most this much
	* '''relativeTo:''' This target might be defined relative to another target. For example you might want to target an opponent's weapon, or to define a range based on the first target of the ability.		* '''relativeTo:''' This target might be defined relative to another target. For example you might want to target an opponent's weapon, or to define a range based on the first target of the ability.
	* '''notAlreadyMatchedAs:''' Exclude anyone who is already matched as one of these roles.		* '''notAlreadyMatchedAs:''' Exclude anyone who is already matched as one of these roles.

Pbelanger: /* How many, and how to choose them */ Added specialSelectionInfo

2019-12-20T15:41:46Z

How many, and how to choose them: Added specialSelectionInfo

← Older revision		Revision as of 15:41, 20 December 2019
Line 124:		Line 124:
	** '''preFill:''' How should heroes be chosen to prefill the slots dialog?		** '''preFill:''' How should heroes be chosen to prefill the slots dialog?
	** '''requiredRoles:''' These roles are required, and can't be removed from their slots		** '''requiredRoles:''' These roles are required, and can't be removed from their slots
			** '''specialSelectionInfo:''' Can be used to show additional selection information to help the player decide who to choose
			*** '''aspect:''' If the hero has this aspect, show the customText on their button (e.g. show "Bard" on heroes with the Bard ability when recruiting)
			*** '''customText:''' Custom text to show on the buttons of specified heroes
			*** '''customTextTooltip:''' Tooltip that will be shown if the custom text is hovered over
	* '''scoreFunction:''' When choose=BY_SCORE, this score function is used to pick from among multiple potential matches.		* '''scoreFunction:''' When choose=BY_SCORE, this score function is used to pick from among multiple potential matches.
	* '''scoreThreshold:''' when choose=BY_SCORE, scoreFunction must be at least this value for this to match		* '''scoreThreshold:''' when choose=BY_SCORE, scoreFunction must be at least this value for this to match