Condition Function Documentation Initiative

Post » Thu Dec 13, 2012 9:52 am

Hey all,

As we all know, the Creation Kit WIki is a great resource for modders. Unfortunately, there is a section of the wiki that is severely lacking in meaningful documentation: the http://www.creationkit.com/Condition_Functions page. We're a year out from Skyrim's release, and we're fast approaching the one-year anniversary of the Creation Kit as well. I think it's time we try to really fill in these kinds of gaps as much as we can. I don't think that blank pages on the CK Wiki need to cut it any longer.

If you are a heavy condition function user, I implore you to take a few minutes of your time and look for the condition functions you've used, and write a small bit of documentation if it does not exist. If there is a condition function that you had to do a bit of homework to figure out how it works, documenting those would be especially helpful.

If you are NOT a condition function guru, there are plenty of simple condition functions that have no documentation. The caveat (and this is true for anything before you document it), is verify it before you document it. Give it a quick try in a spell effect or quest. Ensure that it behaves as you'd expect, and if not, perhaps take the time to explore it further. The point is that incorrect, lazy, or untested documentation is worse than no documentation at all! Even simple boolean conditions can sometimes have unexpected behavior.

Example: http://www.creationkit.com/IsTorchOut. Logic would tell you that, "Well, that tells you whether or not the actor in question has a torch out, duh." The truth is that it returns true if the actor being checked has a light object equipped that has the "carryable" flag enabled. So any object of that type (not just torches) returns true from this condition. You might not know that by just reading the function name. (Yes, I will be filling in documentation for IsTorchOut very soon) This is not something I'd expect a cursory test to reveal, mind you. The point is that a) there is not a single word written about this function yet, and :cool: this is knowledge that's just floating around in my head, which is something we should try to put a stop to whenever possible.

Documentation helps great mods get made faster because authors don't have to spend as much time scratching their heads trying to figure out why things don't work the way they think they should, or using the wrong tool for the job when one of the below conditions would have solved the problem faster and easier.

If even some of us could take a couple of minutes each day to fill out the documentation for one or two condition functions (provided that they were verified), we could reach 100% documentation before the new year. Please help me try to get this section of the wiki completely populated with high-quality information. Thanks!

Here are a list of Condition Functions with no documentation (as of today, 12/12/2012):

(Building the list as I go, this list is incomplete)

http://www.creationkit.com/CanHaveFlames
http://www.creationkit.com/EffectWasDualCast
http://www.creationkit.com/EPAlchemyEffectHasKeyword
http://www.creationkit.com/EPAlchemyGetMakingPoison
http://www.creationkit.com/EPMagic_SpellHasSkill
http://www.creationkit.com/EPModSkillUsage_AdvanceObjectHasKeyword
http://www.creationkit.com/EPModSkillUsage_IsAdvanceAction
http://www.creationkit.com/EPModSkillUsage_IsAdvanceSkill
http://www.creationkit.com/EPTemperingItemHasKeyword
http://www.creationkit.com/EPTemperingItemIsEnchanted
http://www.creationkit.com/GetActivationHeight
http://www.creationkit.com/GetActorAggroRadiusViolated
http://www.creationkit.com/GetActorCrimePlayerEnemy
http://www.creationkit.com/GetActorsInHigh
http://www.creationkit.com/GetActorValuePercent
http://www.creationkit.com/GetAllowWorldInteractions
http://www.creationkit.com/GetAmountSoldStolen
http://www.creationkit.com/GetArrestedState
http://www.creationkit.com/GetArrestingActor
http://www.creationkit.com/GetAttackState
http://www.creationkit.com/GetBribeSuccess
http://www.creationkit.com/GetCannibal
http://www.creationkit.com/GetClassDefaultMatch
http://www.creationkit.com/GetCombatGroupMemberCount
http://www.creationkit.com/GetCombatState
http://www.creationkit.com/GetCombatTargetHasKeyword
User avatar
sarah taylor
 
Posts: 3490
Joined: Thu Nov 16, 2006 3:36 pm

Return to V - Skyrim