User Files from TASeditor

Not working

Features

GUI

Sections

Logs

Branch Logs

Old Logs

Printers

How to write a script

require("TAStudioLogger") -- Or navigate with relatives paths to to the folder where TAStudioLogger is
-- Write your loggers below here:

-- Write your printers below here:

InitializeLogger() -- Needed to load files and setting up variables and callbacks

while true do
	
	UpdateLogger() -- Logs values
	
	emu.yield()
end

Adding a logger

• "<addr1>+<addr2>" for adding two values - value1+value2,
• "<addr1>#<addr2>" for multiplying the first value by 256 and then add the second value - value1*256+value2,
• "<addr1>+<addr2>#<addr3>" for adding the first two values, multiplying by 256, then add the third value - (value1+value2)*256+value3

AddLogger("XSpeed", function() return memory.read_s16_le(0x000D56) end)
AddLogger("MidAirFlag", 0x000D7B)
AddLogger("YSpeed", "s16_le@0x000D5A")
AddLogger("XPosition", "u16_le@0x000C29+u8@0x000D61#u8@0x000D50")

Adding a printer

• just a string of the name of one of your Loggers,
  
• a function that takes 'index' as a parameter and returns a number, like:

function(index) return GetBranchLogValue("XPosition", index) end.%%%

• or a shorthand form string like "<shorthand>,<logname>[,<norm>]",
  where 'shorthand' is the function. It can be of the following:
  • "diff" for 'Difference' function, difference to last frame; e.g.: "diff,XVel"
  • "branchval" for 'GetBranchLogValue' function, value from the log in the selected branch; e.g.: "branchval,XVel"
  • "branchdiff" for 'BranchDifference' function, difference to last frame in the selected branch log; e.g.: "branchdiff,XPos"
  • "branchcomp" for 'BranchCompare' function, subtracts the value in the branch log from the current log; e.g.: "branchcomp,XPos"
  • "relbranchcomp" for 'RelativeBranchCompare' function, does BranchCompare, but with marker offsets, if a marker with the same note is found in the branch; e.g.: "relbranchcomp,XPos"
  • "oldval" for 'GetOldLogValue' function, value from previous playback, the values also change from branch loading; e.g.: "oldval,XVel"
  • "olddiff" for 'OldLogDifference' function, difference to last value from the previous playback; e.g.: "olddiff,XPos"
  • "oldcomp" for 'OldLogCompare' function, subtracts the value in the old log from the current log; e.g.: "oldcomp,XPos"

• an number 0xAARRGGBB, a string "#AARRGGBB" expressing a color value or from the predefined Colors table - Colors.white, gray, red, green, blue, yellow, magenta, cyan, orange, purple.
• a table with log values as the key and a color as the value, e.g.:

colortable = { }
colortable[1] = 0xFFE0E0E0
colortable[3] = 0xFFE04090
colortable[8] = 0xFFFF1050

• a function that takes 'value', 'index' as parameters and returns a color, e.g.:

function(value, index) if value == 15 then return Color(index, 0xFF8080FF ) end end

• or the shorthand form string in the form "<condition[,param]>;<function[,params]>;<defaultcolor>". The functions are
  • ColorGradient function, "gradient,<maxvalue>[,<startcolor>][,<endcolor>][,<minvalue>][,<exponent>]"
    for example "gradient,20,0xFFFF0000,0xFF00FF00,1.15,5", use "gradientabs" for absolute values,
  • "table,<tablename>" e.g.: "table,colortable". The table must be global.

• if left out or passed nil as the parameter it displays the value of the 'valueexpression',
• a string that is printed, useful with the conditional expression further down,
• a table with log values as the key and a color as the value, e.g.:

texttable = { }
colortable[1] = "stand"
colortable[3] = "walk"
colortable[8] = "jump"

• a function that takes 'value' as a parameter and 'index' optionally and returns a string, like:

function(value) return value < 15 and "invincible" or "" end

• a shorthand form string in the form of "<condition[,param]>;<function[,param]>"
  • "modform[,param]" to display the log values as <value>/<param>..":"..<value>%<param>. If left out 'param' is 256
  • "modformh[,param]" to display modform as hexadecimal,
  • "modformdh[,param]" to display only the remainder as hexadecimal, those functions have an optional parameter for the divisor, e.g.: "modformh,16"
  • "hex[,param]" to display the value as hexadecimal, with an optional parameter for the size, e.g.: "hex,4".
  • "table,<tablename>" e.g.: "table,exttable". The table must be global.
• or pass in 'false' as a boolean to display no text.

• "onchange" to output when the value from the 'valueexpression' has changed sinced the last frame.
• "when[,param]" to output when the value from the 'valueexpression' is equal to 'param', default 0.
• "whennot[,param]" to output when the value from the 'valueexpression' is not equal to 'param', default 0.
• "whenabove[,param]" to output when the value from the 'valueexpression' is above 'param', default 0.
• "whenbelow[,param]" to output when the value from the 'valueexpression' is below 'param', default 0.

• "when,1;0xFF8040FF;0xFFFFFFFF" colors the cell when the value is 1 otherwise the cell is colored white.
• "whenabove;dmg" prints "dmg" in the cell when the value is above 0.
• "whennot" prints the values from 'valueexpression' when the value is not 0.

AddPrinter("XVel", "XVel", "gradientabs,704,0xFFFF0000,0xFF00FF00,0,1.5", nil, 4)
AddPrinter("dXV", "diff,XSpeed,XSpeed", "whennot;gradient,64,0xFFFF0000,0xFF00FF00,-64;0xFFFFFFFF", "onchange" ,3)
AddPrinter("P1 Y", "WeaponsOnScreen", weaponcolors)

require("TAStudioLogger")

-- Add your loggers. e.g.: AddLogger("XSpeed", function() return memory.read_s8(0x1234) end)
-- Or AddLogger("Grounded", function() return memory.read_u8(0xABCD) & 2 end)

-- Add your printers, e.g.: AddPrinter("XSpd" "XSpeed", function(index, value) return ColorGradient(index, math.abs(value), 100 0xFFFF0000, 0xFF00FF00) end)
-- Or AddPrinter("P1 A", "Grounded", 0xFFE0A3014)

InitializeLogger()

while true do
	
	UpdateLogger() 
	
	-- Add your own usual lua functionality

	emu.frameadvance();
end

• -9f in 3-1 to v3.0
  
• -18f in 3-2 to v3.0
  
• -139f total to v3.0, -988f to published.