WoWBench/Documentation - Revision history

WoWWiki>Pcj at 19:26, 18 December 2008

2008-12-18T19:26:26Z

WoWWiki>Hobinbot: demoted headings

2007-01-07T17:15:27Z

demoted headings

← Older revision		Revision as of 17:15, 7 January 2007
Line 4:		Line 4:


	= File invocation order =		== File invocation order ==
	<div style="margin-left: 3%;">		<div style="margin-left: 3%;">

Line 34:		Line 34:
	</div>		</div>

	= Brief file descriptions =		== Brief file descriptions ==
	<div style="margin-left: 3%;">		<div style="margin-left: 3%;">

Line 40:		Line 40:


	== api.lua ==		=== api.lua ===
	<div style="margin: 0em 0em 1em 2%;">		<div style="margin: 0em 0em 1em 2%;">
	* Defines the [[World of Warcraft API]] emulation. Large.		* Defines the [[World of Warcraft API]] emulation. Large.
Line 46:		Line 46:
	</div>		</div>

	== blizzardui.toc ==		=== blizzardui.toc ===
	<div style="margin: 0em 0em 1em 2%;">		<div style="margin: 0em 0em 1em 2%;">
	* Pull in files that prepare WoWBench to load Blizzard UI files (FrameXML, AddOns...)		* Pull in files that prepare WoWBench to load Blizzard UI files (FrameXML, AddOns...)
Line 52:		Line 52:
	</div>		</div>

	== classops.lua ==		=== classops.lua ===
	<div style="margin: 0em 0em 1em 2%;">		<div style="margin: 0em 0em 1em 2%;">
	* Basic object class operations: constructing, inheriting...		* Basic object class operations: constructing, inheriting...
Line 59:		Line 59:
	</div>		</div>

	== cmdline.lua ==		=== cmdline.lua ===
	<div style="margin: 0em 0em 1em 2%;">		<div style="margin: 0em 0em 1em 2%;">

Line 67:		Line 67:
	</div>		</div>

	== config.lua ==		=== config.lua ===
	<div style="margin: 0em 0em 1em 2%;">		<div style="margin: 0em 0em 1em 2%;">

Line 81:		Line 81:
	</div>		</div>

	== debugger.lua ==		=== debugger.lua ===
	<div style="margin: 0em 0em 1em 2%;">		<div style="margin: 0em 0em 1em 2%;">

Line 90:		Line 90:
	</div>		</div>

	== uixml.lua ==		=== uixml.lua ===
	<div style="margin: 0em 0em 1em 2%;">		<div style="margin: 0em 0em 1em 2%;">

Line 98:		Line 98:
	</div>		</div>

	== utils.lua ==		=== utils.lua ===
	<div style="margin: 0em 0em 1em 2%;">		<div style="margin: 0em 0em 1em 2%;">

Line 105:		Line 105:
	</div>		</div>

	== widgets.lua ==		=== widgets.lua ===
	<div style="margin: 0em 0em 1em 2%;">		<div style="margin: 0em 0em 1em 2%;">

Line 112:		Line 112:
	</div>		</div>

	== world.lua ==		=== world.lua ===
	<div style="margin: 0em 0em 1em 2%;">		<div style="margin: 0em 0em 1em 2%;">

Line 121:		Line 121:
	</div>		</div>

	== world.toc ==		=== world.toc ===
	<div style="margin: 0em 0em 1em 2%;">		<div style="margin: 0em 0em 1em 2%;">

Line 128:		Line 128:
	</div>		</div>

	== world.xml ==		=== world.xml ===
	<div style="margin: 0em 0em 1em 2%;">		<div style="margin: 0em 0em 1em 2%;">

Line 136:		Line 136:
	</div>		</div>

	== worldcmds.lua ==		=== worldcmds.lua ===
	<div style="margin: 0em 0em 1em 2%;">		<div style="margin: 0em 0em 1em 2%;">

Line 143:		Line 143:
	</div>		</div>

	== worldxml.lua ==		=== worldxml.lua ===
	<div style="margin: 0em 0em 1em 2%;">		<div style="margin: 0em 0em 1em 2%;">

Line 151:		Line 151:
	</div>		</div>

	== wowbench.lua ==		=== wowbench.lua ===
	<div style="margin: 0em 0em 1em 2%;">		<div style="margin: 0em 0em 1em 2%;">

Line 159:		Line 159:
	</div>		</div>

	== xmlparse.lua ==		=== xmlparse.lua ===
	<div style="margin: 0em 0em 1em 2%;">		<div style="margin: 0em 0em 1em 2%;">

Line 171:		Line 171:
	</div>		</div>

	= Function documentation =		== Function documentation ==
	<div style="margin-left: 3%;">		<div style="margin-left: 3%;">

Line 195:		Line 195:
	</div>		</div>

	= See also =		== See also ==
	<div style="margin-left: 3%;">		<div style="margin-left: 3%;">

WoWWiki>Mikk: Safety save.

2006-06-19T23:42:40Z

Safety save.

New page

{{tocright}}

''Can you think of something you'd like to see? Anything that stumped '''you''' at first? Comment at the ''{{discussiontab}}'' page!''

= File invocation order =
<div style="margin-left: 3%;">

* [[#wowbench.lua|wowbench.lua]]

:* [[#config.lua|config.lua]]

:* [[#utils.lua|utils.lua]]
:* [[#debugger.lua|debugger.lua]]
:* [[#api.lua|api.lua]]
:* [[#xmlparse.lua|xmlparse.lua]]
:* [[#cmdline.lua|cmdline.lua]]
:* [[#classops.lua|classops.lua]]
{{spc}}
:* [[#world.toc|world.toc]]
::* [[#world.lua|world.lua]]
::* [[#worldxml.lua|worldxml.lua]]
::* [[#world.xml|world.xml]]
::* [[#worldcmds.lua|worldcmds.lua]]
{{spc}}
:* [[#blizzardui.toc|blizzardui.toc]]
::* [[#uixml.lua|uixml.lua]]
::* [[#widgets.lua|widgets.lua]]
{{spc}}
:* framexml.toc
:* addon .toc:s

</div>

= Brief file descriptions =
<div style="margin-left: 3%;">

Since we're all programmers here, we know to go look in the headers in the files (yep, they're there!), but the below is a brief overview of what the WoWBench source files contain and what they're there for to get you started.

== api.lua ==
<div style="margin: 0em 0em 1em 2%;">
* Defines the [[World of Warcraft API]] emulation. Large.

</div>

== blizzardui.toc ==
<div style="margin: 0em 0em 1em 2%;">
* Pull in files that prepare WoWBench to load Blizzard UI files (FrameXML, AddOns...)

</div>

== classops.lua ==
<div style="margin: 0em 0em 1em 2%;">
* Basic object class operations: constructing, inheriting...
* Also defines WBClass_Base

</div>

== cmdline.lua ==
<div style="margin: 0em 0em 1em 2%;">

* Mostly just defines WOWB_CommandLine() - a general command line parser that can be called with command lists from elsewhere in the code (only really by the main prompt and the debgger)
* Defines a few commands that are always there - quit, exit, direct Lua execution

</div>

== config.lua ==
<div style="margin: 0em 0em 1em 2%;">

Configures WoWBench:
* Path to WoW
* Path to FrameXML
* Account/Character name (for SavedVariables access)
* What Lua compiler to use
* What TOC files to always load
* Various debug settings
* ...

</div>

== debugger.lua ==
<div style="margin: 0em 0em 1em 2%;">

* Command line debugger
* Debug related utility functions
* Functions to register extra information about references (for use in stack/variable dumping)

</div>

== uixml.lua ==
<div style="margin: 0em 0em 1em 2%;">

* Define WOWB_XMLTagInfo[] and WOWB_ROOTXMLTAG for parsing World of Warcraft XML files
: Before uixml.lua is pulled in, these are configured for parsing "world" files by worldxml.lua. In theory, it could all be parsed as arguments to the XML parser, but it gets somewhat clunky since they are used in several functions.

</div>

== utils.lua ==
<div style="margin: 0em 0em 1em 2%;">

* Lots of non-WoW-specific utility functions

</div>

== widgets.lua ==
<div style="margin: 0em 0em 1em 2%;">

* Defines the objects and methods of the [[Widget API]]. Large.

</div>

== world.lua ==
<div style="margin: 0em 0em 1em 2%;">

* Low level functions for interacting with the world (targetting object/units by name, mousing over units/objects, etc)
* Defines WBClass_WorldThing - the base class for everything in [[#world.xml|world.xml]].
* Defines WBClass_Unit, WBClass_Player, WBClass_NPC, WBClass_Object, WBClass_Item

</div>

== world.toc ==
<div style="margin: 0em 0em 1em 2%;">

* Pulls in game world related files. (See the load order graph above).

</div>

== world.xml ==
<div style="margin: 0em 0em 1em 2%;">

* Defines all characters, npcs, objects and items available in the world.
* Also defines a large chunk of the "game engine" functionality for different types of things via the event handlers in the objects

</div>

== worldcmds.lua ==
<div style="margin: 0em 0em 1em 2%;">

* Defines commands available in the main commandline (click, fire, say, etc..). The command structures are used by the command line driver in [[#cmdline.lua|cmdline.lua]].

</div>

== worldxml.lua ==
<div style="margin: 0em 0em 1em 2%;">

* Define WOWB_XMLTagInfo[] and WOWB_ROOTXMLTAG for parsing [[#world.xml|world.xml]].
* See also [[#uixml.lua|uixml.lua]].

</div>

== wowbench.lua ==
<div style="margin: 0em 0em 1em 2%;">

* The head honcho, the big one, the man with the mojo, the .... erhm, where was I...
* The file that calls everything else. Basically does not have a lot of functionality itself; mostly related to getting files loaded. See the load order graph above.

</div>

== xmlparse.lua ==
<div style="margin: 0em 0em 1em 2%;">

* Defines a slightly quirky XML parser:
:* It operates by translating XML to Lua, to avoid several layers of work that magically get handled by the Lua interpreter in the end
:* In the end, the TOC parser function will compile the generated Lua files into a single chunk of compiled Lua, which loads fiendlishly fast.
:* Bastard mutant brainchild of [[User:Mikk|Mikk]]. Blame him. :-)

</div>
</div>

= Function documentation =
<div style="margin-left: 3%;">

All nontrivial functions should have in-source function headers that briefly describes what the function does. Preferably it will also mention when it is getting called if it is a special-purpose function. Example:

<div style="float: left; clear: left;">
---------------------------------------------------------------------
-- function WOWB_DumpVar(var,maxdepth,ind)
--
-- Return contents of a variable as an ascii dump. Will recurse into tables.
-- Will attempt to avoid recursion to back references
-- Will never follow names in config.lua:_DUMPDONTFOLLOW[]
-- Uses plenty of magic set up elsewhere in the code to make more sense of
-- table and function references.
--
-- var: the variable to be dumped
-- maxdepth: maximum recursion depth
-- ind: initial indent string, can be nil or e.g. " "
--
</div><div style="clear:left;"></div>

</div>

= See also =
<div style="margin-left: 3%;">

* [[WoWBench/FAQ]]
* [[WoWBench/Extending]]
* Back to [[WoWBench]]

</div>

[[Category:WoWBench]]