Difference between revisions of "Template:Asfunction"

From Dragon Age Toolset Wiki
Jump to: navigation, search
m (Added includeonly markup, added subheadings)
m (Remarks)
 
Line 53: Line 53:
 
== Remarks ==
 
== Remarks ==
  
ActionScript functions are similar to JavaScript ones.  
+
ActionScript functions are similar to JavaScript ones.  
  
 
A standard asfunction page will have a number of other headers below this template where more detailed and free-form information will be added by editors.
 
A standard asfunction page will have a number of other headers below this template where more detailed and free-form information will be added by editors.

Latest revision as of 23:57, 6 June 2011

The asfunction template is for documenting ActionScript functions used in the GUI.

Usage

{{asfunction
|name = GetValue
|brief = Returns the value with the specified attribute name from the engine
|param1name = a_sAttributeName
|param1desc = The hierarchical attribute name, the meaning of which is defined by the game engine.
.
.
.
|returndesc = The specified value from the game engine, dependent on the specified attribute name.
}}

Remarks

ActionScript functions are similar to JavaScript ones.

A standard asfunction page will have a number of other headers below this template where more detailed and free-form information will be added by editors.

Suggested standard headers include:

__NOTOC__
== Description ==
== Known issues ==
== Examples ==
== See also ==

With others added when and where needed.