Initial Commit

Initial Commit

_module/nss/fishrod.nss

@@ -0,0 +1,202 @@
+// Tag-based script template.
+// This is intended to be a starting point for writing an item's tag-based script.
+// Copy this to a script whose name is the tag of the item in question.
+// Edit the event handlers (scroll down to find them) as desired.
+
+
+#include "x2_inc_switches"
+#include "x4_inc_functions"
+#include "prc_inc_spells"
+
+// -----------------------------------------------------------------------------
+// This first part is standard and generic.
+// There should be no need to edit it; just skip down to the next part.
+// -----------------------------------------------------------------------------
+
+
+// The individual event handlers.
+
+void OnAcquire(object oEventItem, object oAcquiredBy, object oTakenFrom, int nStackSize);
+void OnActivate(object oEventItem, object oActTarget, location lActTarget, object oActivator);
+void OnEquip(object oEventItem, object oEquippedBy);
+void OnHit(object oEventItem, object oHitTarget, object oCaster);
+int  OnSpellCast(object oEventItem, int nSpell, object oCaster);
+void OnUnacquire(object oEventItem, object oLostBy);
+void OnUnequip(object oEventItem, object oUnequippedBy);
+
+
+// The main function.
+void main()
+{
+    int nEvent = GetUserDefinedItemEventNumber();
+
+    // Spells might continue to their spell scripts. All other events are
+    // completely handled by this script.
+    if ( nEvent != X2_ITEM_EVENT_SPELLCAST_AT )
+        SetExecutedScriptReturnValue();
+
+    // Determine which event triggered this script's execution.
+    switch ( nEvent )
+    {
+        // Item was acquired.
+        case X2_ITEM_EVENT_ACQUIRE:
+                OnAcquire(GetModuleItemAcquired(), GetModuleItemAcquiredBy(),
+                          GetModuleItemAcquiredFrom(), GetModuleItemAcquiredStackSize());
+                break;
+
+        // Item was activated ("activate item" or "unique power").
+        case X2_ITEM_EVENT_ACTIVATE:
+                OnActivate(GetItemActivated(), GetItemActivatedTarget(),
+                           GetItemActivatedTargetLocation(), GetItemActivator());
+                break;
+
+        // Item was equipped by a PC.
+        case X2_ITEM_EVENT_EQUIP:
+                OnEquip(GetPCItemLastEquipped(), GetPCItemLastEquippedBy());
+                break;
+
+        // Item is a weapon that just hit a target, or it is the armor of someone
+        // who was just hit.
+        case X2_ITEM_EVENT_ONHITCAST:
+                OnHit(PRCGetSpellCastItem(), PRCGetSpellTargetObject(), OBJECT_SELF);
+                break;
+
+        // A PC (or certain NPCs) cast a spell at the item.
+        case X2_ITEM_EVENT_SPELLCAST_AT:
+                if ( OnSpellCast(PRCGetSpellTargetObject(), PRCGetSpellId(), OBJECT_SELF) )
+                    SetExecutedScriptReturnValue();
+                break;
+
+        // Item was unacquired.
+        case X2_ITEM_EVENT_UNACQUIRE:
+                OnUnacquire(GetModuleItemLost(), GetModuleItemLostBy());
+                break;
+
+        // Item was unequipped by a PC.
+        case X2_ITEM_EVENT_UNEQUIP:
+                OnUnequip(GetPCItemLastUnequipped(), GetPCItemLastUnequippedBy());
+                break;
+    }
+}
+
+
+// -----------------------------------------------------------------------------
+// Event handlers
+// -----------------------------------------------------------------------------
+// This second part is where you add your desired functionality. Each event
+// has its own function with relavant information passed as parameters.
+// -----------------------------------------------------------------------------
+
+
+// -----------------------------------------------------------------------------
+// oEventItem was acquired (by a PC or an NPC).
+// Run by the module.
+void OnAcquire(object oEventItem, object oAcquiredBy, object oTakenFrom, int nStackSize)
+{
+    // Default: do nothing.
+}
+
+
+// -----------------------------------------------------------------------------
+// oEventItem was activated ("activate item" or "unique power").
+// Run by the module.
+void OnActivate(object oEventItem, object oActTarget, location lActTarget, object oActivator)
+{
+    object oPC = oActivator;
+    float fRadius = 5.0;
+    location lLoc = GetLocation(oPC);
+    object oFishingSpot = OBJECT_INVALID;
+    oFishingSpot = GetFirstObjectInShape(SHAPE_SPHERE, fRadius, lLoc, FALSE, OBJECT_TYPE_WAYPOINT);
+    while (GetIsObjectValid(oFishingSpot))
+    {
+        if (GetTag(oFishingSpot) == "FISHING_SPOT") break;
+        oFishingSpot = GetNextObjectInShape(SHAPE_SPHERE, fRadius, lLoc, FALSE, OBJECT_TYPE_WAYPOINT);
+    }
+
+    //No fishing if there's no water nearby (i.e. the waypoint)
+    if (oFishingSpot == OBJECT_INVALID)
+    {
+        FloatingTextStringOnCreature("You need to be closer to a valid body of water to fish.", oPC, FALSE);
+        return;
+    }
+
+    //No fishing if our fishing skill is too low to use this rod.
+    string sResRef = GetResRef(oEventItem);
+    int nSkill = 0;
+    if (sResRef == "fishrod_black") nSkill = 700;
+    if (sResRef == "fishrod_diamond") nSkill = 300;
+    if (sResRef == "fishrod_glass") nSkill = 130;
+    if (sResRef == "fishrod_steel") nSkill = 50;
+    int nPCSkill = GetCampaignInt(CharacterDB(oPC), "FISHING_SKILL");
+    if (nPCSkill < nSkill)
+    {
+        FloatingTextStringOnCreature("You are not skilled in fishing enough to use this rod.", oPC, FALSE);
+        return;
+    }
+
+    //If we got this far, let's make the PC face the fishing spot, store it on the PC, immobilize the PC and start the fishing dialog
+    SetLocalObject(oPC, "oFishingSpot", oFishingSpot);
+    AssignCommand(oPC, ClearAllActions());
+    vector vFace = GetPosition(oFishingSpot);
+    AssignCommand(oPC, SetFacingPoint(vFace));
+    AssignCommand(oPC, ActionStartConversation(OBJECT_SELF, "fishing_convo", TRUE, FALSE));
+}
+
+
+// -----------------------------------------------------------------------------
+// oEventItem was equipped by a PC.
+// Run by the module.
+void OnEquip(object oEventItem, object oEquippedBy)
+{
+    // Default: do nothing.
+}
+
+
+// -----------------------------------------------------------------------------
+// oEventItem is a weapon that just hit a target, or it is the armor of someone who
+// was just hit by someone else's weapon.
+// Run by the caster.
+void OnHit(object oEventItem, object oHitTarget, object oCaster)
+{
+    // Default: do nothing.
+}
+
+
+// -----------------------------------------------------------------------------
+// Someone cast a spell at oEventItem.
+// This usually only fires if a PC cast the spell, but it also fires for
+// DM-possessed NPCs and NPCs in an area with the "X2_L_WILD_MAGIC" local integer set.
+//
+// Return TRUE to prevent the spell script from firing.
+// Return FALSE to proceed normally.
+//
+// This fires after the UMD check, module spellhook, item creation, and
+// sequencer handlers decide they do not want to handle/interrupt this spell.
+// This fires before the check to see if this is a spell that normally can
+// target items (and before the spell script itself runs).
+//
+// Run by the caster.
+int OnSpellCast(object oEventItem, int nSpell, object oCaster)
+{
+    // Default: just proceed normally.
+    return FALSE;
+}
+
+
+// -----------------------------------------------------------------------------
+// oEventItem was unacquired/lost (by a PC or NPC).
+// Run by the module.
+void OnUnacquire(object oEventItem, object oLostBy)
+{
+    // Default: do nothing.
+}
+
+
+// -----------------------------------------------------------------------------
+// oEventItem was unequipped by a PC.
+// Run by the module.
+void OnUnequip(object oEventItem, object oUnequippedBy)
+{
+    // Default: do nothing.
+}
+