Skins: |

NWN SCRIPTS

- Jump to comments -

Title

Simple Creature Data

Author

The Magus

Submitted / Updated

07-15-2011 / 11-11-2012

Category

Scripting routines

Expansions

Works on all versions

View Code

//::///////////////////////////////////////////////
//:: _inc_simplespawn
//:://////////////////////////////////////////////
/*

    Simple Spawn version 1.1

    simple spawn system which associates a data object with the spawned creature
    used as an include: #include "_inc_simplespawn"
    then call the SpawnCreature function in your other scripts

    Spawning is handled with the function named SpawnCreature which resembles CreateObject
    SpawnCreature omits the first parameter of CreateObject because OBJECT_TYPE_CREATURE is assumed.

    for unique creatures the tag and resref should differ

    data object has the tag "data_" + the tag of the creature
    you can create the data object and place in any area as long as it is tagged correctly
    this enables you to take advantage of all of the struct (See the: struct NPC)

    if you do not create a data object for the creature, one will be made for you and associated with the spawn.


    To Do:

*/
//:://////////////////////////////////////////////
//:: Created By: The Magus (2011 july 15)
//:: Modified: The Magus (2011 july 18) version 1.1
//:://////////////////////////////////////////////

// STRUCTS ---------------------------------------------------------------------

// used in a custom spawn system which associates a data object with the creature
struct NPC
{
    // these are used for unique individuals
    int bUnique;         // TRUE = NPC is an individual
    int nHP;             // track hitpoints
    object oSelf;        // object_self identifier

    // these are used by both individuals and populations
    object oData;        // identifies the data object
    int nDeaths;         // track deaths
    int nSpawned;        // track spawns. count of how many currently spawned.

    // these are used by populations
    int nLives;          // maximum deaths. 0 == unlimited.
    int nSpawn_limit;    // maximum spawns at once in the area. 0 == untracked.
};

// FUNCTION DECLARATIONS -------------------------------------------------------

// utility funcs ---------------------------------------------------------------

// Spawns a creature associated with data object. See: Struct NPC - [FILE: _inc_simplespawn]
object SpawnCreature(string sRef, location lSpawn, int bAppear = FALSE, string sTag = "");
// Despawns a creature and updates its data object. See: Struct NPC - [FILE: _inc_simplespawn]
void DespawnCreature(object oCreature, string sTag = "");
// Called by SpawnCreature  - [FILE: _inc_simplespawn]
// returns data stored on an object associated with a creature. See: Struct NPC
struct NPC GetCreatureData(object oCreature);
// Called by SpawnCreature  - [FILE: _inc_simplespawn]
// creates a data object (as waypoint) associated with a creature.
// if creature's tag != resref, assume creature is unique individual
// sets up NPC struct and returns. See: Struct NPC
struct NPC CreateObjectCreatureData(object oCreature);
// Called by SpawnCreature  - [FILE: _inc_simplespawn]
// Returns TRUE if creature spawn should continue. FALSE if conditions not met. See: Struct NPC
int InitializeCreature(struct NPC Creature);

object SpawnCreature(string sRef, location lSpawn, int bAppear = FALSE, string sTag = "")
{
    object oCreature    = CreateObject(OBJECT_TYPE_CREATURE, sRef, lSpawn, bAppear, sTag);
    struct NPC Creature   = GetCreatureData(oCreature); // load data from data object
    if(!GetIsObjectValid(Creature.oData))
    {
        WriteTimestampedLogEntry("SpawnCreature() - "+GetTag(oCreature)+": data object was NOT FOUND"); // Logging
        Creature = CreateObjectCreatureData(oCreature);
    }
    else if (!InitializeCreature(Creature))
        DestroyObject(oCreature);

    return oCreature;
}

void DespawnCreature(object oCreature, string sTag = "")
{
    if (!GetIsObjectValid(oCreature))
    {
        oCreature = GetObjectByTag(sTag);
        if (!GetIsObjectValid(oCreature))
        {
            WriteTimestampedLogEntry("DespawnCreature() - invalid object and tag"); // Logging
            return;
        }
    }

    struct NPC Creature = GetCreatureData(oCreature);

    if(GetIsObjectValid(Creature.oData))
    {   // Update Creature Data
        if (Creature.bUnique)
            SetLocalInt(Creature.oData, "nHP", GetCurrentHitPoints(oCreature));

        SetLocalInt(Creature.oData, "nSpawned", Creature.nSpawned-1);
    }
    else
    {   // Creature data object not available
        WriteTimestampedLogEntry("DespawnCreature() - "+GetTag(oCreature)+": invalid data object"); // Logging
    }

    DestroyObject(oCreature);
}

struct NPC GetCreatureData(object oCreature)
{
    struct NPC Creature;
    object oData            = GetObjectByTag("data_"+GetTag(oCreature));

    Creature.oSelf          = oCreature;
    Creature.oData          = oData;

    if (!GetIsObjectValid(oData))
        return Creature;

    Creature.bUnique        = GetLocalInt(oData,"bUnique");
    Creature.nHP            = GetLocalInt(oData,"nHP");
    Creature.nDeaths        = GetLocalInt(oData,"nDeaths");
    Creature.nLives         = GetLocalInt(oData,"nLives");
    Creature.nSpawned       = GetLocalInt(oData,"nSpawned");
    Creature.nSpawn_limit   = GetLocalInt(oData,"nSpawn_limit");

    return Creature;
}

struct NPC CreateObjectCreatureData(object oCreature)
{
    struct NPC Creature;
    string sTag = GetTag(oCreature);
    string sRef = GetResRef(oCreature);

    WriteTimestampedLogEntry("CreateObjectCreatureData() - "+sTag); // logging

    string sDataRef = "";

    object oData = CreateObject(OBJECT_TYPE_WAYPOINT, sDataRef, GetLocation(oCreature), FALSE, "data_"+sTag);

    if (sTag != sRef) // assume creature is unique
    {
        Creature.bUnique = TRUE;
        SetLocalInt(oData, "bUnique", Creature.bUnique);
        Creature.nHP = GetMaxHitPoints(oCreature);
        SetLocalInt(oData, "nHP", Creature.nHP);
    }

    Creature.oSelf = oCreature;
    SetLocalObject(oData, "oSelf", oCreature);
    Creature.oData = oData;
    SetLocalObject(oCreature, "oData", oData);

    return Creature;
}

int InitializeCreature(struct NPC Creature)
{
    if ( Creature.bUnique )
    {
        if (Creature.nDeaths == 0 && Creature.nSpawned == 0)
        {
            int nMaxHP = GetMaxHitPoints(Creature.oSelf);
            if ( Creature.nHP > 0 && Creature.nHP < nMaxHP )
            {
                int nDamage = nMaxHP - Creature.nHP;
                ApplyEffectToObject(DURATION_TYPE_INSTANT, EffectDamage(nDamage), Creature.oSelf);
            }
            SetLocalInt(Creature.oData, "nSpawned", ++Creature.nSpawned);
            return TRUE;
        }

        return FALSE; // creature is dead or already spawned
    }
    else if(
            (Creature.nDeaths < Creature.nLives || Creature.nLives == 0)
                &&
            (Creature.nSpawned < Creature.nSpawn_limit || Creature.nSpawn_limit == 0)
           )
    {
        if(Creature.nSpawn_limit != 0) // we are tracking spawns
            SetLocalInt(Creature.oData, "nSpawned", ++Creature.nSpawned);
        return TRUE;
    }

    return FALSE; // population is exhausted
}

//void main(){}

Select All Text | View Code in separate window

Format

Code Only

Type

Type - Spawning

Includes

Custom

Forums

Link

Description

A simple means to create and access creature data via script in a single player module. This includes two script functions that replace Create and Destroy object functions for creatures. I have inserted this into NESS in my module so that I can generate and track data related to a creature. (I renamed this entry to help clarify this fact.)

Purpose is to associate a data object with a creature, and thereby have persistency of the creature's data across respawns. Spawning or despawning using this system requires the user to call respectively either the SpawnCreature or the DespawnCreature functions within user scripts.

There is much room for expansion of this. I am using it in a module in which a creature is spawned and despawned a number of times, but I wanted to track its hitpoints across spawns, and not allow it to be spawned if it was killed.

And I have engaged in a conversation about where I am taking this system in a Multiplayer module. Its going in new directions and will likely result in failure due to the lofty goals, but I am going for it!

Version Notes:
1.1
- This version changed the SpawnCreature function to return the creature object so that it operates in the same manner as CreateObject.
- This version also corrected the bad files that were included in the previous version.

1.0
-A future version may have an array object so that a dynamic set of data for the creature can be stored and retrieved.

Instructions:

#include "_inc_simplespawn" in a script in which you create or destroy a creature. As long as the creatures spawned with this system use the default death script (which this system overrides), their death should be tracked.

The functions to use are SpawnCreature and DespawnCreature. They do as their names suggest. Whenever creating or destroying a creature, these functions should be used if you wish to track their data and spawn state. See the scripts for more information.

Advanced Scripters:
To integrate this system with another spawning system replace the CreateObject functions of that system with SpawnCreature from this one.

Files

Name	Type	Size	Downloads
magus_SimpleSpawn_v1_1.rarmagus_SimpleSpawn_v1_1.rar Submitted: 07-15-2011 / Last Updated: 07-18-2011	rar	8.21Kb	65
Version 1.1 2011 July 18 Includes ERF with two scripts. The two scripts as NSS files. And a read me.

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

Posted by Henesua at 2012-11-11 08:21:44

Test post without a link
_________________________
Vault Submissions | Arnheim | Beyond Vives

Posted by Henesua at 2012-11-03 08:32:25

I had developed this for a single player module last year. For that it works very well. I am now looking to generate similar functionality in a PW using NESS and Knat's Natural DataBase Extender.

It is not technically difficult to solve, but I haven't puzzled out the best design for this yet. One could conceivably tie directly to the database and cut out this system as a middleman. The advantage however to this is that a builder without scripting knowledge can configure population settings for a creature (max population etc...). So that is likely the direction I will take this.

Anyway, I am thinking about how best to adapt this to my needs now, and will share if I come up with a universally applicable solution.
_________________________
Vault Submissions | Arnheim | Beyond Vives

Posted by Rolo Kipp at 2012-10-20 07:41:26 Voted 10.00 on 10/20/12

I have a use for this in tracking the Catastrophies in a regional mod...

Thanks ;-)
_________________________
Rolo Kipp

Humor is the only viable response to pain

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