Skins: |

NWN SCRIPTS

- Jump to comments -

Title

Tag-based Template, Activate Only

Author

The Krit

Submitted / Updated

06-12-2010 / 11-13-2010

Category

Tutorials

Expansions

HOTU-1.59

View Code

// Tag-based script template, simplified version.
// This is intended to be a starting point for writing a tag-based script for
// an item that only needs to handle its activation event.
// Copy this to a script whose name is the tag of the item in question, then
// add the functionality you want where indicated (towards the end of the script).


#include "x2_inc_switches"


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();

    // We are only interested in activation.
    if ( nEvent != X2_ITEM_EVENT_ACTIVATE )
        return;

    // Define the parameters.
    object oItem = GetItemActivated();
    object oActTarget = GetItemActivatedTarget();
    location lActTarget = GetItemActivatedTargetLocation();
    object oActivator = GetItemActivator();

    // -------------------------------------------------------------------------
    // This is where to put your code.
    // Remember that OBJECT_SELF will refer to the module.
    // The item activated is oItem, the activator is oActivator, the target
    // object is oActTarget, and the taget location is lActTarget.
    // If oActTarget is not OBJECT_INVALID, then lActTarget is oActTarget's location.
    // If oActTarget is OBJECT_INVALID, then the player clicked on the ground.
}

Select All Text | View Code in separate window

Format

Code Only

Type

Type - Unique Items

Includes

BioWare Standard

Description

This is a template script to help people create their scripts for tag based items when only item activation needs custom behavior (a fairly common case). The template includes all the necessary interface instructions (like finding the item in question and setting the executed script return value), allowing the scripter to focus on what needs to be done. This is a simplified version of my Tag-based Template, with the events other than activation removed and the remaining code merged into the main() function. This should make the template less intimidating for beginning scripters who are only interested in handling the OnActivate event anyway.

The basic way to use this is to copy it to your script (named for the item's tag), then add your code where indicated (near the bottom of the script, but before the closing curly brace). Variables representing the item activated, the character activating the item, the object targeted, and the location targeted are defined at that point so you do not have to worry about how to find them.

The primary intended audience for this are those who are have taken a step beyond the script generator, or at least are willing to take that step. (A "step" would include just being able to copy the insides of a generated script into another script and deal with resolving variable names as needed.) An understanding of what variables are and how they are used would be useful, but the ability to write a script from scratch is not strictly necessary.

It occurred to me that my full-blown template might be intimidating to some and that the vast majority of tag-based items probably only handle activation, so I thought I would post this in case someone might find it helpful.

Nov 13, 2010 -- renamed the "oTarget" and "lTarget" variables for better compatibility with scripts originating with the Script Generator

Files

Name	Type	Size	Downloads
NO FILES

SCORE OUT OF 10

10
2 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

You Must Be Logged In to Participate.

Comments (2):

Posted by _Genisys at 2010-09-08 09:40:01 Voted 10.00 on 09/08/10

Very good rendition of a template for this event, thanks.
_________________________
Here is a link to: My Other Submissions

All Updated & Final Edt. Content By Genisys/Guile (External Download)

"I do it for the thanks I get, really." :D

Posted by Gonzo_og at 2010-06-12 23:13:57 Voted 10.00 on 06/12/10

Helpful!
_________________________
stuff

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