Trap respawn script

[davidb]

Here is what I have been working in.

Around 50% is mine, the rest is shameless Ctrl+C/Ctrl+V.

It can still be expanded, trap size can be randomized, and not limiting traps to floor, but on objects too.
--------------------------------------------------------

//TRAP RESET SCRIPT
//Script derivated from many others in the web, then modified by DavidB.
//The basic idea here is, you place WPs in the zone
//with the requirements below, then play with the constants to gauge difficulty,
//and call the function ResetAllTrapsinZone() from heartbeat or from
//user defined event.

const string TRAPPED_AREA_TAG = "AREA1";
//the object reference is any object (preferably non-trigger) which will
//be used to obtain the waypoits where the traps will be spawned. The
//reference object should be WITHIN the area with the trap waypoints but
//should NOT be a trap waypoint itself.
const string AREA_OBJECT_REFERENCE = "ITEM1";
//the trap suffix must be consistent with the actual waypoints being
//used in the specified area. The trap waypoint tags should be as follows:
//"wp_(area tag)_(TRAP_SUFFIX)"
const string TRAP_SUFFIX = "TRAP";

//these constants set the DEFAULT settings of all the floor traps. Trap
//parameters can be overriden, however with the following local variables
//being set on specific trap waypoints:
//Integer "TrapType" = TRAP_TYPE
//Float "TrapSize" = TRAP_SIZE
//String "DisarmScript" = TRAP_DISARM_SCRIPT
//String "TriggeredScript" = TRAP_TRIGGER_SCRIPT
const float TRAP_SIZE = 2.0;
const string TRAP_DISARM_SCRIPT = "";
const string TRAP_TRIGGER_SCRIPT = "";

const int TRAP_CHANCE =50;
//Chance of each trap actually being generated. If you want every trap to be always placed on each WP,
//set to 100. If you want more random location traps, place more WPs in the area, and reduce the chance
//of traps respawned by lowering TRAP_CHANCE.

const int MINIMUM_DC_DISARM = 32;
const int MINIMUM_DC_DETECT = 14;
//The traps will have a disarm DC equal to MINIMUM_DC_DISARM + 1d10
//The traps will have a detect DC equal to MINIMUM_DC_DETECT + 1d6

const int INCLUDE_MINOR_TRAPS = FALSE;
const int INCLUDE_AVERAGE_TRAPS = TRUE;
const int INCLUDE_STRONG_TRAPS = TRUE;
const int INCLUDE_DEADLY_TRAPS = TRUE;
const int INCLUDE_EPIC_TRAPS = FALSE;
//Set to true or false to gauge the potency of your randomly generated traps in the area

int RandomTrapType()
{
//First let's determine the trap potency
int iTrapPotency = 0;
int iTrap;
int iRandom;
while (iTrapPotency == 0)
{
iRandom = Random(5)+1;
if ((iRandom == 1)&&(INCLUDE_MINOR_TRAPS)) iTrapPotency = 1;
if ((iRandom == 2)&&(INCLUDE_AVERAGE_TRAPS)) iTrapPotency = 2;
if ((iRandom == 3)&&(INCLUDE_STRONG_TRAPS)) iTrapPotency = 3;
if ((iRandom == 4)&&(INCLUDE_DEADLY_TRAPS)) iTrapPotency = 4;
if ((iRandom == 5)&&(INCLUDE_EPIC_TRAPS)) iTrapPotency = 5;
}
// Now that iTrapPotency is decided, let's find the actual trap Type.

if (iTrapPotency == 1)
{
iRandom = Random (11);
switch (iRandom)
{
case 0 : iTrap = TRAP_BASE_TYPE_MINOR_ACID; break;
case 1 : iTrap = TRAP_BASE_TYPE_MINOR_ACID_SPLASH; break;
case 2 : iTrap = TRAP_BASE_TYPE_MINOR_ELECTRICAL; break;
case 3 : iTrap = TRAP_BASE_TYPE_MINOR_FIRE; break;
case 4 : iTrap = TRAP_BASE_TYPE_MINOR_FROST; break;
case 5 : iTrap = TRAP_BASE_TYPE_MINOR_GAS; break;
case 6 : iTrap = TRAP_BASE_TYPE_MINOR_HOLY; break;
case 7 : iTrap = TRAP_BASE_TYPE_MINOR_NEGATIVE; break;
case 8 : iTrap = TRAP_BASE_TYPE_MINOR_SONIC; break;
case 9 : iTrap = TRAP_BASE_TYPE_MINOR_SPIKE; break;
case 10 : iTrap = TRAP_BASE_TYPE_MINOR_TANGLE; break;
}

}
if (iTrapPotency == 2)
{iRandom = Random (11);
switch (iRandom)
{
case 0 : iTrap = TRAP_BASE_TYPE_AVERAGE_ACID; break;
case 1 : iTrap = TRAP_BASE_TYPE_AVERAGE_ACID_SPLASH; break;
case 2 : iTrap = TRAP_BASE_TYPE_AVERAGE_ELECTRICAL; break;
case 3 : iTrap = TRAP_BASE_TYPE_AVERAGE_FIRE; break;
case 4 : iTrap = TRAP_BASE_TYPE_AVERAGE_FROST; break;
case 5 : iTrap = TRAP_BASE_TYPE_AVERAGE_GAS; break;
case 6 : iTrap = TRAP_BASE_TYPE_AVERAGE_HOLY; break;
case 7 : iTrap = TRAP_BASE_TYPE_AVERAGE_NEGATIVE; break;
case 8 : iTrap = TRAP_BASE_TYPE_AVERAGE_SONIC; break;
case 9 : iTrap = TRAP_BASE_TYPE_AVERAGE_SPIKE; break;
case 10 : iTrap = TRAP_BASE_TYPE_AVERAGE_TANGLE; break;
}
}
if (iTrapPotency == 3)
{
iRandom = Random (11);
switch (iRandom)
{
case 0 : iTrap = TRAP_BASE_TYPE_STRONG_ACID; break;
case 1 : iTrap = TRAP_BASE_TYPE_STRONG_ACID_SPLASH; break;
case 2 : iTrap = TRAP_BASE_TYPE_STRONG_ELECTRICAL; break;
case 3 : iTrap = TRAP_BASE_TYPE_STRONG_FIRE; break;
case 4 : iTrap = TRAP_BASE_TYPE_STRONG_FROST; break;
case 5 : iTrap = TRAP_BASE_TYPE_STRONG_GAS; break;
case 6 : iTrap = TRAP_BASE_TYPE_STRONG_HOLY; break;
case 7 : iTrap = TRAP_BASE_TYPE_STRONG_NEGATIVE; break;
case 8 : iTrap = TRAP_BASE_TYPE_STRONG_SONIC; break;
case 9 : iTrap = TRAP_BASE_TYPE_STRONG_SPIKE; break;
case 10 : iTrap = TRAP_BASE_TYPE_STRONG_TANGLE; break;
}
}
if (iTrapPotency == 4)
{
iRandom = Random (11);
switch (iRandom)
{
case 0 : iTrap = TRAP_BASE_TYPE_DEADLY_ACID; break;
case 1 : iTrap = TRAP_BASE_TYPE_DEADLY_ACID_SPLASH; break;
case 2 : iTrap = TRAP_BASE_TYPE_DEADLY_ELECTRICAL; break;
case 3 : iTrap = TRAP_BASE_TYPE_DEADLY_FIRE; break;
case 4 : iTrap = TRAP_BASE_TYPE_DEADLY_FROST; break;
case 5 : iTrap = TRAP_BASE_TYPE_DEADLY_GAS; break;
case 6 : iTrap = TRAP_BASE_TYPE_DEADLY_HOLY; break;
case 7 : iTrap = TRAP_BASE_TYPE_DEADLY_NEGATIVE; break;
case 8 : iTrap = TRAP_BASE_TYPE_DEADLY_SONIC; break;
case 9 : iTrap = TRAP_BASE_TYPE_DEADLY_SPIKE; break;
case 10 : iTrap = TRAP_BASE_TYPE_DEADLY_TANGLE; break;
}
}
if (iTrapPotency == 5)
{
iRandom = Random (4);
switch (iRandom)
{
case 0 : iTrap = TRAP_BASE_TYPE_EPIC_ELECTRICAL; break;
case 1 : iTrap = TRAP_BASE_TYPE_EPIC_FIRE; break;
case 2 : iTrap = TRAP_BASE_TYPE_EPIC_FROST; break;
case 3 : iTrap = TRAP_BASE_TYPE_EPIC_SONIC; break;
}
}
return iTrap;

return iTrap;
}


void CreateTrapAtWaypoint(int nTrapType, object oWaypoint, float fSize=2.0f, string sTag="", string sOnDisarmScript="", string sOnTrapTriggeredScript="")
{

//checking if the WP has been given specific trap details. If so, they are set.
if ( GetLocalInt(oWaypoint, "TrapType") > 0 ) nTrapType = GetLocalInt(oWaypoint, "TrapType");
if ( GetLocalFloat(oWaypoint, "TrapSize") > 0.0 ) fSize = GetLocalFloat(oWaypoint, "TrapSize");
if ( GetLocalString(oWaypoint, "DisarmScript") != "" ) sOnDisarmScript = GetLocalString(oWaypoint, "DisarmScript");
if ( GetLocalString(oWaypoint, "TriggeredScript") != "" ) sOnTrapTriggeredScript = GetLocalString(oWaypoint, "TriggeredScript");

object oCreatedTrap = CreateTrapAtLocation(nTrapType, GetLocation(oWaypoint), fSize, sTag, STANDARD_FACTION_HOSTILE, sOnDisarmScript, sOnTrapTriggeredScript);

SetTrapOneShot(oCreatedTrap,FALSE); //This makes traps stay after they fire... feel free to modify.
SetTrapDisarmDC(oCreatedTrap, MINIMUM_DC_DISARM+Random(10)+1);
SetTrapDetectDC(oCreatedTrap, MINIMUM_DC_DETECT+Random(6)+1);
}

void ResetAllTrapsinZone()
{
object oReference = GetObjectByTag(AREA_OBJECT_REFERENCE);
int iCounter;

//All existing traps are destroyed
object oTrap = GetNearestObjectByTag(TRAPPED_AREA_TAG + "_" +TRAP_SUFFIX, oReference, ++iCounter);

while ( GetIsObjectValid(oTrap) )
{
DestroyObject(oTrap);
oTrap = GetNearestObjectByTag(TRAPPED_AREA_TAG + "_" + TRAP_SUFFIX, oReference, ++iCounter);
}

//Now we respawn them
iCounter = 0;
object oWPTrap = GetNearestObjectByTag("WP_" + TRAPPED_AREA_TAG + "_" + TRAP_SUFFIX, oReference, ++iCounter);

while ( GetIsObjectValid(oWPTrap) )
{
if (Random(100)<TRAP_CHANCE) //Checking the chance of trap being there
CreateTrapAtWaypoint(RandomTrapType(), oWPTrap, TRAP_SIZE, TRAPPED_AREA_TAG + "_" +TRAP_SUFFIX, TRAP_DISARM_SCRIPT, TRAP_TRIGGER_SCRIPT);

oWPTrap = GetNearestObjectByTag("WP_" +TRAPPED_AREA_TAG+ "_" + TRAP_SUFFIX, oReference, ++iCounter);
}

}

[loudent2]

So every HB all the traps are destroyed and re-created?

Couple of points:

while ( GetIsObjectValid(oTrap) )
{
DestroyObject(oTrap);
oTrap = GetNearestObjectByTag(TRAPPED_AREA_TAG + "_" + TRAP_SUFFIX, oReference, ++iCounter);
}

This is potentially dangerous. After all, now that you've deleted a trap is iCounter really the next trap? I think it would be better if you elimiated the counter all together and just get the nearest object by tag.

Also, your trap potency inclusions are hard coded. You should read them from the waypoints.

EDIT: Oh, one more thing. You should always put sanity checks in loops like these.

[DEV Driller]

You might want to try looping through the areas on module load and use SetLocalObject(oArea,"WP_TRAP",i++) on the area to cache these trap waypoints. GetLocalObject() is faster than GetNearestObject().

-driller

[davidb]

Oct 14, 2008 17:53:41 GMT -5 loudent2 said:

So every HB all the traps are destroyed and re-created?

No! This is just a script you can call when you want, not a HB script. OnHeartbeat with a time counter check, like each half an hour for example. You call ResetAllTrapsinZone() when you want, this script has no Main function.

Couple of points:

while ( GetIsObjectValid(oTrap) )
{
DestroyObject(oTrap);
oTrap = GetNearestObjectByTag(TRAPPED_AREA_TAG + "_" + TRAP_SUFFIX, oReference, ++iCounter);
}

This is potentially dangerous. After all, now that you've deleted a trap is iCounter really the next trap? I think it would be better if you elimiated the counter all together and just get the nearest object by tag.

You're right, I should do that. That's an excessive complicated code for no reason.

Also, your trap potency inclusions are hard coded. You should read them from the waypoints.

Why? That way, altering the potency of traps in a zone with 30 WPs is a lot of work. I think when you're designing a zone you will want all of them to be of a certain difficulty, like "between simple and average", and you can always set a single WP with specific trap values. Ain't it flexible enough?

EDIT: Oh, one more thing. You should always put sanity checks in loops like these.

Right again, I'm becoming sloppy with age.

[davidb]

Oct 14, 2008 18:27:22 GMT -5 DEV Driller said:

You might want to try looping through the areas on module load and use SetLocalObject(oArea,"WP_TRAP",i++) on the area to cache these trap waypoints. GetLocalObject() is faster than GetNearestObject().

-driller

Thanks Driller, I will do that definitely.

[loudent2]

Oct 15, 2008 1:15:59 GMT -5 davidb said:

No! This is just a script you can call when you want, not a HB script.

Ok, the comments on the top of the script indicate HB as one of the possible locations to call ResetAllTraps()

Why? That way, altering the potency of traps in a zone with 30 WPs is a lot of work. I think when you're designing a zone you will want all of them to be of a certain difficulty,

Fine, set it as locals on a zone or something. Right now it's hard coded in the script meaning you need a different script for each combination of potencies.

The point is this script should be adjustable in any area and not hard coded like:

const int INCLUDE_MINOR_TRAPS = FALSE;
const int INCLUDE_AVERAGE_TRAPS = TRUE;
const int INCLUDE_STRONG_TRAPS = TRUE;
const int INCLUDE_DEADLY_TRAPS = TRUE;
const int INCLUDE_EPIC_TRAPS = FALSE;


Also, in the messag box window there are tags to put around scripts that will format it a little better than "quote". Makes it a bit eaier to read.

[davidb]

Oct 15, 2008 2:20:26 GMT -5 loudent2 said:

Oct 15, 2008 1:15:59 GMT -5 davidb said:

No! This is just a script you can call when you want, not a HB script.

Ok, the comments on the top of the script indicate HB as one of the possible locations to call ResetAllTraps()

Yes, but after checking a condition, like if X time has passed since last reset.

Fine, set it as locals on a zone or something. Right now it's hard coded in the script meaning you need a different script for each combination of potencies.

The point is this script should be adjustable in any area and not hard coded like:

const int INCLUDE_MINOR_TRAPS = FALSE;
const int INCLUDE_AVERAGE_TRAPS = TRUE;
const int INCLUDE_STRONG_TRAPS = TRUE;
const int INCLUDE_DEADLY_TRAPS = TRUE;
const int INCLUDE_EPIC_TRAPS = FALSE;


ahh, I understand you now. I've been working with just one trapped zone, that's why my code is not very versatile. I will do that, yes.

Also, in the messag box window there are tags to put around scripts that will format it a little better than "quote". Makes it a bit eaier to read.

I tried 'code' but looks the same... so I just removed the tags in the original post for better readability.

[loudent2]

Yes, but after checking a condition, like if X time has passed since last reset.

Yes, I understand, just letting you know the souce of my confusion was the comment on the top of the script.

So the question that follows is where do you want the intelligence of this script to reside? Either here or in the caller or a little of both?

for example, if there are no PCs in the area does it really make sense to respawn all the traps? Perhaps a check at the beginning of the function for PCs would be warranted, exiting out if there are none.

I think, ideally, you would wire this into your mob respawn system so, while it's spawning mobs to fight, it's also spawning traps.

You've already indicated expanding this to allow trapsize and other things to randomized or overridden so that's a good thing.

Other things you might consider is randomizing the exact location of the trap (instead of always at the waypoint) and, instead of having never ending fireing traps create traps as one shot and generate new ones as their fired(or disabled, or recovered). (not sure how the one shot status affects reciverng traps. Could a PC rogue just sit there recovering traps or is it disallowed when it's not one shot?)

[davidb]

My idea is setting a time counter variable that starts at zero when someone enters the zone and keeps increasing while there is people in the zone. Upn reaching some value, it fires this script and possibly others (monsters). If there's no PC around, the counter won't increae, so the zone freezes.

About complete randomization of trap position, well, I don't like it, as I want some areas with traps and others without them. Maybe I can add a random displacement of a few yards for each trap.

And agreed, they shouldn't be recoverable if they're not oneshot. An oversight.