Difference between revisions of "Colors.test"
From ComputerCraft Wiki
m (Moved to CAT:APIFunctions) |
m (Corrected mapping from "Boolean" to "Boolean (type)") |
||
| Line 4: | Line 4: | ||
|args=[[int (type)|int]] colors, [[int (type)|int]] color | |args=[[int (type)|int]] colors, [[int (type)|int]] color | ||
|api=color | |api=color | ||
| − | |returns=[[boolean]] whether or not all elements of <var>color</var> are contained in the set <var>colors</var> | + | |returns=[[boolean_(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>) | ||
Revision as of 13:43, 30 November 2012
 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(int colors, int color) |
| Returns | boolean whether or not all elements of color are contained in the set colors |
| Part of | ComputerCraft |
| API | color |
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 |
