Effect (Asset): Difference between revisions

Latest revision as of 16:58, 19 February 2025

An effect is a block of data that describes something that should affect a player, such as modifying HP or stats. Effects are tied to Wrappers which may contain multiple effects. Effects are always triggered by events.


Field	Type	Default	Description
Label	String		A unique label for your effect. Do not change this after setting up your effect!
Description	String		Describe your effect. This is not used in game, but helps search in the editor.
Type	String		Effect type. When you change this value, the description below will change.
Don't multiply by stacks	Boolean	False	By default, most integer values will be multiplied by the nr of stacks in the parent wrapper. Checking this sets the stack count to a fixed 1.
Debug	Boolean	False	Used to output debug output. Only use if you're modifying the FQ source code.
Targets	Array		Sets what targets the effects should affect. Auto is usually the parent wrapper target.
Events	Array		List of events that should trigger the effect. internalWrapperTick is triggered when an instant wrapper is triggered, or a duration wrapper ticks. For most instant effects, you just want internalWrapperTick. You can use as many as you want.
Effect Data	JSON		A JSON object which changes based on the type of effect you're editing. Above the editor is a description of the fields you can use, and what the effect does.
Tags	Tag		Tags to apply to the target(s) while affected by the effect.
Conditions	Conditions		Conditions required for the effect to trigger, or in the case of modifier effects (such as stat modifiers), to apply to the target(s).
Subconditions	Conditions		Conditions are always checked with sender/target being the same as the event that triggered the effect. However, if you use a target other than sender/target, and want to check conditions on the recipient, then you can use a subcondition. Sender of the subcondition is always the parent wrapper's owner.

Notes

If the target of the event that triggered the effect is the holder of the wrapper this effect is attached to, then it flips target/sender. So generally you want to flip so ta_ vars target the owner of the effect, whereas se_ will target the target of the effect. I don't remember why I made it this way, but I think it was important.
By default, mathVar targets will be the target(s) set in the targets section. If you want to access the parent wrapper's sender or target, you have access to pws_ and pwt_. These stand for parentWrapperSender and parentWrapperTarget, and contain data about the effect parent wrapper\'s send and target.

@@ Line 1: / Line 1: @@
-An effect is a block of data that describes something that should affect a player, such as modifying HP or stats. Effects are tied to [[Wrapper (Asset)|Wrappers]] which may contain multiple effects.
+An effect is a block of data that describes something that should affect a player, such as modifying HP or stats. Effects are tied to [[Wrapper (Asset)|Wrappers]] which may contain multiple effects. Effects are always triggered by events.
 {| class="wikitable"
 |+
@@ Line 12: / Line 12: @@
 |A unique label for your effect. '''Do not change this after setting up your effect!'''
 |-
+|Description
+|String
 |
+|Describe your effect. This is not used in game, but helps search in the editor.
+|-
+|Type
+|String
 |
+|Effect type. When you change this value, the description below will change.
+|-
+|Don't multiply by stacks
+|Boolean
+|False
+|By default, most integer values will be multiplied by the nr of stacks in the parent wrapper. Checking this sets the stack count to a fixed 1.
+|-
+|Debug
+|Boolean
+|False
+|Used to output debug output. Only use if you're modifying the FQ source code.
+|-
+|Targets
+|Array
 |
+|Sets what targets the effects should affect. Auto is usually the parent wrapper target.
+|-
+|Events
+|Array
 |
+|List of events that should trigger the effect. internalWrapperTick is triggered when an instant wrapper is triggered, or a duration wrapper ticks. For most instant effects, you just want internalWrapperTick. You can use as many as you want.
 |-
+|Effect Data
+|JSON
 |
+|A JSON object which changes based on the type of effect you're editing. Above the editor is a description of the fields you can use, and what the effect does.
+|-
+|Tags
+|[[Tag]]
 |
+|Tags to apply to the target(s) while affected by the effect.
+|-
+|Conditions
+|[[Condition (Asset)|Conditions]]
 |
+|Conditions required for the effect to trigger, or in the case of modifier effects (such as stat modifiers), to apply to the target(s).
+|-
+|Subconditions
+|[[Condition (Asset)|Conditions]]
 |
+|Conditions are always checked with sender/target being the same as the event that triggered the effect. However, if you use a target other than sender/target, and want to check conditions on the recipient, then you can use a subcondition. Sender of the subcondition is always the parent wrapper's owner.
 |}
-'''export''' '''function''' help(){
-    let out = <nowiki>''</nowiki>;
-    out += '<nowiki><h3>Effect:</h3></nowiki>'+
-        '<nowiki><p></p></nowiki>';
-    out += '<nowiki><h3>Fields</h3></nowiki>';
-    out += '<nowiki><table>';</nowiki>
-    out +=
-        '<nowiki><tr></nowiki>'+
-            '<nowiki><td></nowiki>Label<nowiki></td></nowiki>'+
-            '<nowiki><td></nowiki>A unique label to access the asset by. WARNING: DO NOT CHANGE AFTER SETTING IT, OR RISK BROKEN LINKS!<nowiki></td></nowiki>'+
-        '<nowiki></tr></nowiki>'+
-        '<nowiki><tr></nowiki>'+
-            '<nowiki><td></nowiki>Description<nowiki></td></nowiki>'+
-            '<nowiki><td></nowiki>This is only visible in the mod, a short description of the effect that you can use in search.<nowiki></td></nowiki>'+
-        '<nowiki></tr></nowiki>'+
-        '<nowiki><tr></nowiki>'+
-            '<nowiki><td></nowiki>Type<nowiki></td></nowiki>'+
-            '<nowiki><td></nowiki>Type of effect. A description of the type is shown above the data editor.<nowiki></td></nowiki>'+
-        '<nowiki></tr></nowiki>'+
-        '<nowiki><tr></nowiki>'+
-            '<nowiki><td></nowiki>Don\'t multiply by stacks<nowiki></td></nowiki>'+
-            '<nowiki><td></nowiki>Many effects have their values multiplied by the nr of stacks the effect\'s parent wrapper has. This makes it always multiply by 1.<nowiki></td></nowiki>'+
-        '<nowiki></tr></nowiki>'+
-        '<nowiki><tr></nowiki>'+
-            '<nowiki><td></nowiki>Debug<nowiki></td></nowiki>'+
-            '<nowiki><td></nowiki>Outputs debug info about this effect. Mainly used in development.<nowiki></td></nowiki>'+
-        '<nowiki></tr></nowiki>'+
-        '<nowiki><tr></nowiki>'+
-            '<nowiki><td></nowiki>Targets<nowiki></td></nowiki>'+
-            '<nowiki><td></nowiki>What players should the effect affect. Auto generally targets the parent wrapper\'s victim, and can be used in the vast majority of cases.<nowiki></td></nowiki>'+
-        '<nowiki></tr></nowiki>'+
-        '<nowiki><tr></nowiki>'+
-            '<nowiki><td></nowiki>Events<nowiki></td></nowiki>'+
-            '<nowiki><td></nowiki>Unless the effect uses a passive type, when should the effect trigger? By default it uses internalWrapperTick, which means whenever the parent wrapper ticks. But you can bind it to any event to make things like "trigger when a player has an orgasm".<nowiki></td></nowiki>'+
-        '<nowiki></tr></nowiki>'+
-        '<nowiki><tr></nowiki>'+
-            '<nowiki><td></nowiki>Data<nowiki></td></nowiki>'+
-            '<nowiki><td></nowiki>This is a JSON data editor that lets you edit the effect freely. The text above the editor usually gives an example. Look up the JSON format for more info, it\'s used EVERYWHERE in programming.<nowiki></td></nowiki>'+
-        '<nowiki></tr></nowiki>'+
-        '<nowiki><tr></nowiki>'+
-            '<nowiki><td></nowiki>Tags<nowiki></td></nowiki>'+
-            '<nowiki><td></nowiki>Add tags to the victim(s).<nowiki></td></nowiki>'+
-        '<nowiki></tr></nowiki>'+
-        '<nowiki><tr></nowiki>'+
-            '<nowiki><td></nowiki>Conditions<nowiki></td></nowiki>'+
-            '<nowiki><td></nowiki>Conditions for the effect to trigger or for a passive effect to be considered as enabled.<nowiki></td></nowiki>'+
-        '<nowiki></tr></nowiki>'+
-        '<nowiki><tr></nowiki>'+
-            '<nowiki><td></nowiki>Subconditions<nowiki></td></nowiki>'+
-            '<nowiki><td></nowiki>Conditions are always checked with sender/target being the same as the event that triggered the effect. However, if you use a target other than sender/target, and want to check conditions on the recipient, then you can use a subcondition. Sender of the subcondition is always the wrapper\'s owner.<nowiki></td></nowiki>'+
-        '<nowiki></tr></nowiki>'
-    ;
-    out += '<nowiki></table></nowiki>';
-    out += '<nowiki><h3>A note about Effects</h3></nowiki>'+
-        '<nowiki><p>If the target of the event that triggered the effect is the holder of the wrapper this effect is attached to, then it flips target/sender. So generally you want to flip so ta_ vars target the owner of the effect, whereas se_ will target the target of the effect. I don\'t remember why I made it this way, but I think it was important.</p></nowiki>'+
-        '<nowiki><p>By default, mathVar targets will be the target(s) set in the targets section. If you want to access the parent wrapper\'s sender or target, you have access to pws_ and pwt_. These stand for parentWrapperSender and parentWrapperTarget, and contain data about the effect parent wrapper\'s send and target.</p></nowiki>'
-    ;
+=== Notes ===
-    '''return''' out;
+* If the target of the event that triggered the effect is the holder of the wrapper this effect is attached to, then it flips target/sender. So generally you want to flip so ta_ vars target the owner of the effect, whereas se_ will target the target of the effect. I don't remember why I made it this way, but I think it was important.
+* By default, mathVar targets will be the target(s) set in the targets section. If you want to access the parent wrapper's sender or target, you have access to pws_ and pwt_. These stand for parentWrapperSender and parentWrapperTarget, and contain data about the effect parent wrapper\'s send and target.
-};

Effect (Asset): Difference between revisions

Latest revision as of 16:58, 19 February 2025

Notes

Navigation menu

Search