Effect Tutorial - Revision history

Panda at 21:50, 29 July 2023

2023-07-29T21:50:30Z

← Older revision		Revision as of 14:50, 29 July 2023
Line 363:		Line 363:
	);		);
	</pre>		</pre>
			[[Category:Tutorials]]

Panda: /* TARG_* target constants */

2023-07-29T00:25:58Z

TARG_* target constants

@@ Line 266: / Line 266: @@
 |0x40
 |Run as an area effect. Max targets will not work with this.
 |}

Panda: /* Events */

2023-07-29T00:24:04Z

Events

@@ Line 231: / Line 231: @@
 			// Cooldown (5 seconds)
+  ]
 == Tags ==

Panda: /* The structure of an effect */

2023-07-29T00:19:45Z

The structure of an effect

@@ Line 103: / Line 103: @@
 	...
+]
-</pre>
+</pre>Wrapper flags
 == Package ==

Panda: /* Examples */

2023-07-29T00:14:43Z

Examples

@@ Line 227: / Line 227: @@
 , // Minimum conditions needed
 , // Max stacks: Not used
 // Ticking: Not used
+         )

Panda: /* Examples */

2023-07-29T00:10:01Z

Examples

← Older revision		Revision as of 17:10, 28 July 2023
Line 203:		Line 203:

	Wrapper that deals 10 damage to the recipient and triggers the take hit animation and sound:		Wrapper that deals 10 damage to the recipient and triggers the take hit animation and sound:

			<pre>
			string wrapper = FX_buildWrapper(
			WF_DETRIMENTAL, // Flags
			0, // Min packages (ANY)
			0, // Max package (ALL)
			[
			0, // Stacks. Anything below 1 will become 1
			FX_buildPackage(
			0, // No duration. Fire and forget.
			PF_DETRIMENTAL, // Flags
			"", // Name of package. Not usually needed when package is instant.
			[ // FX arrays
			FX_buildFX(fx$DAMAGE_DURABILITY, [10]), // Do 10 HP damage
			FX_buildFX(fx$HITFX, [ // Trigger the take hit animation and sound
			fxhfColor$phys, // Color the thong briefly to indicate damage
			fxhfFlag$PAIN_HEAVY // Flags for RP addons
			])
			],
			[], // Conditions: None used
			[], // Events: None used
			[], // Tags: none used
			0, // Minimum conditions needed
			0, // Max stacks: Not used
			0 // Ticking: Not used
			)
			]
			);

			// Method to send a wrapper to a player or NPC
			FX$send(
			llGetOwner(), // Target of wrapper
			llGetKey(), // Sender of wrapper
			wrapper, // Wrapper
			TEAM_NPC // Team of sender
			);
			</pre>

Panda: /* Events */

2023-07-29T00:09:28Z

Events

← Older revision		Revision as of 17:09, 28 July 2023
Line 179:		Line 179:

	== Events ==		== Events ==
	The event system is advanced. It allows you to apply wrappers when something happens based on XOBJ events that are raised. We can explain it by using an example of an event array. This event will deal 3 damage to your target when you finish casing spell 4 but only if spell 4 is detrimental.		The event system is advanced. It allows you to apply wrappers when something happens based on XOBJ events that are raised. We can explain it by using an example of an event array. This event will deal 3 damage to your target when you finish casing spell 4 but only if spell 4 is detrimental. Note: In LSL you need to escape the nested JSON array with llList2Json.
	[		[
	SpellManEvt$complete, // Event that we are listening for		SpellManEvt$complete, // Event that we are listening for
Line 198:		Line 198:
	== Tags ==		== Tags ==
	Tags are an array of tag constants (see _lib_fx.lsl). They only contain metadata. The only important one is the fx$TAG_ACTIVE_MITIGATION for tanks.		Tags are an array of tag constants (see _lib_fx.lsl). They only contain metadata. The only important one is the fx$TAG_ACTIVE_MITIGATION for tanks.

			== Examples ==
			It is recommended that you use the FX_build* functions to create your wrappers while you are new to this. Here are some examples:

			Wrapper that deals 10 damage to the recipient and triggers the take hit animation and sound:

Panda: /* Events */

2023-07-28T23:59:27Z

Events

← Older revision		Revision as of 16:59, 28 July 2023
Line 179:		Line 179:

	== Events ==		== Events ==
	The event system is advanced. It allows you to apply wrappers when something happens based on XOBJ events that are raised. We can explain it by using an example of an event array:		The event system is advanced. It allows you to apply wrappers when something happens based on XOBJ events that are raised. We can explain it by using an example of an event array. This event will deal 3 damage to your target when you finish casing spell 4 but only if spell 4 is detrimental.
	[ SpellManEvt$complete, // Event that we are listening for "got SpellMan", // Script that raised that event "<1>", // Target to apply the wrapper to. <1> = event value at index 1 (target of spell) 0, // Max target (0 = ALL) [0,0,0,0,[0,1,0,[[1,10]]]], // Wrapper that deals 10 damage directly [ 4, // First value of event (spell index) must be 4 (spell 4). Note that spell 5 is index 0. "", // Ignore the second event value by using "" 1 // Third value of event (deterimental) must be 1. ], 1.0, // Proc chance. 1 = 100% 0, // No flags 0, // Range (0 = unlimited) 5 // Cooldown (5 seconds) ]		[
			SpellManEvt$complete, // Event that we are listening for
			"got SpellMan", // Script that raised that event
			"<1>", // Target to apply the wrapper to. <1> = event value at index 1 (target of spell)
			0, // Max target (0 = ALL) [0,0,0,0,[0,1,0,[[1,10]]]], // Wrapper that deals 10 damage directly
			[
			4, // First value of event (spell index) must be 4 (spell 4). Note that spell 5 is index 0.
			"", // Ignore the second event value by using ""
			1 // Third value of event (deterimental) must be 1.
			],
			1.0, // Proc chance. 1 = 100%
			0, // No flags
			0, // Range (0 = unlimited)
			5 // Cooldown (5 seconds)
			]

	== Tags ==		== Tags ==
	Tags are an array of tag constants (see _lib_fx.lsl). They only contain metadata. The only important one is the fx$TAG_ACTIVE_MITIGATION for tanks.		Tags are an array of tag constants (see _lib_fx.lsl). They only contain metadata. The only important one is the fx$TAG_ACTIVE_MITIGATION for tanks.

Panda: /* Package */

2023-07-28T23:57:21Z

Package

@@ Line 163: / Line 163: @@
 == Effects ==
 == Conditions ==
 == Events ==

Panda at 23:41, 28 July 2023

2023-07-28T23:41:41Z

@@ Line 20: / Line 20: @@
 The effect data is a JSON array with the following spect:
-* (array) wrapper. An all or nothing container of multiple effect packages and stacks of packages.
+* (array) '''wrapper'''. An all or nothing container of multiple effect packages and stacks of packages.
 ** (int) wrapper_flags - WF_* flags. See below.
 ** (int) min_packages - Minimum packages to apply (all or nothing).
 ** (int) max_packages - Max packages to apply (applies the N first viable packages). Use 0 for ALL.
-** (...strided) (int) package_stacks, (array) package_data - After max_packages the remaining elements are two-strided with nr stacks and the package to add said stacks of. Anything below 1 becomes 1.
+** (...strided) (int) package_stacks, (array) '''package''' - After max_packages the remaining elements are two-strided with nr stacks and the package to add said stacks of. Anything below 1 becomes 1.
 *** (float) Package duration - Duration to apply the package
 *** (int) Package flags - PF_* flags. See below.
 *** (str) Package name - Name of the package (unique). If the effect has a 0 duration you can use "" or 0 because it is only used in duration effects.
-*** (array) Effects - An array of FX arrays
+*** (array) '''Effects''' - An array of FX arrays
 **** (int) Effect type - An effect integer from _lib_fx.lsl
 **** ...effect data - ...followed by data based on that effect.
-*** (array) Conditions - An array of condition arrays
+*** (array) '''Conditions''' - An array of condition arrays
 **** (int) Type of condition - Condition identifier from _lib_fx.lsl
 **** ...condition data - Data based on the condition identifier.
-*** (array) Events - An array of effect arrays.
+*** (array) '''Events''' - An array of effect arrays.
 **** (int) event_type - An event type. You can use any relevant event from any of the header files in got/classes.lsl
 **** (str) event_script - The name of the script that raised the event. If the event was raised by got FX.lsl then use "" instead.
@@ Line 50: / Line 50: @@
 *** (float) tick - When set to anything above 0 it will trigger all the effects this often. In whole seconds.
 Here is a JSON encoded version of the above:
 <pre>
+[
@@ Line 106: / Line 104: @@
+]
 </pre>