* Added code comments to Prioritizer.cs that document how to add a new update priority policy

soprefactor
John Hurliman 2010-05-21 14:04:10 -07:00
parent 93ef65c690
commit abd5d1f747
1 changed files with 13 additions and 1 deletions

View File

@ -5,6 +5,18 @@ using Nini.Config;
using OpenSim.Framework; using OpenSim.Framework;
using OpenMetaverse; using OpenMetaverse;
/*
* Steps to add a new prioritization policy:
*
* - Add a new value to the UpdatePrioritizationSchemes enum.
* - Specify this new value in the [InterestManagement] section of your
* OpenSim.ini. The name in the config file must match the enum value name
* (although it is not case sensitive).
* - Write a new GetPriorityBy*() method in this class.
* - Add a new entry to the switch statement in GetUpdatePriority() that calls
* your method.
*/
namespace OpenSim.Region.Framework.Scenes namespace OpenSim.Region.Framework.Scenes
{ {
public enum UpdatePrioritizationSchemes public enum UpdatePrioritizationSchemes
@ -35,7 +47,7 @@ namespace OpenSim.Region.Framework.Scenes
case UpdatePrioritizationSchemes.Distance: case UpdatePrioritizationSchemes.Distance:
return GetPriorityByDistance(client, entity); return GetPriorityByDistance(client, entity);
case UpdatePrioritizationSchemes.SimpleAngularDistance: case UpdatePrioritizationSchemes.SimpleAngularDistance:
return GetPriorityByDistance(client, entity); return GetPriorityByDistance(client, entity); // TODO: Reimplement SimpleAngularDistance
case UpdatePrioritizationSchemes.FrontBack: case UpdatePrioritizationSchemes.FrontBack:
return GetPriorityByFrontBack(client, entity); return GetPriorityByFrontBack(client, entity);
default: default: