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

Document ActorSound, Game, and RageSound.

Browse Source
This commit is contained in:
Steve Checkoway
2007-08-12 04:50:56 +00:00
parent 41988c9b61
commit cac996607f
1 changed files with 30 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
stepmania/Docs/LuaDocumentation.xml
+30
View File
@@ -53,6 +53,20 @@
Set the z position of the Actor to <code>zPos</code>.
</Function>
</Class>
<Class name='ActorSound'>
<Function name='get' return='RageSound' arguments=''>
Returns the <Link class='RageSound'>RageSound</Link> that can be played by this Actor.
</Function>
<Function name='load' return='void' arguments='string sPath'>
Loads the sound at <code>sPath</code>.
</Function>
<Function name='play' return='void' arguments=''>
Play the sound.
</Function>
<Function name='playforplayer' return='void' arguments='PlayerNumber pn'>
Play the sound on the given player's side. You must set <code>SupportPan = true</code> on load.
</Function>
</Class>
<Class name='BitmapText'>
<Function name='GetText' return='string' arguments=''>
Returns the text.
@@ -79,6 +93,22 @@
Wrap the unzoomed text at <code>iWidth</code> pixels. If you <Link class='Actor' function='zoom'>zoom</Link> or <Link class='Actor' function='zoomx'>zoomx</Link> by <code>x</code> and you want the text wrapped at <code>width</code>, then you should use <code>wrapwidthpixels(width/x)</code>.
</Function>
</Class>
<Class name='Game'>
<Function name='GetName' return='string' arguments=''>
Returns the name of the game such as &quot;dance&quot; or &quot;pump&quot;.
</Function>
</Class>
<Class name='RageSound'>
<Function name='SetProperty' return='void' arguments='string sProperty, float fVal'>
Set the value of <code>sProperty</code> to <code>fVal</code>. The supported properties depend on how the associated <Link class='ActorSound'>ActorSound</Link> was loaded.
</Function>
<Function name='pitch' return='void' arguments='float fPitch'>
Set the pitch to <code>fPitch</code>. The associated <Link class='ActorSound'>ActorSound</Link> have <code>SupportsRateChanging = true</code> on load.
</Function>
<Function name='speed' return='void' arguments='float sSpeed'>
Set the speed (that is, the rate at which the sound plays) to <code>fSpeed</code>. The associated <Link class='ActorSound'>ActorSound</Link> must have <code>SupportsRateChanging = true</code> on load.
</Function>
</Class>
<Class name='ScreenGameplay'>
<Function name='Center1Player' return='bool' arguments=''>
Returns <code>true</code> if a single <Link class='Player'>Player</Link> has its NoteField centered.