[RunUO 2.0 RC1] PlayerRangeSensitiveMod

[ArteGordon]

PlayerRangeSensitiveMod
v2.0
RunUO 2.0 version
updated 8/25/06
ArteGordon


Summary:

AI mod that provides most of the benefits of having PlayerRangeSensitive=false (continuously active AI) with virtually none of the server load.


Recent Updates:

New to version 2.0
updated 8/25/06

- Greatly simplified the overall mod.
- installation instructions updated for RunUO 2.0

Description:

This mod resulted from a great idea by KillerBeez to allow servers to set PlayerRangeSensitive=true but still have mobs to behave as though it were false for some period of time even when players are out of range.
What this mod does is to allow creature AI to remain active for a delay period (set by the DeactivationDelay property, default is 2 minutes) after AI deactivation is triggered (when players go out of range). This essentially allows mob AI to behave as though PlayerRangeSensitive=false when players have been around but then move well beyond the normal range sensitivity (e.g. to other maps, or outside of dungeons), while leaving it true (hence no cpu load) for the vast majority of areas without any recent player activity.

This is particularly effective on shards with low player counts since it provides most of the benefits of PlayerRangeSensitive=false with virtually none of the load.
One thing that I especially like is that with the mod, mobs will no longer collect at dungeon entrances!

I would estimate that shards that are currently running with PlayerRangeSensitive=false, could set it to true, put the delay at something like 10-20 minutes and get behavior that was essentially indistinguishable from PlayerRangeSensitive=false but with 50-90% reduction in overall cpu load. Even at longer delay settings (hours) I would estimate significant reductions in overall cpu load given that significant fractions of each facet are likely to be unvisited over the course of an hour or two and the cpu load reduction will be esentially proportional to this fraction.

Commands:

- the "[setdeactivation [minutes]" command allows an admin to change the default deactivation delay in-game.

Note, setting it to zero will essentially disable the mod returning to the normal PlayerRangeSensitive=true behavior.
Also, changed values in-game will not be restored on server restarts. For permanent change of the deactivation delay, set the DefaultDeactivationDelay static variable in setdeactivation.cs


Installation:

see the installation notes in the PlayerRangeSensitiveMod.txt file for details.

[Irian]

Great idea. Simple but elegant...

[ArteGordon]

- added a mod to OnMapChange that will automatically reactivate AI on creatures that are returning from the internal map, like stabled pets.

The standard behavior is to just let the AI run on internalized mobs. The posted mod turns off AI when internalized and then restarts it when they are restored.
I can't think of any reason why you would want AI running on creatures with internal or null maps, but if someone does think of something, let me know.

Note, that part of the mod isnt required for the enhanced playerrangesensitive behavior, I just added it in because it seemed better, so if you dont want to perform the parts of the mod not explicitly marked with

// begin PlayerRangeSensitiveMod
// end PlayerRangeSensitiveMod

that is ok.

[Vertigo]

thnx ArteGordon

[madphatboy2]

Dude, you are a total stud. I was recently having issues with something along this line, and then *POOF* here is your mod. +++Karma

[Cheetah2003]

Originally Posted by ArteGordon

- added a mod to OnMapChange that will automatically reactivate AI on creatures that are returning from the internal map, like stabled pets.

The standard behavior is to just let the AI run on internalized mobs. The posted mod turns off AI when internalized and then restarts it when they are restored.
I can't think of any reason why you would want AI running on creatures with internal or null maps, but if someone does think of something, let me know.

Note, that part of the mod isnt required for the enhanced playerrangesensitive behavior, I just added it in because it seemed better, so if you dont want to perform the parts of the mod not explicitly marked with

// begin PlayerRangeSensitiveMod
// end PlayerRangeSensitiveMod

that is ok.

Ah cool. I was having an issue with this since installing this mod yesterday. Mounted pets are placed on internal map, so when I dismounted and told my pet to do something it'd just stand there looking dumb. I had just finished a fix in BaseMount.cs, but yours is much more elegant and covers every instance of pets returning from Map.Internal. Thanks!!

[atf]

Great idea, excellent work.
I wonder, does it work on RC2?

[ArteGordon]

Originally Posted by atf

Great idea, excellent work.
I wonder, does it work on RC2?

yes, works fine with RC2 and all SVNs so far.

[nadious]

Arte,

I was trying to install this mod and had a question:

In the docs, is says:

and around line 3050 add the OnMapChange method

        // ARTEGORDONMOD
        // begin reactivate AI on map change
        protected override void OnMapChange(Map oldMap)
        {
            Map map = this.Map;

            if (m_AI != null && map != null && map.GetSector(this.Location).Active)
                m_AI.Activate();

            base.OnMapChange(oldMap);
        }
        // end reactivate AI on map change

        protected override void OnLocationChange(Point3D oldLocation)
        {
            Map map = this.Map;

            if (PlayerRangeSensitive && m_AI != null && map != null && map.GetSector(this.Location).Active)
                m_AI.Activate();

            base.OnLocationChange(oldLocation);
        }

There is no 'OnMapChange' method, but a 'OnLocationChange', instead, around 3050. Should the 'OnMapChange' portions of the script be changed to 'OnLocationChange' or should I leave it like it is?

I'm running SVN 295.

[ArteGordon]

you need to add the OnMapChange method as it is shown. As you mentioned, there isnt one there in the default basecreature.cs script.

and around line 3050 add the OnMapChange method

        // ARTEGORDONMOD
        // begin reactivate AI on map change
        protected override void OnMapChange(Map oldMap)
        {
            Map map = this.Map;

            if (m_AI != null && map != null && map.GetSector(this.Location).Active)
                m_AI.Activate();

            base.OnMapChange(oldMap);
        }
        // end reactivate AI on map change

The OnLocationChange method shown is just there to give you a suggestion as to where to put it in the script. You dont need to modify that at all.

[nadious]

10-4. Appreciate it. You can tell I'm still wet behind the ears when it comes to this scripting stuff.

[Wardka]

This is a fantastic script, Arte. You have my thanks for releasing this and all your other awesome stuff.

[Hanse_T_Insane]

i put it in and now this

RunUO - [www.runuo.com] Version 2.0, Build 2959.20979
Core: Running on .NET Framework Version 2.0.50727
Core: Optimizing for 2 processors
Scripts: Compiling C# scripts...failed (1 errors, 0 warnings)
Errors:
 + Engines/AI/Creature/BaseCreature.cs:
    CS1513: Line 3050: } expected
Scripts: One or more scripts failed to compile or no script files were found.
 - Press return to exit, or R to try again.

here is what i did

{
			if ( Combatant != null )
				return false; // in combat.. not idling

			if ( m_IdleReleaseTime > DateTime.MinValue )
			{
				// idling...

				if ( DateTime.Now >= m_IdleReleaseTime )
				{
					m_IdleReleaseTime = DateTime.MinValue;
					return false; // idle is over
				}

				return true; // still idling
			}

			if ( 95 > Utility.Random( 100 ) )
				return false; // not idling, but don't want to enter idle state

			m_IdleReleaseTime = DateTime.Now + TimeSpan.FromSeconds( Utility.RandomMinMax( 15, 25 ) );
			
        // ARTEGORDONMOD
        // begin reactivate AI on map change
        protected override void OnMapChange(Map oldMap)
        {
            Map map = this.Map;

            if (m_AI != null && map != null && map.GetSector(this.Location).Active)
                m_AI.Activate();

            base.OnMapChange(oldMap);
        }
        // end reactivate AI on map change

        protected override void OnLocationChange(Point3D oldLocation)
        {
            Map map = this.Map;

            if (PlayerRangeSensitive && m_AI != null && map != null && map.GetSector(this.Location).Active)
                m_AI.Activate();

            base.OnLocationChange(oldLocation);
        			

			if ( Body.IsHuman )
			{
				switch ( Utility.Random( 2 ) )
				{
					case 0: Animate( 5, 5, 1, true,  true, 1 ); break;
					case 1: Animate( 6, 5, 1, true, false, 1 ); break;
				}	
			}
			else if ( Body.IsAnimal )
			{
				switch ( Utility.Random( 3 ) )
				{
					case 0: Animate(  3, 3, 1, true, false, 1 ); break;
					case 1: Animate(  9, 5, 1, true, false, 1 ); break;
					case 2: Animate( 10, 5, 1, true, false, 1 ); break;
				}
			}
			else if ( Body.IsMonster )
			{
				switch ( Utility.Random( 2 ) )
				{
					case 0: Animate( 17, 5, 1, true, false, 1 ); break;
					case 1: Animate( 18, 5, 1, true, false, 1 ); break;
				}
			}

			PlaySound( GetIdleSound() );
			return true; // entered idle state

suggestions pls?

[Greystar]

Originally Posted by Hanse_T_Insane

i put it in and now this

RunUO - [www.runuo.com] Version 2.0, Build 2959.20979
Core: Running on .NET Framework Version 2.0.50727
Core: Optimizing for 2 processors
Scripts: Compiling C# scripts...failed (1 errors, 0 warnings)
Errors:
 + Engines/AI/Creature/BaseCreature.cs:
    CS1513: Line 3050: } expected
Scripts: One or more scripts failed to compile or no script files were found.
 - Press return to exit, or R to try again.

here is what i did

{
			if ( Combatant != null )
				return false; // in combat.. not idling

			if ( m_IdleReleaseTime > DateTime.MinValue )
			{
				// idling...

				if ( DateTime.Now >= m_IdleReleaseTime )
				{
					m_IdleReleaseTime = DateTime.MinValue;
					return false; // idle is over
				}

				return true; // still idling
			}

			if ( 95 > Utility.Random( 100 ) )
				return false; // not idling, but don't want to enter idle state

			m_IdleReleaseTime = DateTime.Now + TimeSpan.FromSeconds( Utility.RandomMinMax( 15, 25 ) );
			
        // ARTEGORDONMOD
        // begin reactivate AI on map change
        protected override void OnMapChange(Map oldMap)
        {
            Map map = this.Map;

            if (m_AI != null && map != null && map.GetSector(this.Location).Active)
                m_AI.Activate();

            base.OnMapChange(oldMap);
        }
        // end reactivate AI on map change

        protected override void OnLocationChange(Point3D oldLocation)
        {
            Map map = this.Map;

            if (PlayerRangeSensitive && m_AI != null && map != null && map.GetSector(this.Location).Active)
                m_AI.Activate();

            base.OnLocationChange(oldLocation);
        			

			if ( Body.IsHuman )
			{
				switch ( Utility.Random( 2 ) )
				{
					case 0: Animate( 5, 5, 1, true,  true, 1 ); break;
					case 1: Animate( 6, 5, 1, true, false, 1 ); break;
				}	
			}
			else if ( Body.IsAnimal )
			{
				switch ( Utility.Random( 3 ) )
				{
					case 0: Animate(  3, 3, 1, true, false, 1 ); break;
					case 1: Animate(  9, 5, 1, true, false, 1 ); break;
					case 2: Animate( 10, 5, 1, true, false, 1 ); break;
				}
			}
			else if ( Body.IsMonster )
			{
				switch ( Utility.Random( 2 ) )
				{
					case 0: Animate( 17, 5, 1, true, false, 1 ); break;
					case 1: Animate( 18, 5, 1, true, false, 1 ); break;
				}
			}

			PlaySound( GetIdleSound() );
			return true; // entered idle state

suggestions pls?

Right before
// ARTEGORDONMOD
add }

[Hanse_T_Insane]

Thank you very much

[Hanse_T_Insane]

If the time is set to low, will this cause the spawn to cease all movement shortly after spawning?

[Rocko Wang]

The file for download seems corrupted, anybody has a working copy they can share with me? Thanks.

Edit: Never mind, I got it.