search

MathewWi / bizhawk

Automatically exported from code.google.com/p/bizhawk
0 stars 0 forks source link

Add documentation for Lua structures/types (such as Color) #401

Open GoogleCodeExporter opened 9 years ago

GoogleCodeExporter commented 9 years ago 
BizHawk already includes a great built-in list of Lua functions, also available 
online:
http://tasvideos.org/BizHawk/LuaFunctions.html

In "gui" module, many functions receive an argument of type Color. However, 
that type is not documented anywhere. What is the format of Color? A string? An 
integer? Both? Does it support alpha (semi-transparency)? If I supply an 
integer, should it be 0xRRGGBB, 0xRRGGBBAA, or something else?

Of course, I can discover these by trial-and-error, but they should be 
available as end-user documentation.

"Color" is the main example of a structure/type that is not documented, but 
there might be others that I do not know yet.

Original issue reported on code.google.com by denilsonsa on 26 Feb 2015 at 7:07

GoogleCodeExporter commented 9 years ago 
Color like any of the other documented types correspond to equivlant .NET/C# 
variables

Original comment by adeli...@tasvideos.org on 6 Mar 2015 at 12:24

GoogleCodeExporter commented 9 years ago 
Can you or someone document those? I'm thinking that some people who write Lua 
scripts do not touch BizHawk source-code, or might not know .NET/C#.

So far, via trial and error, I noticed Color can be a string (such as "red"), 
or an integer in the format 0xAARRGGBB (alpha=0 means transparent, alpha=0xFF 
means opaque).

Original comment by denilsonsa on 6 Mar 2015 at 12:56