Variable Based Events - Revision history

Kalen: Updated notes on EVENT_ATTACKROLL event

2025-08-31T05:55:56Z

Updated notes on EVENT_ATTACKROLL event

← Older revision		Revision as of 05:55, 31 August 2025
Line 121:		Line 121:
	// So in case of a critical hit, all three events will fire		// So in case of a critical hit, all three events will fire
	EVENT_ATTACKROLL		EVENT_ATTACKROLL
	object ~~oSelf~~ = OBJECT_SELF;		// If this fires for a weapon, then OBJECT_SELF is the weapon
	object oTarget = GetAttackTarget(~~oSelf~~);		object oItem = OBJECT_SELF;
	int iCheckAtkType = GetLastAttackRollResult(~~oSelf~~);		// If this fires for a creature (unarmed attacks), then OBJECT_SELF is the creature
	int nCritRange = GetCriticalHitMultiplier(~~oSelf~~, FALSE);		object oCreature = OBJECT_SELF;
			object oTarget = GetAttackTarget(oCreature);
			int iCheckAtkType = GetLastAttackRollResult(oCreature);
			int nCritRange = GetCriticalHitMultiplier(oItem, FALSE);

	EVENT_CREATURE_ONHIT		EVENT_CREATURE_ONHIT
Line 139:		Line 142:

	EVENT_ITEM_ONHIT		EVENT_ITEM_ONHIT
	object ~~oSelf~~ = OBJECT_SELF;		object oItem = OBJECT_SELF;
	object oTarget = GetAttackTarget(~~oSelf~~);		object oCreature = GetItemPossessor(oItem);
	int iCheckAtkType = GetLastAttackRollResult(~~oSelf~~);		object oTarget = GetAttackTarget(oCreature);
	int nCritRange = GetCriticalHitMultiplier(~~oSelf~~, FALSE);		int iCheckAtkType = GetLastAttackRollResult(oCreature);
			int nCritRange = GetCriticalHitMultiplier(oItem, FALSE);

	EVERT_ITEM_ONCRIT		EVERT_ITEM_ONCRIT
	object ~~oSelf~~ = OBJECT_SELF;		object oItem = OBJECT_SELF;
	object oTarget = GetAttackTarget(~~oSelf~~);		object oCreature = GetItemPossessor(oItem);
	int iCheckAtkType = GetLastAttackRollResult(~~oSelf~~);		object oTarget = GetAttackTarget(oCreature);
	int nCritRange = GetCriticalHitMultiplier(~~oSelf~~, FALSE);		int iCheckAtkType = GetLastAttackRollResult(oCreature);
			int nCritRange = GetCriticalHitMultiplier(oItem, FALSE);
	</syntaxhighlight>		</syntaxhighlight>
	[[Category:Builders Tools]]		[[Category:Builders Tools]]
	[[Category:Sinfar Supporters]]		[[Category:Sinfar Supporters]]

Kalen: Updated to be more specific about creatures versus items for on hit and on crit

2025-08-30T22:13:43Z

Updated to be more specific about creatures versus items for on hit and on crit

← Older revision		Revision as of 22:13, 30 August 2025
Line 126:		Line 126:
	int nCritRange = GetCriticalHitMultiplier(oSelf, FALSE);		int nCritRange = GetCriticalHitMultiplier(oSelf, FALSE);

	~~EVENT_ONHIT~~		EVENT_CREATURE_ONHIT
	object oSelf = OBJECT_SELF;		object oSelf = OBJECT_SELF;
	object oTarget = GetAttackTarget(oSelf);		object oTarget = GetAttackTarget(oSelf);
Line 132:		Line 132:
	int nCritRange = GetCriticalHitMultiplier(oSelf, FALSE);		int nCritRange = GetCriticalHitMultiplier(oSelf, FALSE);

	~~EVERT_ONCRIT~~		EVERT_CREATURE_ONCRIT
			object oSelf = OBJECT_SELF;
			object oTarget = GetAttackTarget(oSelf);
			int iCheckAtkType = GetLastAttackRollResult(oSelf);
			int nCritRange = GetCriticalHitMultiplier(oSelf, FALSE);

			EVENT_ITEM_ONHIT
			object oSelf = OBJECT_SELF;
			object oTarget = GetAttackTarget(oSelf);
			int iCheckAtkType = GetLastAttackRollResult(oSelf);
			int nCritRange = GetCriticalHitMultiplier(oSelf, FALSE);

			EVERT_ITEM_ONCRIT
	object oSelf = OBJECT_SELF;		object oSelf = OBJECT_SELF;
	object oTarget = GetAttackTarget(oSelf);		object oTarget = GetAttackTarget(oSelf);

Kalen: Added EVENT_ONHIT and EVENT_ONCRIT

2025-08-30T22:04:22Z

Added EVENT_ONHIT and EVENT_ONCRIT

@@ Line 118: / Line 118: @@
 todo
 EVENT_ATTACKROLL
-todo
+object oSelf = OBJECT_SELF;
 </syntaxhighlight>
 [[Category:Builders Tools]]
 [[Category:Sinfar Supporters]]

Fiery Imp: more events

2023-12-14T15:23:08Z

more events

← Older revision		Revision as of 15:23, 14 December 2023
Line 110:		Line 110:
	object oItem = GetPCItemLastEquipped();		object oItem = GetPCItemLastEquipped();
	object oPC = GetPCItemLastEquippedBy();		object oPC = GetPCItemLastEquippedBy();

	EVENT_UNEQUIP		EVENT_UNEQUIP
	object oItem = GetPCItemLastUnequipped();		object oItem = GetPCItemLastUnequipped();
	object oPC = GetPCItemLastUnequippedBy();		object oPC = GetPCItemLastUnequippedBy();

			EVENT_ACQUIRE
			todo

			EVENT_ATTACKROLL
			todo
	</syntaxhighlight>		</syntaxhighlight>
	[[Category:Builders Tools]]		[[Category:Builders Tools]]
	[[Category:Sinfar Supporters]]		[[Category:Sinfar Supporters]]

Fiery Imp: Adde equip and unequip event

2023-12-14T15:19:55Z

Adde equip and unequip event

← Older revision		Revision as of 15:19, 14 December 2023
Line 106:		Line 106:
	self: attacker		self: attacker
	p0: target object		p0: target object

			EVENT_EQUIP
			object oItem = GetPCItemLastEquipped();
			object oPC = GetPCItemLastEquippedBy();
			EVENT_UNEQUIP
			object oItem = GetPCItemLastUnequipped();
			object oPC = GetPCItemLastUnequippedBy();
	</syntaxhighlight>		</syntaxhighlight>
	[[Category:Builders Tools]]		[[Category:Builders Tools]]
	[[Category:Sinfar Supporters]]		[[Category:Sinfar Supporters]]

ItsABadger: Added category

2023-12-11T17:32:23Z

Added category

← Older revision		Revision as of 17:32, 11 December 2023
Line 108:		Line 108:
	</syntaxhighlight>		</syntaxhighlight>
	[[Category:Builders Tools]]		[[Category:Builders Tools]]
			[[Category:Sinfar Supporters]]

Fiery Imp: Added list of events

2023-12-11T15:20:05Z

Added list of events

@@ Line 33: / Line 33: @@
 </syntaxhighlight>
 They will return TRUE if the <code>BypassVariableEvent()</code> was calling during the execution of one of the registered scripts.
 [[Category:Builders Tools]]

ItsABadger: Added category

2023-11-30T21:10:58Z

Added category

← Older revision		Revision as of 21:10, 30 November 2023
Line 33:		Line 33:
	</syntaxhighlight>		</syntaxhighlight>
	They will return TRUE if the <code>BypassVariableEvent()</code> was calling during the execution of one of the registered scripts.		They will return TRUE if the <code>BypassVariableEvent()</code> was calling during the execution of one of the registered scripts.
			[[Category:Builders Tools]]

Elemuffin: /* Registering / Unregistering a variable Event */

2023-11-29T22:52:15Z

Registering / Unregistering a variable Event

← Older revision		Revision as of 22:52, 29 November 2023
Line 9:		Line 9:
	You can also register multiple script to the same event:		You can also register multiple script to the same event:
	[[File:Variable based 20190311-001248.png]]		[[File:Variable based 20190311-001248.png]]

	With the variables above, all scripts (myerf_useitem, myerf_useitem2, myerf_useitem3 and myerf_useitem4) will run when the item is used.		With the variables above, all scripts (myerf_useitem, myerf_useitem2, myerf_useitem3 and myerf_useitem4) will run when the item is used.

Elemuffin: /* Registering / Unregistering a variable Event */

2023-11-29T22:45:28Z

Registering / Unregistering a variable Event

← Older revision		Revision as of 22:45, 29 November 2023
Line 4:		Line 4:
	As you can guess, it is using local variables, for example:		As you can guess, it is using local variables, for example:
	[[File:Variable based 20190311-000047.png]]		[[File:Variable based 20190311-000047.png]]

	Will cause the myerf_useitem script to be called when the item on which the variable is set is used.		Will cause the myerf_useitem script to be called when the item on which the variable is set is used.