ID Framework - OAAB-Modding/Data GitHub Wiki

Basic

AB_(OBJECT TYPE)_Set-Name-Descriptor(s)-#.#

Set-Name-Descriptor(s)-#: this serves as a guideline for the progression in word/abbreviation usage, these do not all need to be used for every object. Look at the examples below to see how this framework is used.
".#" suffix: A version can be added to any ID if needed to accommodate the patcher for deprecated assets. This is mainly used when a custom location or rotation is needed. (e.g. AB_Misc_BoneSkelFootL.1)

ACTI

AB_(OBJECT TYPE)_Set-Name-Descriptor(s)-#_a

OBJECT TYPE: (shares type with generic version of itself, use Act for hidden objects used only to attach a script)
"a" suffix: intended to be used when there is an "active" part of a set (e.g. AB_In_KwamaTowerForager_a).
EXAMPLES: AB_Act_SoundStoneGrind, AB_Door_ImpSmallHiddenFloor, AB_Furn_ShrineAlmalexia_a

ALCH

AB_(OBJECT TYPE)_Set-Name-Descriptor(s)-#_sp

OBJECT TYPE: alc (generic use), dri (drinks), pot (potions), food (foods), eff (magic effects for scripts)
"sp" suffix: Used to denote spoiled potions
EXAMPLES: AB_food_SaltricePorridge, AB_dri_Musa, ABtv_pot_DragonsBlood

APPA

AB_App_Set-Name-Descriptor(s)-#

EXAMPLES: None yet

ARMO

AB_a_Set-Name-Descriptor(s)-#

EXAMPLES: AB_a_BmoldHelm01, AB_a_BugBlueCuirass, AB_a_IronDeBoots

BODY

AB_(OBJECT TYPE)_Set_BodyPart_Gender

OBJECT TYPE: a/b/c (armor/body/clothing)
BodyPart: an (ankle), ch (chest), cl (clavicle), fa (forearm), ft (foot), gr (groin), hd (head), hn (hand), hr (hair), kn (knee), nk (neck), sd (shield/wrist), tl (tail), ua (upper arm), ul (upper leg), wr (wrist)
Gender: f / m
EXAMPLES: AB_a_BugBlue_an, AB_a_Ceph_cl, AB_a_NetchBoil_cl

BOOK

AB_(OBJECT TYPE)_Set-Name-Descriptor(s)-#_d

OBJECT TYPE: bk, note, sc, ScEn (enchanted scrolls)
"d" suffix: a special suffix only used to denote "Defective" enchanted scrolls
"sk" suffix: a special suffix only used to denote skill books
EXAMPLES: AB_bk_ArkayTheGod, AB_sc_TheFourthBookOfDust, ABtv_note_MoonReiver

CLOT

AB_(OBJECT TYPE)_Set-Name-ClothingType-#

OBJECT TYPE: c, cEn (enchanted clothing)
ClothingType: Ring, Shirt, Pants, etc
EXAMPLES: AB_c_CommonShirt02b, ABtv_cEn_FireBarrierAmulet, ABtv_cEn_TouchOfTheBeastRing

CONT

AB_(OBJECT TYPE)_Set-Name-Descriptor(s)-#-Contents_o

OBJECT TYPE: f/m/o (flora / mineral / all others)
Contents: try to use the remaining ID length to describe the contents (e.g. AB_o_DeShkBasket02Food vs AB_o_DeShkBasket02Pos)
"o" suffix: a special suffix used on flora containers to specify their type vs static versions for easy reference when text searching (similar to the "a" suffix for activators)
EXAMPLES: AB_f_MarshmBundle1_o, AB_o_DeCrateEggOpen, AB_o_KwamaPoisonCyst01, AB_o_Ventworm00

CREA

AB_(OBJECT TYPE)_Set-Name-Descriptor(s)-#

OBJECT TYPE: Fau, Und, Dae, Dwe, Talk ("talk" refers to dummy creatures used in scripts to ForceGreet an inanimate object)
EXAMPLES: AB_Fau_KwamaGrubber, AB_Und_GlassBerserker, ABtv_Dae_Daedrat

DOOR

AB_Door_Set-Name-Descriptor(s)-#_UsageIndicator

UsageIndicator: In/Ex
EXAMPLES: AB_Door_Darkness, AB_Door_ImpTrapTop, AB_Door_TelJail_In

ENCH

AB_(OBJECT TYPE)_Set-Name-Descriptor(s)-#_en

(OBJECT TYPE)_Set-Name-Descriptor(s)-#: when applicable, this part of the ID should match the object the enchantment is being put on.
"en" suffix: all enchantments get this suffix to differentiate them from the object they are enchanting.
EXAMPLES: AB_a_EggminerMask_en, ABtv_c_TouchOfTheBeastRing_en, Abtv_sc_SummonFrostAtronach_en

INGR

AB_(OBJECT TYPE)_Set-Name-Descriptor(s)-#

OBJECT TYPE: IngCrea, IngFlor, IngFood, IngMine
EXAMPLES: AB_IngCrea_KwamaEggBlighted, AB_IngFlor_TelvanniResin, AB_IngFood_KwamaEggCentWrap, AB_IngMine_Sulphur

LEVI

AB_lvl_(OBJECT TYPE)_Set-Name-Descriptor(s)-#

OBJECT TYPE: Special use of this particularly for lists used by NPCs for ease of finding them "w" for weapons, "a" for armor, etc.
EXAMPLES: AB_lvl_KwamaEgg, AB_lvl_PlantWildEdible, AB_lvl_w_WarWizard

LEVC

AB_lvl_Set-Name-Descriptor(s)-#

EXAMPLES: none yet

LIGH

AB_(OBJECT TYPE)_Set-Name-Descriptor(s)-#_Radius_s

OBJECT TYPE: Light@ (sourceless lights), Light (visible light sources)
Radius: Ideally, radii should be written in numerical order to sort properly (e.g. 032, 064, 128, 256)
"s" suffix: Used to denote when the SignRotate script is used to make the lanterns sway
EXAMPLES: AB_light@_Lichen032, AB_light_ComCandleBlck01_128, AB_light_Glyph256

LOCK

AB_Lock_Set-Name-Descriptor(s)-#

EXAMPLES: None yet

MISC

AB_(OBJECT TYPE)_Set-Name-Descriptor(s)-#

OBJECT TYPE: Key, Misc, Mus
EXAMPLES: AB_Misc_BkRuinedFolio, AB_Misc_ComPewterBowl01, ABtv_Key_AryonKeyring, AB_Mus_DeLyre

NPC_

AB_Set-Name-Descriptor(s)-#

Set: in the case of NPCs, "set" can refer to any number of things: faction, location, trade, etc; depending on the need. NPCs do not use an "object type".
EXAMPLES: AB_TelvanniGuardF, ABtv_FalviloCrew1, ABtv_TelVosRetainer1

PROB

AB_Probe_Set-Name-Descriptor(s)-#

EXAMPLES: None yet

REPA

AB_Rep_Set-Name-Descriptor(s)-#

EXAMPLES: AB_Rep_GrinderWheel

SCPT

AB_Set-Name-Descriptor(s)-#_s

Set-Name-Descriptor(s)-#: Scripts should generally use names describing the calling object, event, or action. See the examples below.
"s" suffix: all scripts end with this suffix
EXAMPLES: AB_Bellows_s, AB_ShrineAlma_s, ABtv_CenturionGuard_s

SPEL

AB_(OBJECT TYPE)_Set-Name-Descriptor(s)-#_(SPELL SOURCE)

OBJECT TYPE: ab (ability), cu (curse), dis (disease), pwr (power), sp (spell), trap (trap)
SPELL SOURCE: a special suffix which can optionally be used to denote the spell source. Useful for example to show when a spell is used by a daedra (_Dae) or creature (_Fau) so that you don't give it to NPCs.
EXAMPLES: AB_ab_EnchantBonus, AB_sp_Poisonbite_Fau, ABtv_trap_Blind

STAT

AB_(OBJECT TYPE)_Set-Name-Descriptor(s)-#

OBJECT TYPES: Ex, Flora, Furn, Fx, In, Mrk, Terr
EXAMPLES: AB_Ex_TelMenhirRooted01, AB_Furn_DngChain, AB_In_ImpSmallHallNoCeiling, AB_Mrk_Destination, AB_Terr_GlMtPeak01

WEAP

AB_w_Set-Name-Descriptor(s)-#

EXAMPLES: AB_w_CookKnifeBread, AB_w_EggminerHook, AB_w_ToolPitchfork

OTHER

AB_Set-Name-Descriptor(s)-#

Set-Name-Descriptor(s)-#: If it is not mentioned above, then it is most likely used without any OBJECT TYPE in the ID (e.g. classes, factions, globals, sounds, race, region, etc)