Skins: |

NWN SCRIPTS

- Jump to comments -

Title

BOG Fully Flexible Teleport System

Author

Baron of Gateford

Submitted / Updated

12-06-2004 / 11-22-2006

Category

Travel

Expansions

NWN-1.64

View Code

/////////////////////////////////////////////////
//  BOG Fully Flexible Teleport system 1.0
/////////////////////////////////////////////////
//  Author: Baron of Gateford
//  Date: 06-12-2004
//  This is based on a script by Amurayi
//  The original Amurayi script allowed for a lot of flexibility but meant you needed multiple versions of it.
//
//  You now only need this ONE script to handle teleports.
//  All paramters are set via local variables set on the object that is going to teleport the PC.
//
//  Via local variables you can choose whether to;
//  teleport player out of conversation, trigger or placeable
//  teleport player with or without companions (if teleporting within same area)
//  teleport player alone or the whole party (players)
//  Make the player say a one liner when being teleported.
//  Send a message to the Player to let them know what happened.
//  Choose from 5 visual effects to play when the player is teleported.
//
//  Installation Instructions
//  -------------------------
//  Cut and paste this script in to your script editor and save the script to something sensible.
//  e.g. Teleport_script, or BOG_teleport, or whatever takes your fancy.
//
//  Place this script on the one of the following script slots (depending on who/what teleports the PC)
//  Onused - for placeables that when used teleport the PC
//  OnEnter - for triggers that teleport the PC when the PC enters them.
//  Action Taken(of conversation) - when the PC is teleported via a conversation node (called from either NPC or Placeable).
//
//  Now set the variables on the object performing the teleport (NPC/Trigger/placeable)
//
//  Variable instructions.
//  ----------------------
//  The following lists the variables that need to be set-up in order for this teleport system to work.
//  They need to be set on either the placeable,trigger, or NPC that will teleport the PC.
//
//      To set variables on an object;
//      Open up the toolset, right mouse click the object.
//      select 'variables' from the pop up menu.
//
//  TeleType (int)
//     0 = objects (onused)
//     1 = trigger (onenter)
//     2 = coversation
//  This variable is MANDATORY, and lets the script know what kind of object is being used.
//  e.g. if this teleport script is placed on the actions taken slot of a conversation, then set this variable to 2.
//       if this teleport script is placed on the OnEnter slot of a trigger, then set this variable to 1.
//  It will default to onused if it is not set.
//
//  TeleDest (string)
//     Tag of waypoint to be teleported to.
//  This is MANDATORY. The value of this string must be the TAG of the waypoint to be teleported to.
//
//  TeleParty (int)
//     0 = self
//     1 = whole party
//  Set this variable to 1 to teleport the PC and the entire party.
//  It will default to just the PC if it is not set.
//
//  TeleHench (int)
//     0 = self
//     1 = pc and henchman/asociates
//  Set this variable to 1 if you are teleporting within the same area and want all henchmen/associates to be teleported too.
//  It will default to just the PC if it is not set.
//
//  TeleSay (string)
//     Speech pc says when leaving (to let other players know what is happening)
//  Enter the text in this string variable to the text you want the PC to say when he gets teleported.
//  e.g. "I'm going to the Wizards lab", or "I am going down this hole" etc.
//  The PC will not say anything if not set.
//
//  TeleMessage (string)
//     Message sent to pc to describe what happened
//  Enter the text in this string variable to the message you want to send to the PC to describe what happened
//  e.g. "You arrive at the wizards lab", or "You climb down the hole" etc.
//
//  TeleVisual (int)
//     0 = No visual effect
//     1 = Summon monster 1 - Large white explosion that turns to smoke.
//     2 = Summon monster 2 - Purple glyph with white lines moving around purple spots.
//     3 = Summon monster 3 - Blue glyph with orange light on floor and white rising light.
//     4 = Implosion        - Yellow/black "black hole" type look.
//     5 = Summon undead    - Small white cloud.
//  Set this variable to the values listed above for the corresponding visual effect to be used when the PC is teleported.
//  If the variable is set to a value greater than 5 then the VFX used is Summon Monster 1.
//  The VFX will only be used on actual player characters (not henchmen/familiars etc.)
//
///////////////////////////////////////////////

void JumpAssociate(object i_oPC, int i_type, object i_oWP)
{
    object oAssociate = GetAssociate(i_type, i_oPC);
    if(GetIsObjectValid(oAssociate))
        AssignCommand(oAssociate, JumpToObject(i_oWP));
}

void main()
{
    object oPC;
    //Get the type of object used for the teleport function
    int iTeletype = GetLocalInt(OBJECT_SELF,"TeleType");
    if (iTeletype == 2)
       {
        oPC = GetPCSpeaker();     // for conversations
       }
    else if (iTeletype == 1)
       {
        oPC = GetEnteringObject();  // for triggers
       }
    else
       {
        oPC = GetLastUsedBy();    // for items/objects (default if Teletype int not set)
       }
    // set TeleParty to 1 if you want to teleport the whole party of the player, wherever every member is:
    int iTeleportWholeParty = GetLocalInt(OBJECT_SELF,"TeleParty");
    // set TeleHench to 1 if you want the Associates of the player to be teleported as well, otherwise to 0:
    int iTeleportAssociateToo = GetLocalInt(OBJECT_SELF,"TeleHench");
    //Get the destination waypoint tag from the local variables set
    string sTeleDest = GetLocalString(OBJECT_SELF,"TeleDest");
    object oDWP = GetWaypointByTag(sTeleDest);
    // Make the player say something on his departure (so others will now that he teleported, not crashed):
    string sGoodbye = GetLocalString(OBJECT_SELF,"TeleSay");
    // Enter the message being sent to the player when teleport starts:
    string sTeleportmessage = GetLocalString(OBJECT_SELF,"TeleMessage");
    // The visual effect to be played when teleport happens
    effect eVis;
    int iTeleVisual = GetLocalInt(OBJECT_SELF,"TeleVisual");
    if (iTeleVisual == 1)
        {
         eVis = EffectVisualEffect(VFX_FNF_SUMMON_MONSTER_1);
        }
    if (iTeleVisual == 2)
        {
         eVis = EffectVisualEffect(VFX_FNF_SUMMON_MONSTER_2);
        }
    if (iTeleVisual == 3)
        {
         eVis = EffectVisualEffect(VFX_FNF_SUMMON_MONSTER_3);
        }
    if (iTeleVisual == 4)
        {
         eVis = EffectVisualEffect(VFX_FNF_IMPLOSION);
        }
    if (iTeleVisual == 5)
        {
         eVis = EffectVisualEffect(VFX_FNF_SUMMON_UNDEAD);
        }
    if (iTeleVisual > 5)
        {
         eVis = EffectVisualEffect(VFX_FNF_SUMMON_MONSTER_1);
        }
    // Don't start Teleport at all if activator isn't a player or DM
    if(!GetIsPC(oPC))
        return;

    if (iTeleportWholeParty == 1)
        {
        object oFM = GetFirstFactionMember(oPC);
        // Step through the party members.
        while(GetIsObjectValid(oFM))
            {
            //only use the visual effect if the local variable has been set
            if (iTeleVisual > 0)
                {
                 ApplyEffectToObject(DURATION_TYPE_INSTANT, eVis, oFM);
                }
            //only let the PC say something if the local variable has been set
            if (sGoodbye != "")
                {
                 AssignCommand(oFM, ActionSpeakString(sGoodbye));
                }
            //only send a message to the PC if the local variable has been set
            if (sTeleportmessage != "")
                {
                 SendMessageToPC(oFM, sTeleportmessage);
                }
            AssignCommand(oFM,  DelayCommand(2.0, JumpToObject(oDWP)));
            if (iTeleportAssociateToo == 1)
                {
                // now send the players companions over as well:
                DelayCommand(2.0, JumpAssociate(oFM, ASSOCIATE_TYPE_ANIMALCOMPANION, oDWP));
                DelayCommand(2.0, JumpAssociate(oFM, ASSOCIATE_TYPE_DOMINATED, oDWP));
                DelayCommand(2.0, JumpAssociate(oFM, ASSOCIATE_TYPE_FAMILIAR, oDWP));
                DelayCommand(2.0, JumpAssociate(oFM, ASSOCIATE_TYPE_HENCHMAN, oDWP));
                DelayCommand(2.0, JumpAssociate(oFM, ASSOCIATE_TYPE_SUMMONED, oDWP));
                }
            // Select the next member of the faction and loop.
            oFM = GetNextFactionMember(oFM);
            }
        }
    else
       {
        //only use the visual effect if the local variable has been set
        if (iTeleVisual == 1)
           {
            effect eVis = EffectVisualEffect(VFX_FNF_SUMMON_MONSTER_3);
            ApplyEffectToObject(DURATION_TYPE_INSTANT, eVis, oPC);
           }
        //only let the PC say something if the local variable has been set
        if (sGoodbye != "")
           {
           AssignCommand(oPC, ActionSpeakString(sGoodbye));
           }
        //only send a message to the PC if the local variable has been set
        if (sTeleportmessage != "")
           {
           SendMessageToPC(oPC, sTeleportmessage);
           }
        AssignCommand(oPC, DelayCommand(2.0, JumpToObject(oDWP)));
        if (iTeleportAssociateToo == 1)
            {
            // now send the players companions over as well:
            DelayCommand(2.0, JumpAssociate(oPC, ASSOCIATE_TYPE_ANIMALCOMPANION, oDWP));
            DelayCommand(2.0, JumpAssociate(oPC, ASSOCIATE_TYPE_DOMINATED, oDWP));
            DelayCommand(2.0, JumpAssociate(oPC, ASSOCIATE_TYPE_FAMILIAR, oDWP));
            DelayCommand(2.0, JumpAssociate(oPC, ASSOCIATE_TYPE_HENCHMAN, oDWP));
            DelayCommand(2.0, JumpAssociate(oPC, ASSOCIATE_TYPE_SUMMONED, oDWP));
            }
        }
}

Select All Text | View Code in separate window

Format

Module and Code

Type

Type - Transitions

Includes

None

Description

You now only need this ONE script to handle teleports. All parameters are set via local variables set on the object that is going to teleport the PC. Via local variables you can choose whether to; Teleport player out of conversation, trigger or placeable. Teleport player with or without companions (if teleporting within same area). Teleport player alone or the whole party. Make the player say a one liner when being teleported. Send a message to the Player to let them know what happened. Play one of five visual effects when the player is teleported. The script is heavily commented. Full installation instructions are found in the comments at the top of the script. There is also a small demo module included. Thanks go to Amurayi's Ultimate Teleport Script for which was the foundation for this script.

Files

Name	Type	Size	Downloads
Baron_of_Gateford1102371273171BOG_teleport_demo.zipBaron_of_Gateford1102371273171BOG_teleport_demo.zip Submitted: 12-06-2004 / Last Updated: 12-06-2004	zip	62.96Kb	439
--

SCORE OUT OF 10

10
3 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 (5):

Posted by Baragg at 2009-09-03 13:20:50 Voted 10.00 on 09/03/09

Thanks for this, this should return many resources to Shadow Mountain.
_________________________
Doing it the only way I know how, the Hardway!

No Show Helm Link

No Show Helms Subrace Compatible
Link
-------------------------------------------

Posted by Cernunnos at 2009-06-26 17:17:23 Voted 10.00 on 06/26/09

I can't really see what accounts for the low score here, I have used this system before and am using it again on my new project. Even years later, this system is the simplest, most hassle-free means for teleporting PCs.

Also, it's extremely customizable.

Did I mention it's a boon to non-scripters like me?

Consider this a much belated "THANKS!"

perfect "10"
_________________________
World of Abred Forums: Link

"'Don't you want to join us?' I was recently asked by an acquaintance when he ran across me alone after midnight in a coffeehouse that was already almost deserted. 'No, I don't," I said. - Kafka

Posted by Tyndrel at 2008-09-26 07:41:58 Voted 10.00 on 09/26/08

Thanks for this, it does exactly what it says. I'll be using this from now on and spending less time creating carbon copy scripts for each teleport. Well documented so anyone can use it.
Tyndrel.
_________________________
All the thanks the designer gets is your vote, please use it.

Of Time and Death's Feast Link ~ Leybury Link ~ Shadow Mountain PW Link ~ CEP Skybox Reference Link ~ 1.69 Texture Reference Link

Posted by The_Baron at 2004-12-11 01:53:00

Forgot to mention,
The demo module was created using SoU and Hotu.
So you will need both Expansion Packs, to see the demo.

Posted by The_Baron at 2004-12-11 01:52:00

Forgot to mention,
The demo module was created using SoU and Hotu.
So you will need both Expansion Packs, to see the demo.

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