Difference between revisions of "Color Lua API"

From Off Grid Wiki
Jump to navigation Jump to search
(Add color lua api documentation)
 
(adding docStart)
Line 1: Line 1:
 +
{{OffGridDocStart}}
 
= Color =
 
= Color =
 
== Description ==
 
== Description ==

Revision as of 16:41, 22 June 2017

Template:OffGridDocStart

Color

Description

Allows quick access to colours matching the Off Grid colour pallette

Functions

RandomColor

Color.RandomColor(alpha)

Expected parameter types

alpha number (optional)

Description: Returns a random color

Returns: Lua Table

Notes: Defaults to full alpha, optionally pass in required alpha

Variables

Clear

Color.Clear

Description:

Preview RGB
1, 1, 1

Black

Color.Black

Description:

Preview RGB
0.094, 0.094, 0.094

DarkGrey

Color.DarkGrey

Description:

Preview RGB
0.345, 0.345, 0.345

Grey

Color.Grey

Description:

Preview RGB
0.722, 0.722, 0.722

LightGrey

Color.LightGrey

Description:

Preview RGB
0.847, 0.847, 0.847

White

Color.White

Description:

Preview RGB
0.972, 0.972, 0.972

Red

Color.Red

Description:

Preview RGB
0.671, 0.275, 0.259

Orange

Color.Orange

Description:

Preview RGB
0.863, 0.589, 0.336

Yellow

Color.Yellow

Description:

Preview RGB
0.969, 0.792, 0.533

Green

Color.Green

Description:

Preview RGB
0.631, 0.71, 0.424

Cyan

Color.Cyan

Description:

Preview RGB
0.525, 0.757, 0.725

Blue

Color.Blue

Description:

Preview RGB
0.486, 0.686, 0.761

Purple

Color.Purple

Description:

Preview RGB
0.729, 0.545, 0.686

Brown

Color.Brown

Description:

Preview RGB
0.631, 0.412, 0.275


Docs last hacked together on: 09/05/2017 12:46