How to Post New OBSE Functions

Adding a new OBSE function to the wiki really just needs some cut and paste.

  1. Bring up 3 web tabs
    1. OBSE command documentation
    2. An already added v14 function (i.e., CanCorpseCheck) - try to use one that's in the same function type category as the new function
    3. The new page - you can get to the new page by copying the link for the v14 function (i.e., http://cs.elderscrolls.com/constwiki/index.php/CanCorpseCheck), and replacing the old function name with the new function name (i.e., http://cs.elderscrolls.com/constwiki/index.php/SetCorpseCheck)
  2. Edit both function pages by pressing the Edit button above the dialog box
  3. Copy everything (Ctrl-A followed by Ctrl-C) from the old function page and paste it on the new function page.
  4. Find the new function in the OBSE commmand documentation such as
    SetCanCorpseCheck* - changes the Can Corpse Check flag on the actor
            (nothing) reference.SetCanCorpseCheck flag:short actor:ref
  5. Copy the new definition over the old definition on the new wiki page. That is, replace
  6. Returns 1 if the Can Corpse Check flag is set on the actor. with Changes the Can Corpse Check flag on the actor.
  7. Replace the old function with the new function - replace
  8. (canCoprseCheck:bool) ''reference''.CanCorpseCheck ''actor:ref'' with (nothing) reference.SetCanCorpseCheck flag:short actor:ref
  • If there are any italics, make sure to add them to the wiki page with a pair of single quotes (i.e., ''reference'')
  • You can add an example if you'd like. Place it after the function.
  • '''Example'''
    if Jauffre.CanCorpseCheck
  • Include any notes by adding this after the syntax (and example if you added it)
  • ==Notes== *Can call on either the specific actor or the base object ID of the actor.
  • Change the See Also links to similar functions. The OBSE command documentation is the best guide for this - similar functions are usually grouped together. Make sure you use a * before each link.
    • If there aren't any similar functions, just delete the section
    ==See Also== *[[Link]]
  • Place the function in the correct categories. At the bottom of the page you'll see something like
  • [[Category: Functions]]
    [[Category: Functions (OBSE)]]
    [[Category: Functions (OBSE v0014)]]
    [[Category: Actor Value Functions]]
    [[Category: Actor Value Functions (OBSE)]]

    Change the bottom 2 categories to the appropriate category (and its OBSE counterpart). Here's a list of categories. Don't hesitate to add new categories, we could use a few more at this point.