Difference between revisions of "Colors.test"
From ComputerCraft Wiki
m (Fix wrong API name) |
m (Int -> {{type|number}}) |
||
| (One intermediate revision by one other user not shown) | |||
| Line 2: | Line 2: | ||
{{Function | {{Function | ||
|name=colors.test | |name=colors.test | ||
| − | |args= | + | |args={{Type|number}} colors, {{Type|number}} color |
|api=colors | |api=colors | ||
| − | |returns= | + | |returns={{Type|boolean}} whether or not all elements of <var>color</var> are contained in the set <var>colors</var> |
|addon=ComputerCraft | |addon=ComputerCraft | ||
|desc=Tests whether <var>color</var> is contained within <var>colors</var>; <var>color</var> may be a single color or may be a set of colors (in the latter case, <code>true</code> is returned only if <em>all</em> colors in <var>color</var> are contained in <var>colors</var>) | |desc=Tests whether <var>color</var> is contained within <var>colors</var>; <var>color</var> may be a single color or may be a set of colors (in the latter case, <code>true</code> is returned only if <em>all</em> colors in <var>color</var> are contained in <var>colors</var>) | ||
Latest revision as of 00:47, 12 July 2013
 Function colors.test | |
Tests whether color is contained within colors; color may be a single color or may be a set of colors (in the latter case, true is returned only if all colors in color are contained in colors) | |
| Syntax | colors.test(number colors, number color) |
| Returns | boolean whether or not all elements of color are contained in the set colors |
| Part of | ComputerCraft |
| API | colors |
Examples
 Example | |
| Combine white, magenta, and light blue, then check if light blue is within the set | |
| Code |
print(colors.test(colors.combine(colors.white, colors.magenta, colours.lightBlue), colors.lightBlue)) |
| Output | true |
