Skins: |

NWN SCRIPTS

- Jump to comments -

Title

Teleport to WP

Author

Wyldhunt

Submitted / Updated

01-10-2012 / 02-07-2012

Category

Inventory Item

Expansions

Works on all versions

View Code

//This is needed to control the tag based scripting
#include "x2_inc_switches"

//::///////////////////////////////////////////////
//:: Name Jump Item
//:: FileName jumpitem
//:://////////////////////////////////////////////
/*
   This tag based script will jump the character and
   any nearby party members to a waypoint with a tag
   equal to the value of the "JUMPTO" string stored on the item.
*/
//:://////////////////////////////////////////////
//:: Created By: Wyldhunt
//:: Created On: 01/01/2012
//:://////////////////////////////////////////////
void main()
{
   //This is the area of effect around the character to check for party members.
   //Any party members in this area will jump with the character using the item.
   float fAoO = 10.0;

   //The event that just fired
   int nEvent = GetUserDefinedItemEventNumber();

   //Returning this at the end of the script to let the calling script know that the script ended
   int nResult = X2_EXECUTE_SCRIPT_END;

   //If this was not triggered by the OnActivate event, we don't want to do anything
   if (nEvent != X2_ITEM_EVENT_ACTIVATE)
   {
      //Pass the return value back to the calling script
      SetExecutedScriptReturnValue(nResult);
      //Exit the script
      return;
   }

   //The character using the item
   object oPC = GetItemActivator();

   //The item itself
   object oItem = GetItemActivated();

   //A Waypoint which will be used as a target location.
   //Set the Wapoints tag on the item as a string named JUMPTO.
   //Note that strings can be lost on items
   //if they are purchased from a store with unlimited quantities.
   //I can give you a fix for this if you need it
   //so that your items don't lose needed info.
   object oWP = GetWaypointByTag(GetLocalString(oItem, "JUMPTO"));

   //The first member of the characters party
   object oTarget = GetFirstFactionMember(oPC, FALSE);

   //The location of the Waypoint
   location lTarget = GetLocation(oWP);

   //If the Waypoint location is invalid, exit the script
   if (GetAreaFromLocation(lTarget)==OBJECT_INVALID) return;

   //Clear the characters action list
   AssignCommand(oPC, ClearAllActions());

   //Have the character play the animation of reading a scroll
   AssignCommand(oPC, ActionPlayAnimation(ANIMATION_FIREFORGET_READ));

   //Cycle through the characters party
   while (GetIsObjectValid(oTarget))
   {
      //Only jump party members close to the character
      if (GetDistanceBetween(oPC, oTarget) <= fAoO)
      {
         //Define the effect that will trigger at the location the character will leave from
         effect eEffect = EffectVisualEffect(VFX_FNF_PWSTUN);
         //Trigger the effect to spawn at the characters location after 1 second
         //(They need time to read their scroll first)
         DelayCommand(1.0, ApplyEffectAtLocation(DURATION_TYPE_INSTANT, eEffect, GetLocation(oPC)));
         //Clear the party members action list if it is not the item user
         //We don't want to clear their scroll using animation
         if (oTarget != oPC) AssignCommand(oTarget, ClearAllActions());
         //Jump them to the Waypoint location
         AssignCommand(oTarget, ActionJumpToLocation(lTarget));
         //The effect that we will use on the character when they appear at their new location.
         eEffect = EffectVisualEffect(VFX_FNF_DISPEL_DISJUNCTION);
         //Apply the effect on the character after a 1.5 second delay.
         //They should be in their new location by then.
         DelayCommand(1.5, ApplyEffectToObject(DURATION_TYPE_INSTANT, eEffect, oTarget));
      }
      //Grab the next Faction Member
      oTarget=GetNextFactionMember(oPC, FALSE);
   }
   //Pass the return value back to the calling script
   SetExecutedScriptReturnValue(nResult);
}

Select All Text | View Code in separate window

Format

Module and Code

Type

Type - Transitions

Includes

None

Forums

Link

Description

This is a simple example of a tag based teleport scroll which teleports you to the location of a waypoint.
The tag of the waypoint is stored on the item as a string variable.
The erf includes an item, waypoint, and one script.
The mod shows them all working.

Usually, variables are all removed from any store-bought items marked as infinite.
The example mod already has this fix implemented as well as merchants selling infinite amounts of the scrolls to show that it works. I am uploading the variable fix as a separate entry.

This was inspired by one of Nightshades scripts, here:
Link

UPDATE:
The scroll will now jump the character using the item and party members standing nearby, instead of all party members in the area.

The item var fix in the example mod has been updated to v. 2.0, which ensures that altered or previously owned items will not be reset to palette defaults by this script.

Files

Name	Type	Size	Downloads
Teleportiness.rarTeleportiness.rar Submitted: 01-10-2012 / Last Updated: 01-10-2012	rar	19.08Kb	46
Contains both erfs(Teleport & Store Var Fix) and a sample mod.
JumpScript.rarJumpScript.rar Submitted: 01-10-2012 / Last Updated: 02-07-2012	rar	20.8Kb	27
Updated V1.1 version, with updates noted above. No longer contains the Store Var Fix erf.

SCORE OUT OF 10

10
1 votes
View Stats
Cast Your Vote!

PORTFOLIO

Add this entry to your portfolio so you can track it

Manage your existing portfolios or create a new one.

SCREENS

No Images

You Must Be Logged In to Participate.

Comments (7):

Posted by The Nightshade at 2012-05-24 20:15:30 Voted 10.00 on 05/24/12

Forgot to vote.
_________________________
I Sir am a Shrubber, I make and arrange Shrubberies.

Posted by The Nightshade at 2012-05-24 20:15:10 Voted 10.00 on 05/24/12

Brilliant mate, I rather like the expansion on my rather simple idea. XD
_________________________
I Sir am a Shrubber, I make and arrange Shrubberies.

Posted by wyldhunt at 2012-02-08 14:36:11

@The_Krit
If anything, the new version has more sanity checks than it really needs. Since I expanded it, I'm uploading it as its own entry. In the meantime, the example mod contains the new system.
It should be entirely safe to use in any PW using nearly any system.
If you do see any bugs, let me know. It hasn't been extensively tested yet.

Posted by The_Krit at 2012-01-28 23:10:38

Sorry, I meant to mention this earlier, but I got sidetracked. With regards to:
"If you buy an item in one PW, and then portal to a new PW and sell items from your old home, this system will not try to destroy any items that do not exist in the current PW's palette."
This is false. The trick you are trying to use (checking for a ResRef equal to "") has not worked in ages. However, if you do change it so that the fix script is only run on infinite items, this will not be a problem.

Posted by wyldhunt at 2012-01-14 08:01:13

When I get time, I'll see about updating it to only run the fix on infinite items purchased to ensure that it can never break anything. I'll also use The_Krits faster store check.

Posted by wyldhunt at 2012-01-14 07:34:21

@The_Krit
I use the tag trick sometimes also.
I've never had an issue using the store fix with any items. It is possible that it could sometimes mess with a crafting system, but it would also be fairly easy to have it check for a crafting var on the item and not try to 'fix' it if it has a crafting variable.
The reason I tend to use variable based item scripts is because I can change the way the item acts on the fly from in game very easy. If someone wanted to have these items change their destination point after a certain point in a mod, they could just update the variable on the item.
It may also be worth noting that this system is designed with connected worlds in mind. If you buy an item in one PW, and then portal to a new PW and sell items from your old home, this system will not try to destroy any items that do not exist in the current PW's palette.

Posted by The_Krit at 2012-01-11 21:34:25

If you are willing to limit the destination waypoint's tag to 16 characters, you could avoid the problem with local variables and stores by encoding both the script name and the destination tag in the item's tag. (First expand your script name to 16 characters. Then you could make the first 16 characters of the item's tag be the script name and the up to 16 characters after that be the tag of the destination.) Standard tag-based scripting will ignore everything after the first 16 characters of the item's tag, and tags can be up to 32 characters long, so this is one trick for getting extra information to a tag-based script.

But if you want to keep the extra scripts for handling items bought from stores (which look like they could mess up buying items that have been crafted before being sold to a store, by the way), you probably should simplify the test for having been bought from a store. Instead of seeing if the item was acquired from the nearest store, see if it was acquired from a store:

if ( GetObjectType(oAcquiredFrom) == OBJECT_TYPE_STORE )

There probably are not many cases when you would see a difference between this and what you have, but checking the object type is more reliable (and less work for the computer) when, for example, there are multiple stores in an area.

You must be Logged In to post comments in this section.