actions/itgmania212121
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add documentation for a few random Actor functions for examples of using Link.

Browse Source
This commit is contained in:
Steve Checkoway
2007-08-06 00:06:35 +00:00
parent 33634ffcae
commit a6b69f91dd
1 changed files with 28 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
stepmania/Docs/LuaDocumentation.xml
+28 -3
View File
@@ -4,6 +4,19 @@
going to http://tools.decisionsoft.com/schemaValidate/ and using
Lua.xsd for the XML Schema and this file for the XML Instanace. -->
<!-- Using Link:
To add a link to a function in the current class:
<Link function='addx'>See addx()</Link>
To add a link to a function in another class:
<Link class='ActorFrame' function='propogate'>ActorFrame:propogate()</Link>
To add a link to a class:
<Link class='ActorFrame'>ActorFrame</Link>
To add a link to a global function:
<Link class='GLOBAL' function='Basename'>Basename()</Link>
To add a link to an Enum:
<Link class='ENUM' function='CoinMode'>CoinMode</Link> -->
<Documentation xmlns='http://www.stepmania.com' xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance' xsi:schemaLocation='http://www.stepmania.com Lua.xsd'>
<!-- Global functions -->
<GlobalFunctions>
@@ -18,14 +31,26 @@
<!-- Classes -->
<Classes>
<Class name='Actor'>
<Function name='halign' return='void' arguments='fAlign'>
Set the fractional horizontal alignment of the Actor according to fAlign which should be a float in the range 0..1. An alignment of 0 is left aligned while an alignment of 1 is right aligned. See <Link function='horizalign'>horizalign()</Link> for the common case.
</Function>
<Function name='horizalign' return='void' arguments='align'>
Set the horizontal alignment of the Actor according to align which should be one of <Link class='ENUM' function='HorizAlign'>HorizAlign</Link>. See <Link function='halign'>halign()</Link> for fractional alignment.
</Function>
<Function name='valign' return='void' arguments='fAlign'>
Set the fractional vertical alignment of the Actor according to fAlign which should be a float in the range 0..1. An alignment of 0 is top aligned while an alignment of 1 is bottom aligned. See <Link function="vertalign">vertalign</Link> for the common case.
</Function>
<Function name='vertalign' return='void' arguments='align'>
Set the vertical alignment of the Actor according to align which should be one of <Link class="ENUM" function="VertAlign">VertAlign</Link>. See <Link function="valign">valign()</Link> for fractional alignment.
</Function>
<Function name='x' return='void' arguments='xPos'>
Set the x position of the Actor.
Set the x position of the Actor to xPos.
</Function>
<Function name='y' return='void' arguments='yPos'>
Set the y position of the Actor.
Set the y position of the Actor to yPos.
</Function>
<Function name='z' return='void' arguments='zPos'>
Set the z position of the Actor.
Set the z position of the Actor to zPos.
</Function>
</Class>
<Class name='Song'>