Difference between revisions of "How to Post New OBSE Functions"
Jump to navigation
Jump to search
imported>Haama (Added link to v14 functions) |
imported>Qazaaq m (html is the key, don't think you can do that with wiki syntax) |
||
| 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> | |||
<li>Bring up 3 web tabs</li> | |||
:#[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 | |||
:#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>) | |||
<li>Edit both function pages by pressing the Edit button above the dialog box</li> | |||
<li>Copy everything (Ctrl-A followed by Ctrl-C) from the old function page and paste it on the new function page.</li> | |||
<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> | ||
<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. | ||
<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 | ||
<li>*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>)</li> | |||
<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> | ||
<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. | #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</li> | |||
==See Also== | ==See Also== | ||
*<nowiki>[[Link]]</nowiki> | *<nowiki>[[Link]]</nowiki> | ||
<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> | |||
Revision as of 12:27, 18 January 2008
Adding a new OBSE function to the wiki really just needs some cut and paste.
- Bring up 3 web tabs
- OBSE command documentation
- 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., 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)
- Edit both function pages by pressing the Edit button above the dialog box
- Copy everything (Ctrl-A followed by Ctrl-C) from the old function page and paste it on the new function page.
- 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 - Copy the new definition over the old definition on the new wiki page. That is, replace Returns 1 if the Can Corpse Check flag is set on the actor. with Changes the Can Corpse Check flag on the actor.
- Replace the old function with the new function - replace (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.
- 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
'''Example''' if Jauffre.CanCorpseCheck
[[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.