Difference between revisions of "How to Post New OBSE Functions"

From the Oblivion ConstructionSet Wiki
Jump to navigation Jump to search
imported>Haama
(Added link to v14 functions)
imported>Haama
(Redid a few bullets (thanks Qazaaq - looked much better and really helped))
 
(One intermediate revision by one other user not shown)
Line 1: Line 1:
Adding a new OBSE function to the wiki really just needs some cut and paste.
Adding a new OBSE function to the wiki really just needs some cut and paste.
 
<ol>
#Bring up 3 web tabs
<li>Bring up 3 web tabs</li>
##[http://obse.silverlock.org/obse_command_doc.html OBSE command documentation]
:#[http://obse.silverlock.org/obse_command_doc.html OBSE command documentation]
##[[:Category:Functions_%28OBSE_v0014%29|An already added v14 function]] (i.e., [[CanCorpseCheck]]) - try to use one that's in the same function type category as the new function
:#[[:Category:Functions_%28OBSE_v0014%29|An already added v14 function]] (i.e., [[CanCorpseCheck]]) - try to use one that's in the same function type category as the new function
##The new page - you can get to the new page by copying the link for the v14 function (i.e., <nowiki>http://cs.elderscrolls.com/constwiki/index.php/CanCorpseCheck</nowiki>), and replacing the old function name with the new function name (i.e., <nowiki>http://cs.elderscrolls.com/constwiki/index.php/SetCorpseCheck</nowiki>)
:#The new page - you can get to the new page by copying the link for the v14 function (i.e., <nowiki>http://cs.elderscrolls.com/constwiki/index.php/CanCorpseCheck</nowiki>), and replacing the old function name with the new function name (i.e., <nowiki>http://cs.elderscrolls.com/constwiki/index.php/SetCorpseCheck</nowiki>)
#Edit both function pages by pressing the Edit button above the dialog box
<li>Edit both function pages by pressing the Edit button above the dialog box</li>
#Copy everything (Ctrl-A followed by Ctrl-C) from the old function page and paste it on the new function page.
<li>Copy everything (Ctrl-A followed by Ctrl-C) from the old function page and paste it on the new function page.</li>
#Find the new function in the '''OBSE commmand documentation''' such as
<li>Find the new function in the '''OBSE commmand documentation''' such as
<pre>SetCanCorpseCheck* - changes the Can Corpse Check flag on the actor
<pre>SetCanCorpseCheck* - changes the Can Corpse Check flag on the actor
         (nothing) reference.SetCanCorpseCheck flag:short actor:ref</pre>
         (nothing) reference.SetCanCorpseCheck flag:short actor:ref</pre></li>
#Copy the new definition over the old definition on the new wiki page. That is, replace
<li>Copy the new definition over the old definition on the new wiki page. That is, replace</li>
  Returns 1 if the Can Corpse Check flag is set on the actor.
  Returns 1 if the Can Corpse Check flag is set on the actor.
with
with
  Changes the Can Corpse Check flag on the actor.
  Changes the Can Corpse Check flag on the actor.
#Replace the old function with the new function - replace
<li>Replace the old function with the new function - replace</li>
  <nowiki>(canCoprseCheck:bool) ''reference''.CanCorpseCheck ''actor:ref''</nowiki>
  <nowiki>(canCoprseCheck:bool) ''reference''.CanCorpseCheck ''actor:ref''</nowiki>
with
with
  (nothing) reference.SetCanCorpseCheck flag:short actor:ref
  (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., <nowiki>''reference''</nowiki>)
*If there are any italics, make sure to add them to the wiki page with a pair of single quotes (i.e., <nowiki>''reference''</nowiki>)
#You can add an example if you'd like. Place it after the function.
<li>You can add an example if you'd like. Place it after the function.</li>
<pre><nowiki>'''Example'''
<pre><nowiki>'''Example'''
if Jauffre.CanCorpseCheck</nowiki></pre>
if Jauffre.CanCorpseCheck</nowiki></pre>
#Include any notes by adding this after the syntax (and example if you added it)
<li>Include any notes by adding this after the syntax (and example if you added it)</li>
  ==Notes==
  ==Notes==
  *Can call on either the specific actor or the base object ID of the actor.
  *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.
<li>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.</li>
#*If there aren't any similar functions, just delete the section
*If there aren't any similar functions, just delete the section
  ==See Also==
  ==See Also==
  *<nowiki>[[Link]]</nowiki>
  *<nowiki>[[Link]]</nowiki>
#Place the function in the correct categories. At the bottom of the page you'll see something like
<li>Place the function in the correct categories. At the bottom of the page you'll see something like</li>
<pre><nowiki>[[Category: Functions]]
<pre><nowiki>[[Category: Functions]]
[[Category: Functions (OBSE)]]
[[Category: Functions (OBSE)]]
Line 36: Line 36:
[[Category: Actor Value Functions (OBSE)]]</nowiki></pre>
[[Category: Actor Value Functions (OBSE)]]</nowiki></pre>
Change the bottom 2 categories to the appropriate category (and its OBSE counterpart). Here's a [[:Category:Function_Types_%28OBSE%29|list of categories]]. Don't hesitate to add new categories, we could use a few more at this point.
Change the bottom 2 categories to the appropriate category (and its OBSE counterpart). Here's a [[:Category:Function_Types_%28OBSE%29|list of categories]]. Don't hesitate to add new categories, we could use a few more at this point.
</ol>

Latest revision as of 01:52, 20 January 2008

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.
  6. Replace the old function with the new function - replace
    7. (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'')
  7. You can add an example if you'd like. Place it after the function.
    8. '''Example'''
if Jauffre.CanCorpseCheck
  8. Include any notes by adding this after the syntax (and example if you added it)
    9. ==Notes== *Can call on either the specific actor or the base object ID of the actor.
  9. 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]]
  10. Place the function in the correct categories. At the bottom of the page you'll see something like
    11. [[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.

Retrieved from "https://cs.uesp.net/w/index.php?title=How_to_Post_New_OBSE_Functions&oldid=28901"