rule_values and Notes

[pfyon]

It annoyed me that some of the rules did not have notes, but I found them in the source code. Here's the sql to add the notes for the various Bots: rules


UPDATE rule_values
SET notes = "Adjust mana regen for bots, 1 is fast and higher numbers slow it down 3 is about the same as players."
WHERE rule_name = "Bots:BotManaRegen";
UPDATE rule_values
SET notes = "Allow for buffs to complete even if the bot caster is out of mana. Only affects buffing out of combat."
WHERE rule_name = "Bots:BotFinishBuffing";
UPDATE rule_values
SET notes = "Number of bots that each account can create"
WHERE rule_name = "Bots:CreateBotCount";
UPDATE rule_values
SET notes = "Number of bots a character can have spawned at one time, You + 71 bots is a 12 group raid"
WHERE rule_name = "Bots:SpawnBotCount";
UPDATE rule_values
SET notes = "Optional quest method to manage bot spawn limits using the quest_globals name bot_spawn_limit, see: /bazaar/Aediles_Thrall.pl"
WHERE rule_name = "Bots:BotQuest";
UPDATE rule_values
SET notes = "Bots will cast single target buffs as group buffs, default is false for single. Does not make single target buffs work for MGB."
WHERE rule_name = "Bots:BotGroupBuffing";
UPDATE rule_values
SET notes = "Anita Thrall's (Anita_Thrall.pl) Bot Spell Scriber quests."
WHERE rule_name = "Bots:BotSpellQuest";

[pfyon]

TaskSystem

UPDATE rule_values
SET notes = "Seconds between checks for failed tasks. Also used by the 'Touch' activity"
WHERE rule_name = "TaskSystem:PeriodicCheckTimer";


Aggro

UPDATE rule_values
SET notes = "Percent"
WHERE rule_name = "Aggro:SittingAggroMod"
OR rule_name = "Aggro:MeleeRangeAggroMod"
OR rule_name = "Aggro:CriticallyWoundedAggroMod";


Character
UPDATE rule_values
SET notes = "item's hunger restored = this value * item's food level, 100 = normal, 50 = people eat 2x as fast, 200 = people eat 2x as slow"
WHERE rule_name = "Character:ConsumptionMultiplier";
UPDATE rule_values
SET notes = "Number of dark blues or above per Group Leadership AA"
WHERE rule_name = "Character:KillsPerGroupLeadershipAA";
UPDATE rule_values
SET notes = "Number of dark blues or above per Raid Leadership AA"
WHERE rule_name = "Character:KillsPerRaidLeadershipAA";


Zone
UPDATE rule_values
SET notes = "ms between intervals of sending a position update to the entire zone."
WHERE rule_name = "Zone:NPCPositonUpdateTicCount";
UPDATE rule_values
SET notes = "the time a client remains link dead on the server after a sudden disconnection"
WHERE rule_name = "Zone:ClientLinkdeadMS";
UPDATE rule_values
SET notes = "ms time until a player corpse is moved to a zone's graveyard, if one is specified for the zone"
WHERE rule_name = "Zone:GraveyardTimeMS";
UPDATE rule_values
SET notes = "enables or disables the shadowrest zone feature for player corpses. Default is turned off."
WHERE rule_name = "Zone:EnableShadowrest";
UPDATE rule_values
SET notes = "Required status level to exempt the MQWarpDetector. Set to -1 to disable this feature."
WHERE rule_name = "Zone:MQWarpExemptStatus";
UPDATE rule_values
SET notes = "Required status level to exempt the MQZoneDetector. Set to -1 to disable this feature."
WHERE rule_name = "Zone:MQZoneExemptStatus";
UPDATE rule_values
SET notes = "Required status level to exempt the MQGateDetector. Set to -1 to disable this feature."
WHERE rule_name = "Zone:MQGateExemptStatus";
UPDATE rule_values
SET notes = "Required status level to exempt the MGhostDetector. Set to -1 to disable this feature."
WHERE rule_name = "Zone:MQGhostExemptStatus";
UPDATE rule_values
SET notes = "Enable the MQWarp Detector. Set to False to disable this feature."
WHERE rule_name = "Zone:EnableMQWarpDetector";
UPDATE rule_values
SET notes = "Enable the MQZone Detector. Set to False to disable this feature."
WHERE rule_name = "Zone:EnableMQZoneDetector";
UPDATE rule_values
SET notes = "Enable the MQGate Detector. Set to False to disable this feature"
WHERE rule_name = "Zone:EnableMQGateDetector";
UPDATE rule_values
SET notes = "Enable the MQGhost Detector. Set to False to disable this feature."
WHERE rule_name = "Zone:EnableMQGhostDetector";
UPDATE rule_values
SET notes = "clients move at 4.4 about if in a straight line but with movement and to acct for lag we raise it a bit"
WHERE rule_name = "Zone:MQWarpDetectionDistanceFactor";
UPDATE rule_values
SET notes = "How long a dynamic zone stays loaded while empty"
WHERE rule_name = "Zone:AutoShutdownDelay";

Map
UPDATE rule_values
SET notes = "increases zone boot times a bit to reduce hopping."
WHERE rule_name = "Map:FixPathingZWhenLoading";
UPDATE rule_values
SET notes = "alternative to WhenLoading, accomplishes the same thing but does it at each waypoint instead of once at boot time."
WHERE rule_name = "Map:FixPathingZAtWaypoints";
UPDATE rule_values
SET notes = "very CPU intensive, but helps hopping with widely spaced waypoints."
WHERE rule_name = "Map:FixPathingZWhenMoving";
UPDATE rule_values
SET notes = "try to repair Z coords in the SendTo routine as well."
WHERE rule_name = "Map:FixPathingZOnSendTo";
UPDATE rule_values
SET notes = "at runtime while pathing: max change in Z to allow the BestZ code to apply."
WHERE rule_name = "Map:FixPathingZMaxDeltaMoving";
UPDATE rule_values
SET notes = "at runtime at each waypoint: max change in Z to allow the BestZ code to apply."
WHERE rule_name = "Map:FixPathingZMaxDeltaWaypoint";
UPDATE rule_values
SET notes = "at runtime in SendTo: max change in Z to allow the BestZ code to apply."
WHERE rule_name = "Map:FixPathingZMaxDeltaSendTo";
UPDATE rule_values
SET notes = "while loading each waypoint: max change in Z to allow the BestZ code to apply."
WHERE rule_name = "Map:FixPathingZMaxDeltaLoading";
UPDATE rule_values
SET notes = "Move mobs to the nearest Z above or below, rather than just the nearest below. Only set UseClosestZ true if all your .map files generated from EQGs were created with azone2."
WHERE rule_name = "Map:UseClosestZ";
UPDATE rule_values
SET notes = "Adds this to the current Z before seeking the best Z position"
WHERE rule_name = "Map:FindBestZHeightAdjust";

I'm working on the rest still.

[pfyon]

Pathing
UPDATE rule_values
SET notes = "Enable pathing for aggroed mobs."
WHERE rule_name = "Pathing:Aggro";
UPDATE rule_values
SET notes = "Enable pathing for aggroed roaming mobs returning to their previous waypoint."
WHERE rule_name = "Pathing:AggroReturnToGrid";
UPDATE rule_values
SET notes = "Enable pathing for mobs moving to their guard point."
WHERE rule_name = "Pathing:Guard";
UPDATE rule_values
SET notes = "Enable pathing for FindPerson requests from the client."
WHERE rule_name = "Pathing:Find";
UPDATE rule_values
SET notes = "Enable pathing for fear"
WHERE rule_name = "Pathing:Fear";
UPDATE rule_values
SET notes = "If a mob las LOS to it's target, it will run to it if the Z difference is < this."
WHERE rule_name = "Pathing:ZDiffThreshold";
UPDATE rule_values
SET notes = "A mob will check for LOS to it's target this often (milliseconds)."
WHERE rule_name = "Pathing:LOSCheckFrequency";
UPDATE rule_values
SET notes = "How often a new route will be calculated if the target has moved."
WHERE rule_name = "Pathing:RouteUpdateFrequencyShort";
UPDATE rule_values
SET notes = "How often a new route will be calculated if the target has moved."
WHERE rule_name = "Pathing:RouteUpdateFrequencyLong";
UPDATE rule_values
SET notes = "When a path has a path node route and it's target changes position, if it has RouteUpdateFrequencyNodeCount or less nodes to go on it's current path, it will recalculate it's path based on the RouteUpdateFrequencyShort timer, otherwise it will use the RouteUpdateFrequencyLong timer."
WHERE rule_name = "Pathing:RouteUpdateFrequencyNodeCount";
UPDATE rule_values
SET notes = "(NoRoot). While following a path, only check for LOS to target within this distance."
WHERE rule_name = "Pathing:MinDistanceForLOSCheckShort";
UPDATE rule_values
SET notes = "(NoRoot). Min distance when initially attempting to acquire the target."
WHERE rule_name = "Pathing:MinDistanceForLOSCheckLong";
UPDATE rule_values
SET notes = "Only check for LOS when we are down to this many path nodes left to run."
WHERE rule_name = "Pathing:MinNodesLeftForLOSCheck";
UPDATE rule_values
SET notes = "Only check for LOS after we have traversed this many path nodes. (See long description in ruletypes.h)"
WHERE rule_name = "Pathing:MinNodesTraversedForLOSCheck";
UPDATE rule_values
SET notes = "Checks LOS from Start point to second node for this many nodes and removes first node if there is LOS"
WHERE rule_name = "Pathing:CullNodesFromStart";
UPDATE rule_values
SET notes = "Checks LOS from End point to second to last node for this many nodes and removes last node if there is LOS"
WHERE rule_name = "Pathing:CullNodesFromEnd";
UPDATE rule_values
SET notes = "When searching for path start/end nodes, only nodes within this range will be considered."
WHERE rule_name = "Pathing:CandidateNodeRangeXY";
UPDATE rule_values
SET notes = "When searching for path start/end nodes, only nodes within this range will be considered."
WHERE rule_name = "Pathing:CandidateNodeRangeZ";

Watermap
UPDATE rule_values
SET notes = "Check if a mob has moved into/out of water when at waypoints and sets flymode"
WHERE rule_name = "Watermap:CheckForWaterAtWaypoints";
UPDATE rule_values
SET notes = "Checks if a mob has moved into/out of water each time it's loc is recalculated"
WHERE rule_name = "Watermap:CheckForWaterWhenMoving";
UPDATE rule_values
SET notes = "Does not apply BestZ as waypoints are loaded if they are in water"
WHERE rule_name = "Watermap:CheckWaypointsInWaterWhenLoading";

Spells
UPDATE rule_values
SET notes = "wiz's crit chance, on top of BaseCritChance"
WHERE rule_name = "Spells:WizCritChance";
UPDATE rule_values
SET notes = "wiz's crit bonus, on top of BaseCritRatio (should be 0 for Live-like)"
WHERE rule_name = "Spells:WizCritRatio";

Combat
UPDATE rule_values
SET notes = "The bonus base crit chance you get when you're berserk"
WHERE rule_name = "Combat:BerserkBaseCritChance";
UPDATE rule_values
SET notes = "The base crit chance for all clients, this will stack with warrior's/zerker's crit chance."
WHERE rule_name = "Combat:ClientBaseCritChance";
UPDATE rule_values
SET notes = "If false, mobs won't flee if other mobs are in combat with it."
WHERE rule_name = "Combat:FleeIfNotAlone";
UPDATE rule_values
SET notes = "You gain this % of hit for every level you are above your target"
WHERE rule_name = "Combat:HitBonusPerLevel";
UPDATE rule_values
SET notes = "hit will fall off sharply if we're outside the minor and moderate range"
WHERE rule_name = "Combat:HitFalloffMajor";
UPDATE rule_values
SET notes = "The level that npcs can KICK/BASH"
WHERE rule_name = "Combat:NPCBashKickLevel";
UPDATE rule_values
SET notes = "For every weapon skill point that's not maxed you lose this % of hit"
WHERE rule_name = "Combat:WeaponSkillFalloff";

Adventure
UPDATE rule_values
SET notes = "0 to disable, otherwise using a LDoN portal will require the user to have this item."
WHERE rule_name = "Adventure:ItemIDToEnablePorts";

Some rules are still missing, but they're missing in ruletypes.h as well.

Documentation is an important part of every project, and somewhere that open source projects tend to neglect. By including these descriptions of the rules, it should help new server admins who don't want to dig through the source code to figure out what they do.

Edit: The whole set of queries can be found here: http://peterfyon.homeunix.com/addnotes.sql

[cavedude]

Thank you!

Edit: Nevermind, I see what you mean. The rules don't have notes.

[trevius]

I put an SQL file (524_rule_values_notes.sql) on the SVN a while back to add a notes field to the rule_values table to relieve some of the confusion about rules. I didn't add notes to all of the rules in the list, as I simply added every note that was available in ruletypes.h at the time. Of course, for notes to stay available and current, it relies on everyone that changes/adds rules to also add a note to the notes field. For the ones submitted above, I think they are mostly for rules that have been added since I put the new notes field in place, where people didn't submit notes in their SQL file commit.

[pfyon]

Ah I didn't notice that Trev. I guess I'm still a bit confused about what needs to be included from the utils/sql/svn/ folder in addition to a database pack (peq in my case).