Merge pull request aframevr#2681 from eng1neer/patch-2

Add a note about color type regarding color animations
jmc637 · May 19, 2017 · e915f87 · e915f87
2 parents a73b7cb + e838b4e
commit e915f87
Showing 1 changed file with 1 addition and 1 deletion.
diff --git a/docs/core/component.md b/docs/core/component.md
@@ -144,7 +144,7 @@ types:
 | asset           | For URLs pointing to general assets. Can parse URL out of a string in the form of `url(<url>)`. If the value is an element ID selector (e.g., `#texture`), this property type will call `getElementById` and `getAttribute('src')` to return a URL. The `asset` property type may or may not change to handle XHRs or return MediaElements directly (e.g., `<img>` elements). | ''                       |
 | audio           | Same parsing as the `asset` property type. Will possibly be used by the A-Frame Inspector to present audio assets.                                                                                                                                                                                                                                               | ''                       |
 | boolean         | Parses string to boolean (i.e., `"false"` to false, everything else truthy).                                                                                                                                                                                                                                                                                     | false                    |
-| color           | Currently doesn't do any parsing. Primarily used by the A-Frame Inspector to present a color picker.                                                                                                                                                                                                                                                             | #FFF                     |
+| color           | Currently doesn't do any parsing. Primarily used by the A-Frame Inspector to present a color picker. Also, it is required to use color type for color animations to work.                                                                                                                                                                                                                                                            | #FFF                     |
 | int             | Calls `parseInt` (e.g., `"124.5"` to `124`).                                                                                                                                                                                                                                                                                                                     | 0                        |
 | map             | Same parsing as the `asset` property type. Will possibly be used bt the A-Frame Inspector to present texture assets.                                                                                                                                                                                                                                             | ''                       |
 | model           | Same parsing as the `asset` property type. Will possibly be used bt the A-Frame Inspector to present model assets.                                                                                                                                                                                                                                               | ''                       |