Difference between revisions of "Arw SetColor"
Jump to navigation
Jump to search
(→Usage) |
|||
| (2 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | Assigns the specified color to the arrow contained in an arrow object with the specified ID number | + | Assigns the specified [[:Category:Colors|color]] to the arrow contained in an arrow object with the specified ID number. |
| + | |||
| + | Arw_SetColor returns a value of 0 if the color was successfully assigned, and a value of -2 if the specified object ID number is invalid. | ||
| − | + | == Usage == | |
| − | + | <syntaxhighlight> | |
| − | + | Arw_SetColor(ObjectID, ArrowColor) | |
| − | ObjectID | + | </syntaxhighlight> |
| − | + | == Parameters == | |
| + | :'''ObjectID''' - a numerical expression specifying the object ID number. | ||
| − | The color can be specified by a numerical expression representing an RGB color number or a legacy color value, or by one of 17 base color words. | + | :'''ArrowColor''' - an expression specifying the [[:Category:Colors|color]] of the arrow. |
| + | ::The color can be specified by a numerical expression representing an [[RGB]] color number or a [[LegacyColorValue|legacy color value]], or by one of 17 [[:Category:Colors|base color]] words. | ||
| − | + | == Notes == | |
| − | An object-specific ID number is | + | * An object-specific ID number is assigned by [[Arw_New]], [[Arw_New_s]], [[Arw_New_self]] or [[Arw_New_self_s]] when the arrow object is created. |
| + | * Use [[Arw_GetActive]], [[Arw_GetFirst]] or [[Arw_GetNext]] to get the object-specific ID number of an already created arrow. | ||
| − | == | + | == Examples == |
| − | Assign the color blue to the arrow contained in an arrow object with the ID number of 3: | + | Assign the color [[Blue|blue]] to the arrow contained in an arrow object with the ID number of 3: |
| − | <syntaxhighlight>Value1=Arw_SetColor(3,Blue);</syntaxhighlight> | + | <syntaxhighlight>Value1 = Arw_SetColor(3, Blue);</syntaxhighlight> |
| − | Assign the RGB color 2138336 (Orange) to the arrow contained in an arrow object with the ID number of 3: | + | Assign the [[RGB]] color 2138336 (Orange) to the arrow contained in an arrow object with the ID number of 3: |
| − | <syntaxhighlight>Value1=Arw_SetColor(3,2138336);</syntaxhighlight> | + | <syntaxhighlight>Value1 = Arw_SetColor(3, 2138336);</syntaxhighlight> |
| − | Assign the legacy color 4 (Green) to the arrow contained in an arrow object with the ID number of 3: | + | Assign the [[LegacyColorValue|legacy color]] 4 ([[Green]]) to the arrow contained in an arrow object with the ID number of 3: |
| − | <syntaxhighlight>[LegacyColorValue=True]; | + | <syntaxhighlight>[LegacyColorValue = True]; |
| − | |||
| + | Value1=Arw_SetColor(3, 4);</syntaxhighlight> | ||
[[Category:ArrowDrawing]] | [[Category:ArrowDrawing]] | ||
Latest revision as of 08:32, 19 February 2012
Assigns the specified color to the arrow contained in an arrow object with the specified ID number.
Arw_SetColor returns a value of 0 if the color was successfully assigned, and a value of -2 if the specified object ID number is invalid.
Contents
Usage
Arw_SetColor(ObjectID, ArrowColor)
Parameters
- ObjectID - a numerical expression specifying the object ID number.
- ArrowColor - an expression specifying the color of the arrow.
- The color can be specified by a numerical expression representing an RGB color number or a legacy color value, or by one of 17 base color words.
Notes
- An object-specific ID number is assigned by Arw_New, Arw_New_s, Arw_New_self or Arw_New_self_s when the arrow object is created.
- Use Arw_GetActive, Arw_GetFirst or Arw_GetNext to get the object-specific ID number of an already created arrow.
Examples
Assign the color blue to the arrow contained in an arrow object with the ID number of 3:
Value1 = Arw_SetColor(3, Blue);
Assign the RGB color 2138336 (Orange) to the arrow contained in an arrow object with the ID number of 3:
Value1 = Arw_SetColor(3, 2138336);
Assign the legacy color 4 (Green) to the arrow contained in an arrow object with the ID number of 3:
[LegacyColorValue = True];
Value1=Arw_SetColor(3, 4);
