From cac996607f008a66d9cf79a30cd3bde3ae50f7f3 Mon Sep 17 00:00:00 2001 From: Steve Checkoway Date: Sun, 12 Aug 2007 04:50:56 +0000 Subject: [PATCH] Document ActorSound, Game, and RageSound. --- stepmania/Docs/LuaDocumentation.xml | 30 +++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) diff --git a/stepmania/Docs/LuaDocumentation.xml b/stepmania/Docs/LuaDocumentation.xml index a14845c36e..a5cd0e304e 100644 --- a/stepmania/Docs/LuaDocumentation.xml +++ b/stepmania/Docs/LuaDocumentation.xml @@ -53,6 +53,20 @@ Set the z position of the Actor to zPos. + + + Returns the RageSound that can be played by this Actor. + + + Loads the sound at sPath. + + + Play the sound. + + + Play the sound on the given player's side. You must set SupportPan = true on load. + + Returns the text. @@ -79,6 +93,22 @@ Wrap the unzoomed text at iWidth pixels. If you zoom or zoomx by x and you want the text wrapped at width, then you should use wrapwidthpixels(width/x). + + + Returns the name of the game such as "dance" or "pump". + + + + + Set the value of sProperty to fVal. The supported properties depend on how the associated ActorSound was loaded. + + + Set the pitch to fPitch. The associated ActorSound have SupportsRateChanging = true on load. + + + Set the speed (that is, the rate at which the sound plays) to fSpeed. The associated ActorSound must have SupportsRateChanging = true on load. + + Returns true if a single Player has its NoteField centered.