From b20fe48bbac1693fa586259fc83e3ad7ca39f9c1 Mon Sep 17 00:00:00 2001 From: freem Date: Thu, 11 Sep 2014 17:03:39 -0500 Subject: [PATCH] fix some of the errors in the luadoc; doc returns --- Docs/Luadoc/LuaDocumentation.xml | 52 ++++++++++++++++---------------- 1 file changed, 26 insertions(+), 26 deletions(-) diff --git a/Docs/Luadoc/LuaDocumentation.xml b/Docs/Luadoc/LuaDocumentation.xml index 912176d889..addb2faaa4 100644 --- a/Docs/Luadoc/LuaDocumentation.xml +++ b/Docs/Luadoc/LuaDocumentation.xml @@ -453,7 +453,7 @@ save yourself some time, copy this for undocumented things: [02 Colors.lua] Modifies the saturation of the specified color - + Saves a screenshot. If pn is nil, saves to the machine's Screenshots dir, otherwise saves to the profile's Screenshots dir. Saves as jpg if compress is true, or png if compress is false. The screenshot is signed if sign is true. prefix and suffix are optional strings to add to the beginning and end of the filename.
Returns success and full path of the resulting screenshot. @@ -648,56 +648,56 @@ save yourself some time, copy this for undocumented things: Updates ArrowEffects, which sets current values for Tornado, Invert, and Beat. - + Returns the Y Offset of a note in column iCol at beat fNoteBeat for the provided PlayerState. Y Offset is affected by Speed mods and Accel mods, and impacts most other arrow effects. - + Returns the Y position of a note in column iCol with a Y offset of fYOffset for the provided PlayerState.
fYReverseOffsetPixels is the separation between targets with and without reverse. This argument is optional and will pull defaults from the metrics for [Player] - + Returns the Y offset of a note in column iCol with a Y position of fYPos for the provided PlayerState.
fYReverseOffsetPixels is the separation between targets with and without reverse. This argument is optional and will pull defaults from the metrics for [Player] - + Returns the X position of a note in column iCol with a Y offset of fYOffset for the provided PlayerState. - + Returns the Z position of a note in column iCol with a Y offset of fYOffset for the provided PlayerState. - + Returns the X rotation of a note with a Y offset of fYOffset for the provided PlayerState. - + Returns the Y rotation of a note with a Y offset of fYOffset for the provided PlayerState. - + Returns the Z rotation of a note at beat fNoteBeat for the provided PlayerState.
bIsHoldHead is an optional argument which defaults to false. If true, this function will return 0 if the [ArrowEffects] metric DizzyHoldHeads is false. - + Returns the Z rotation of the receptors for the provided PlayerState. - + Returns the Alpha of a note in column iCol with a Y offset of fYOffset for the provided PlayerState.
fPercentFadeToFail is optional and defaults to -1.
fYReverseOffsetPixels is the separation between targets with and without reverse. This argument is optional and will pull defaults from the metrics for [Player]
fDrawDistanceBeforeTargetsPixels is optional and will pull defaults from the [Player] metric DrawDistanceBeforeTargetsPixels
fFadeInPercentOfDrawFar is optional and will pull defaults from the [NoteField] metric FadeBeforeTargetsPercent
 - + Returns the Glow of a note in column iCol with a Y offset of fYOffset for the provided PlayerState. The arguments are the same as for GetAlpha. - + Returns the brightness of a note at beat fNoteBeat for the provided PlayerState. - + Returns true if any arrow effects for the provided PlayerState require the z buffer. - + Returns the zoom of a note for the provided PlayerState. - + Returns the FrameWidthScale of a hold part with a Y offset of fYOffset for the provided PlayerState.
fOverlappedTime is optional and will default to 0. @@ -755,7 +755,7 @@ save yourself some time, copy this for undocumented things: Tries to read the file at sPath. If successful, it returns the file's contents. If unsuccessful, it returns two values: nil and "error". - + Reports the error through the error reporting system. error_type is the type used for the dialog that is presented, a dialog will not appear for a type the user has chosen to ignore.
error is optional an defaults to "Script error occurred.". error_type is optional and defaults to "LUA_ERROR". @@ -4630,7 +4630,7 @@ save yourself some time, copy this for undocumented things: Returns the StyleType for this Style. - + Returns a table containing the Track, XOffset, and Name of the column. @@ -4645,19 +4645,19 @@ save yourself some time, copy this for undocumented things: - Returns the of the Tap Note. + Returns the of the Tap Note. - Returns the of the Tap Note. + Returns the of the Tap Note. - Returns the of the Tap Note. + Returns the of the Tap Note. - Returns the of the Tap Note. + Returns the of the Tap Note. - Returns the of the Tap Note. Relevant for routine steps. + Returns the of the Tap Note. Relevant for routine steps. Returns the Attack Modifiers of the Tap Note. @@ -4672,12 +4672,12 @@ save yourself some time, copy this for undocumented things: Returns the Hold Duration of the Tap Note in beats. - Returns the of the Tap Note. + Returns the of the Tap Note. - Returns the of the Tap Note. + Returns the of the Tap Note. Returns the TapNotOffset of the Tap Note. @@ -4688,7 +4688,7 @@ save yourself some time, copy this for undocumented things: - Returns the of the Hold Note. + Returns the of the Hold Note. Returns the life of the Hold Note.