summaryrefslogtreecommitdiff
path: root/doc/classes/CanvasItemMaterial.xml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/classes/CanvasItemMaterial.xml')
-rw-r--r--doc/classes/CanvasItemMaterial.xml10
1 files changed, 9 insertions, 1 deletions
diff --git a/doc/classes/CanvasItemMaterial.xml b/doc/classes/CanvasItemMaterial.xml
index 5963e00d9e..e4b719f9c0 100644
--- a/doc/classes/CanvasItemMaterial.xml
+++ b/doc/classes/CanvasItemMaterial.xml
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?>
-<class name="CanvasItemMaterial" inherits="Material" category="Core" version="3.2">
+<class name="CanvasItemMaterial" inherits="Material" version="3.2">
<brief_description>
A material for [CanvasItem]s.
</brief_description>
@@ -18,12 +18,20 @@
The manner in which material reacts to lighting.
</member>
<member name="particles_anim_h_frames" type="int" setter="set_particles_anim_h_frames" getter="get_particles_anim_h_frames">
+ The number of columns in the spritesheet assigned as [Texture] for a [Particles2D] or [CPUParticles2D].
+ [b]Note:[/b] This property is only used and visible in the editor if [member particles_animation] is [code]true[/code].
</member>
<member name="particles_anim_loop" type="bool" setter="set_particles_anim_loop" getter="get_particles_anim_loop">
+ If [code]true[/code], the particles animation will loop.
+ [b]Note:[/b] This property is only used and visible in the editor if [member particles_animation] is [code]true[/code].
</member>
<member name="particles_anim_v_frames" type="int" setter="set_particles_anim_v_frames" getter="get_particles_anim_v_frames">
+ The number of rows in the spritesheet assigned as [Texture] for a [Particles2D] or [CPUParticles2D].
+ [b]Note:[/b] This property is only used and visible in the editor if [member particles_animation] is [code]true[/code].
</member>
<member name="particles_animation" type="bool" setter="set_particles_animation" getter="get_particles_animation" default="false">
+ If [code]true[/code], enable spritesheet-based animation features when assigned to [Particles2D] and [CPUParticles2D] nodes. The [member ParticlesMaterial.anim_speed] or [member CPUParticles2D.anim_speed] should also be set to a positive value for the animation to play.
+ This property (and other [code]particles_anim_*[/code] properties that depend on it) has no effect on other types of nodes.
</member>
</members>
<constants>