diff --git a/Docs/Luadoc/LuaDocumentation.xml b/Docs/Luadoc/LuaDocumentation.xml index 16ecf5b6dc..4671a149b1 100644 --- a/Docs/Luadoc/LuaDocumentation.xml +++ b/Docs/Luadoc/LuaDocumentation.xml @@ -41,6 +41,9 @@ Returns the current day of the year. + + [01 base.lua] "Override Lua's dofile to use our loadfile." + Returns the number passed to the function followed by its suffix ("th", "nd", and so on). @@ -72,9 +75,30 @@ Returns true if Player pn is logged on to a SMOnline server. + + [01 base.lua] "Like ipairs(), but returns only values." + Returns an Actor definition for the actor at sPath. If sPath points to a Lua file, any additional arguments will be passed to that script. + + [02 ActorDef.lua] Loads an actor template. This is the actual core of LoadActor. + + + [02 ActorDef.lua] Loads an actor with params. + + + [01 base.lua] "Override Lua's loadfile to use lua.ReadFile." + + + [02 ActorDef.lua] Load the fallback BGA for the element that is currently being loaded. + + + [02 ActorDef.lua] Loads a font. + + + [02 Sprite.lua] Returns a Sprite with the current song's background. + Returns the current Minute. @@ -87,21 +111,45 @@ Returns Month m as a string. + + [02 ActorDef.lua] + Returns the current second. Converts fSecs to Minutes:Seconds.Milliseconds format. - - Returns a string representing an enum starting from '_'. For example, passing PlayerNumber_P1 to this function will return P1. + + [02 Branches.lua] Determines the correct music/course selection screen to use and returns it. + + + [02 ActorDef.lua] Returns true if a decoration should be shown on the current screen or not. + + + [02 ActorDef.lua] + + + [02 ActorDef.lua] + + + [02 ActorDef.lua] + + + [02 Enum.lua] Returns a string representing an enum starting from '_'. For example, passing PlayerNumber_P1 to this function will return P1. Alias for . + + [01 base.lua] Alias for lua.GetThreadVariable. + Alias for . + + [02 ActorDef.lua] Wraps the children in an ActorFrame. + Returns the current year. @@ -122,7 +170,7 @@ Converts fSecs to Minutes:Seconds.Milliseconds format using two digits for each section except Milliseconds (uses 3). - Converts fSecs to Minutes:Seconds.Milliseconds format using two digits for each section except Minutes (usese 1). + Converts fSecs to Minutes:Seconds.Milliseconds format using two digits for each section except Minutes (uses 1). Converts fSecs to Minutes:Seconds format. @@ -133,14 +181,14 @@ - [CustomSpeedMods] Returns a Lua option row with the custom speed mods defined in SpeedMods.txt. + [03 CustomSpeedMods.lua] Returns a Lua option row with the custom speed mods defined in SpeedMods.txt. - [FileUtils] Reads the file at path and returns its contents. + [04 FileUtils.lua] Reads the file at path and returns its contents. - [FileUtils] Writes buf to the file at path. + [04 FileUtils.lua] Writes buf to the file at path. @@ -279,8 +327,8 @@ Adds zPos to the Actor's current z position. - - Sets the alignment of an Actor, where h and v are in the range 0..1. + + [02 Actor.lua] Sets the alignment of an Actor, where h and v are in the range 0..1. Sets whether or not the Actor should animate. @@ -316,8 +364,14 @@ Makes the Actor bob up and down. Can use to define different bobbing behavior. + + [02 Actor.lua] + + + [02 Actor.lua] + - [Actor.lua] Centers an Actor. + [02 Actor.lua] Centers an Actor. Crops percent of the Actor from the bottom, where percent is in the range 0..1. @@ -373,6 +427,12 @@ Sets the Actor's draworder to iOrder, where larger values display first. + + [02 Actor.lua] (Added in sm-ssc) + + + [02 Actor.lua] + Set the Actor's effect clock to s. @@ -406,8 +466,8 @@ Finishes up an Actor's tween immediately. - - Stretches an Actor to fill the entire screen. + + [02 Actor.lua] Stretches an Actor to fill the entire screen. @@ -461,6 +521,9 @@ [Deprecated] Compatibility alias for the hidden command, which was removed in sm-ssc. Use instead. + + [02 Actor.lua] "Hide if b is true, but don't unhide if b is false." + Set the horizontal alignment of the Actor according to align. See for fractional alignment. @@ -494,6 +557,12 @@ Set the Actor's rotation on the Z axis to fAlign. + + [02 Actor.lua] An alternative version of . + + + [02 Actor.lua] + Scales the Actor to cover a rectangle defined by the four float arguments. @@ -524,6 +593,9 @@ Waits fSeconds before executing the next command. + + [02 Actor.lua] + Tells the Actor to spin. Can use to define different spinning behavior. @@ -577,22 +649,22 @@ - [ProductivityHelpers] Centers an Actor on the X axis. (equivalent to x,SCREEN_CENTER_X) + [03 ProductivityHelpers.lua] Centers an Actor on the X axis. (equivalent to x,SCREEN_CENTER_X) - [ProductivityHelpers] Centers an Actor on the y axis. (equivalent to y,SCREEN_CENTER_Y) + [03 ProductivityHelpers.lua] Centers an Actor on the y axis. (equivalent to y,SCREEN_CENTER_Y) - [ProductivityHelpers] Sets and Actor as a mask destination. + [03 ProductivityHelpers.lua] Sets and Actor as a mask destination. - [ProductivityHelpers] Sets an Actor as a mask source. (Also clears zbuffer; other mask sources need to not clear the zbuffer) + [03 ProductivityHelpers.lua] Sets an Actor as a mask source. (Also clears zbuffer; other mask sources need to not clear the zbuffer) - [ProductivityHelpers] A customized version of pulse that is more appealing for on-beat effects. + [03 ProductivityHelpers.lua] A customized version of pulse that is more appealing for on-beat effects. - [ProductivityHelpers] Sets the x and y location of the Actor in one command. + [03 ProductivityHelpers.lua] Sets the x and y location of the Actor in one command. @@ -620,6 +692,9 @@ Sets if the Actorframe should propagate commands to its children. + + [02 Actor.lua] Propagates a command to the ActorFrame's children. + Runs the commands in cmds on the ActorFrame's children. @@ -781,8 +856,8 @@ Plays the sound. - - Plays the sound on the given player's side. You must set SupportPan = true on load. + + [02 Sound.lua] Plays the sound on the given player's side. You must set SupportPan = true on load. Stops the sound. @@ -842,7 +917,7 @@ Clear all attributes associated with the BitmapText. - [ProductivityHelpers] Sets the diffuse and stroke color of text in one command. + [03 ProductivityHelpers.lua] Sets the diffuse and stroke color of text in one command. Returns the text that is currently set. @@ -857,10 +932,10 @@ Set the maximum width of the unzoomed text to fWidth. If fWidth is 0, then there is no maximum width. - [ProductivityHelpers] Remove any stroke color. + [03 ProductivityHelpers.lua] Remove any stroke color. - [ProductivityHelpers] Alias for setting to false. + [03 ProductivityHelpers.lua] Alias for setting to false. If true, set each character of the text in turn to the rainbow colors in the metrics BitmapText::RainbowColor#. @@ -869,10 +944,10 @@ Set the text to sText. This clears all attributes. - [ProductivityHelpers] Sets text using string.format(sFormat, ...). + [03 ProductivityHelpers.lua] Sets text using string.format(sFormat, ...). - [ProductivityHelpers] Alias for . + [03 ProductivityHelpers.lua] Alias for . Sets the stroke color to c. @@ -2301,8 +2376,8 @@ Returns the Sprite's texture. - - Returns a Frames table consisting of iNumFrames frames lasting for a total of fSeconds seconds. This function is not a member function and should be used as Frames = Sprite.LinearFrames( 5, 2.6 ). + + [02 Sprite.lua] Returns a Frames table consisting of iNumFrames frames lasting for a total of fSeconds seconds. This function is not a member function and should be used as Frames = Sprite.LinearFrames( 5, 2.6 ). If sPath is nil, then unload the texture. Otherwise, load the texture at path sPath. @@ -2313,11 +2388,11 @@ Load the song banner texture at sPath. - - Load the texture for song's background. + + [02 Sprite.lua] Load the texture for song's background. - - Load the texture for song's banner. + + [02 Sprite.lua] Load the texture for song's banner. @@ -2334,14 +2409,14 @@ - - Call RageTexture:loop( bLoop ) on the texture. + + [02 Sprite.lua] Call RageTexture:loop( bLoop ) on the texture. - - Call RageTexture:position( fPos ) on the texture. + + [02 Sprite.lua] Call RageTexture:position( fPos ) on the texture. - - Call RageTexture:rate( fRate ) on the texture. + + [02 Sprite.lua] Call RageTexture:rate( fRate ) on the texture. Scale the Sprite to width fWidth and height fHeight clipping if the dimensions do not match. diff --git a/Docs/credits.txt b/Docs/credits.txt index efadb2103c..6a6f0a6ef5 100644 --- a/Docs/credits.txt +++ b/Docs/credits.txt @@ -38,6 +38,9 @@ Daisuke Master David Santamarķa Rogado (howl) * Various patches (see Changelog_sm-ssc.txt for more details and links) +Kita K. + * sm-ssc default theme music + Macgravel * Orbular noteskin (the kb7 noteskin; not included in private beta wave 1.3) diff --git a/Docs/opensource_simulators.txt b/Docs/opensource_simulators.txt index a278940e2b..90c234ece3 100644 --- a/Docs/opensource_simulators.txt +++ b/Docs/opensource_simulators.txt @@ -11,4 +11,7 @@ pydance [see http://kai.vm.bytemark.co.uk/svn/pydance/trunk/pydance/LICENSE] http://kai.vm.bytemark.co.uk/svn/pydance/trunk/pydance/ be-pachi music [MIT license] -http://x-raise.cjb.net/bpm.html \ No newline at end of file +http://x-raise.cjb.net/bpm.html + +marfitude [GPL license] +http://www.erestar.net/games/marfitude/ \ No newline at end of file