DarthAffe/Artemis
1
0
Fork 0
mirror of https://github.com/Artemis-RGB/Artemis synced 2025-12-12 21:38:38 +00:00
Code Issues Releases Wiki Activity

Updated Layers (markdown)

Robert Beekman 2016-11-03 22:35:17 +01:00
parent 038a5f0911
commit 7af9acbbda
1 changed files with 17 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
Layers.md

@ -1,32 +1,23 @@
Once you've used the Profile variable to get a layer, you can access it's properties and functions.
## Properties
- **Name:** Returns or sets the name of the layer.
- **Enabled:** Returns or sets whether the layer is enabled or not.
- **IsEvent:** Returns or sets whether the layer is an event or not.
- **Parent (read only):** Returns the parent layer of the layer.
- **X:** Returns or sets the X position of the layer.
- **Y:** Returns or sets the Y position of the layer.
- **Width:** Returns or sets the width of the layer.
- **Height:** Returns or sets the height of the layer.
- **Contain:** Returns or sets whether the layer's brush must be contained or not.
- **Opacity:** Returns or sets the opacity of the layer (0.0 to 1.0).
- **AnimationSpeed:** Returns or sets the animation speed of the layer.
- **AnimationProgress:** Returns or sets the animation progress of the layer.
- **BrushType (read only):** Returns brush type of the layer.
- **Brush:** Returns or sets brush of the layer.
### Name
Returns the name of the current profile.
### Enabled
Returns the name of the current profile.
### IsEvent
Returns the name of the current profile.
### Parent
Returns the name of the current profile.
### X
Returns the name of the current profile.
### Y
Returns the name of the current profile.
| Name | Type | Description | Get | Set |
| :---------------- | :-------| :-------------------------------------------------------------------| :--:| :--:|
| Name | string | Returns or sets the name of the layer. | Yes | Yes |
| Enabled | boolean | Returns or sets whether the layer is an event or not. | Yes | Yes |
| IsEvent | boolean | Returns or sets whether the layer is an event or not. | Yes | Yes |
| Parent | layer | Returns the parent layer of the layer. | Yes | No |
| X | int | Returns or sets the X position of the layer. | Yes | Yes |
| Y | int | Returns or sets the Y position of the layer. | Yes | Yes |
| Width | int | Returns or sets the width of the layer. | Yes | Yes |
| Height | int | Returns or sets the height of the layer. | Yes | Yes |
| Contain | boolean | Returns or sets whether the layer's brush must be contained or not. | Yes | Yes |
| Opacity | double | Returns or sets the opacity of the layer (0.0 to 1.0). | Yes | Yes |
| AnimationSpeed | double | Returns or sets the animation speed of the layer. | Yes | Yes |
| AnimationProgress | double | Returns or sets the animation progress of the layer. | Yes | Yes |
| BrushType | string | Returns brush type of the layer. | Yes | No |
| Brush | brush | Returns or sets brush of the layer. | Yes | Yes |
## Functions
### GetLayers
Returns all layers within the profile