12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486 |
- :github_url: hide
- .. DO NOT EDIT THIS FILE!!!
- .. Generated automatically from Godot engine sources.
- .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
- .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ParticleProcessMaterial.xml.
- .. _class_ParticleProcessMaterial:
- ParticleProcessMaterial
- =======================
- **Inherits:** :ref:`Material<class_Material>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
- Holds a particle configuration for :ref:`GPUParticles2D<class_GPUParticles2D>` or :ref:`GPUParticles3D<class_GPUParticles3D>` nodes.
- .. rst-class:: classref-introduction-group
- Description
- -----------
- **ParticleProcessMaterial** defines particle properties and behavior. It is used in the ``process_material`` of the :ref:`GPUParticles2D<class_GPUParticles2D>` and :ref:`GPUParticles3D<class_GPUParticles3D>` nodes. Some of this material's properties are applied to each particle when emitted, while others can have a :ref:`CurveTexture<class_CurveTexture>` or a :ref:`GradientTexture1D<class_GradientTexture1D>` applied to vary numerical or color values over the lifetime of the particle.
- .. rst-class:: classref-reftable-group
- Properties
- ----------
- .. table::
- :widths: auto
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
- | :ref:`Texture2D<class_Texture2D>` | :ref:`alpha_curve<class_ParticleProcessMaterial_property_alpha_curve>` | |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
- | :ref:`Texture2D<class_Texture2D>` | :ref:`angle_curve<class_ParticleProcessMaterial_property_angle_curve>` | |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
- | :ref:`float<class_float>` | :ref:`angle_max<class_ParticleProcessMaterial_property_angle_max>` | ``0.0`` |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
- | :ref:`float<class_float>` | :ref:`angle_min<class_ParticleProcessMaterial_property_angle_min>` | ``0.0`` |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
- | :ref:`Texture2D<class_Texture2D>` | :ref:`angular_velocity_curve<class_ParticleProcessMaterial_property_angular_velocity_curve>` | |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
- | :ref:`float<class_float>` | :ref:`angular_velocity_max<class_ParticleProcessMaterial_property_angular_velocity_max>` | ``0.0`` |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
- | :ref:`float<class_float>` | :ref:`angular_velocity_min<class_ParticleProcessMaterial_property_angular_velocity_min>` | ``0.0`` |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
- | :ref:`Texture2D<class_Texture2D>` | :ref:`anim_offset_curve<class_ParticleProcessMaterial_property_anim_offset_curve>` | |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
- | :ref:`float<class_float>` | :ref:`anim_offset_max<class_ParticleProcessMaterial_property_anim_offset_max>` | ``0.0`` |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
- | :ref:`float<class_float>` | :ref:`anim_offset_min<class_ParticleProcessMaterial_property_anim_offset_min>` | ``0.0`` |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
- | :ref:`Texture2D<class_Texture2D>` | :ref:`anim_speed_curve<class_ParticleProcessMaterial_property_anim_speed_curve>` | |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
- | :ref:`float<class_float>` | :ref:`anim_speed_max<class_ParticleProcessMaterial_property_anim_speed_max>` | ``0.0`` |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
- | :ref:`float<class_float>` | :ref:`anim_speed_min<class_ParticleProcessMaterial_property_anim_speed_min>` | ``0.0`` |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
- | :ref:`bool<class_bool>` | :ref:`attractor_interaction_enabled<class_ParticleProcessMaterial_property_attractor_interaction_enabled>` | ``true`` |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
- | :ref:`float<class_float>` | :ref:`collision_bounce<class_ParticleProcessMaterial_property_collision_bounce>` | |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
- | :ref:`float<class_float>` | :ref:`collision_friction<class_ParticleProcessMaterial_property_collision_friction>` | |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
- | :ref:`CollisionMode<enum_ParticleProcessMaterial_CollisionMode>` | :ref:`collision_mode<class_ParticleProcessMaterial_property_collision_mode>` | ``0`` |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
- | :ref:`bool<class_bool>` | :ref:`collision_use_scale<class_ParticleProcessMaterial_property_collision_use_scale>` | ``false`` |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
- | :ref:`Color<class_Color>` | :ref:`color<class_ParticleProcessMaterial_property_color>` | ``Color(1, 1, 1, 1)`` |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
- | :ref:`Texture2D<class_Texture2D>` | :ref:`color_initial_ramp<class_ParticleProcessMaterial_property_color_initial_ramp>` | |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
- | :ref:`Texture2D<class_Texture2D>` | :ref:`color_ramp<class_ParticleProcessMaterial_property_color_ramp>` | |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
- | :ref:`Texture2D<class_Texture2D>` | :ref:`damping_curve<class_ParticleProcessMaterial_property_damping_curve>` | |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
- | :ref:`float<class_float>` | :ref:`damping_max<class_ParticleProcessMaterial_property_damping_max>` | ``0.0`` |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
- | :ref:`float<class_float>` | :ref:`damping_min<class_ParticleProcessMaterial_property_damping_min>` | ``0.0`` |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
- | :ref:`Vector3<class_Vector3>` | :ref:`direction<class_ParticleProcessMaterial_property_direction>` | ``Vector3(1, 0, 0)`` |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
- | :ref:`Texture2D<class_Texture2D>` | :ref:`directional_velocity_curve<class_ParticleProcessMaterial_property_directional_velocity_curve>` | |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
- | :ref:`float<class_float>` | :ref:`directional_velocity_max<class_ParticleProcessMaterial_property_directional_velocity_max>` | |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
- | :ref:`float<class_float>` | :ref:`directional_velocity_min<class_ParticleProcessMaterial_property_directional_velocity_min>` | |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
- | :ref:`Vector3<class_Vector3>` | :ref:`emission_box_extents<class_ParticleProcessMaterial_property_emission_box_extents>` | |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
- | :ref:`Texture2D<class_Texture2D>` | :ref:`emission_color_texture<class_ParticleProcessMaterial_property_emission_color_texture>` | |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
- | :ref:`Texture2D<class_Texture2D>` | :ref:`emission_curve<class_ParticleProcessMaterial_property_emission_curve>` | |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
- | :ref:`Texture2D<class_Texture2D>` | :ref:`emission_normal_texture<class_ParticleProcessMaterial_property_emission_normal_texture>` | |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
- | :ref:`int<class_int>` | :ref:`emission_point_count<class_ParticleProcessMaterial_property_emission_point_count>` | |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
- | :ref:`Texture2D<class_Texture2D>` | :ref:`emission_point_texture<class_ParticleProcessMaterial_property_emission_point_texture>` | |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
- | :ref:`Vector3<class_Vector3>` | :ref:`emission_ring_axis<class_ParticleProcessMaterial_property_emission_ring_axis>` | |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
- | :ref:`float<class_float>` | :ref:`emission_ring_cone_angle<class_ParticleProcessMaterial_property_emission_ring_cone_angle>` | |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
- | :ref:`float<class_float>` | :ref:`emission_ring_height<class_ParticleProcessMaterial_property_emission_ring_height>` | |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
- | :ref:`float<class_float>` | :ref:`emission_ring_inner_radius<class_ParticleProcessMaterial_property_emission_ring_inner_radius>` | |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
- | :ref:`float<class_float>` | :ref:`emission_ring_radius<class_ParticleProcessMaterial_property_emission_ring_radius>` | |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
- | :ref:`EmissionShape<enum_ParticleProcessMaterial_EmissionShape>` | :ref:`emission_shape<class_ParticleProcessMaterial_property_emission_shape>` | ``0`` |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
- | :ref:`Vector3<class_Vector3>` | :ref:`emission_shape_offset<class_ParticleProcessMaterial_property_emission_shape_offset>` | ``Vector3(0, 0, 0)`` |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
- | :ref:`Vector3<class_Vector3>` | :ref:`emission_shape_scale<class_ParticleProcessMaterial_property_emission_shape_scale>` | ``Vector3(1, 1, 1)`` |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
- | :ref:`float<class_float>` | :ref:`emission_sphere_radius<class_ParticleProcessMaterial_property_emission_sphere_radius>` | |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
- | :ref:`float<class_float>` | :ref:`flatness<class_ParticleProcessMaterial_property_flatness>` | ``0.0`` |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
- | :ref:`Vector3<class_Vector3>` | :ref:`gravity<class_ParticleProcessMaterial_property_gravity>` | ``Vector3(0, -9.8, 0)`` |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
- | :ref:`Texture2D<class_Texture2D>` | :ref:`hue_variation_curve<class_ParticleProcessMaterial_property_hue_variation_curve>` | |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
- | :ref:`float<class_float>` | :ref:`hue_variation_max<class_ParticleProcessMaterial_property_hue_variation_max>` | ``0.0`` |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
- | :ref:`float<class_float>` | :ref:`hue_variation_min<class_ParticleProcessMaterial_property_hue_variation_min>` | ``0.0`` |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
- | :ref:`float<class_float>` | :ref:`inherit_velocity_ratio<class_ParticleProcessMaterial_property_inherit_velocity_ratio>` | ``0.0`` |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
- | :ref:`float<class_float>` | :ref:`initial_velocity_max<class_ParticleProcessMaterial_property_initial_velocity_max>` | ``0.0`` |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
- | :ref:`float<class_float>` | :ref:`initial_velocity_min<class_ParticleProcessMaterial_property_initial_velocity_min>` | ``0.0`` |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
- | :ref:`float<class_float>` | :ref:`lifetime_randomness<class_ParticleProcessMaterial_property_lifetime_randomness>` | ``0.0`` |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
- | :ref:`Texture2D<class_Texture2D>` | :ref:`linear_accel_curve<class_ParticleProcessMaterial_property_linear_accel_curve>` | |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
- | :ref:`float<class_float>` | :ref:`linear_accel_max<class_ParticleProcessMaterial_property_linear_accel_max>` | ``0.0`` |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
- | :ref:`float<class_float>` | :ref:`linear_accel_min<class_ParticleProcessMaterial_property_linear_accel_min>` | ``0.0`` |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
- | :ref:`Texture2D<class_Texture2D>` | :ref:`orbit_velocity_curve<class_ParticleProcessMaterial_property_orbit_velocity_curve>` | |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
- | :ref:`float<class_float>` | :ref:`orbit_velocity_max<class_ParticleProcessMaterial_property_orbit_velocity_max>` | ``0.0`` |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
- | :ref:`float<class_float>` | :ref:`orbit_velocity_min<class_ParticleProcessMaterial_property_orbit_velocity_min>` | ``0.0`` |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
- | :ref:`bool<class_bool>` | :ref:`particle_flag_align_y<class_ParticleProcessMaterial_property_particle_flag_align_y>` | ``false`` |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
- | :ref:`bool<class_bool>` | :ref:`particle_flag_damping_as_friction<class_ParticleProcessMaterial_property_particle_flag_damping_as_friction>` | ``false`` |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
- | :ref:`bool<class_bool>` | :ref:`particle_flag_disable_z<class_ParticleProcessMaterial_property_particle_flag_disable_z>` | ``false`` |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
- | :ref:`bool<class_bool>` | :ref:`particle_flag_rotate_y<class_ParticleProcessMaterial_property_particle_flag_rotate_y>` | ``false`` |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
- | :ref:`Texture2D<class_Texture2D>` | :ref:`radial_accel_curve<class_ParticleProcessMaterial_property_radial_accel_curve>` | |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
- | :ref:`float<class_float>` | :ref:`radial_accel_max<class_ParticleProcessMaterial_property_radial_accel_max>` | ``0.0`` |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
- | :ref:`float<class_float>` | :ref:`radial_accel_min<class_ParticleProcessMaterial_property_radial_accel_min>` | ``0.0`` |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
- | :ref:`Texture2D<class_Texture2D>` | :ref:`radial_velocity_curve<class_ParticleProcessMaterial_property_radial_velocity_curve>` | |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
- | :ref:`float<class_float>` | :ref:`radial_velocity_max<class_ParticleProcessMaterial_property_radial_velocity_max>` | ``0.0`` |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
- | :ref:`float<class_float>` | :ref:`radial_velocity_min<class_ParticleProcessMaterial_property_radial_velocity_min>` | ``0.0`` |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
- | :ref:`Texture2D<class_Texture2D>` | :ref:`scale_curve<class_ParticleProcessMaterial_property_scale_curve>` | |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
- | :ref:`float<class_float>` | :ref:`scale_max<class_ParticleProcessMaterial_property_scale_max>` | ``1.0`` |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
- | :ref:`float<class_float>` | :ref:`scale_min<class_ParticleProcessMaterial_property_scale_min>` | ``1.0`` |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
- | :ref:`Texture2D<class_Texture2D>` | :ref:`scale_over_velocity_curve<class_ParticleProcessMaterial_property_scale_over_velocity_curve>` | |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
- | :ref:`float<class_float>` | :ref:`scale_over_velocity_max<class_ParticleProcessMaterial_property_scale_over_velocity_max>` | ``0.0`` |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
- | :ref:`float<class_float>` | :ref:`scale_over_velocity_min<class_ParticleProcessMaterial_property_scale_over_velocity_min>` | ``0.0`` |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
- | :ref:`float<class_float>` | :ref:`spread<class_ParticleProcessMaterial_property_spread>` | ``45.0`` |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
- | :ref:`int<class_int>` | :ref:`sub_emitter_amount_at_collision<class_ParticleProcessMaterial_property_sub_emitter_amount_at_collision>` | |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
- | :ref:`int<class_int>` | :ref:`sub_emitter_amount_at_end<class_ParticleProcessMaterial_property_sub_emitter_amount_at_end>` | |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
- | :ref:`float<class_float>` | :ref:`sub_emitter_frequency<class_ParticleProcessMaterial_property_sub_emitter_frequency>` | |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
- | :ref:`bool<class_bool>` | :ref:`sub_emitter_keep_velocity<class_ParticleProcessMaterial_property_sub_emitter_keep_velocity>` | ``false`` |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
- | :ref:`SubEmitterMode<enum_ParticleProcessMaterial_SubEmitterMode>` | :ref:`sub_emitter_mode<class_ParticleProcessMaterial_property_sub_emitter_mode>` | ``0`` |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
- | :ref:`Texture2D<class_Texture2D>` | :ref:`tangential_accel_curve<class_ParticleProcessMaterial_property_tangential_accel_curve>` | |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
- | :ref:`float<class_float>` | :ref:`tangential_accel_max<class_ParticleProcessMaterial_property_tangential_accel_max>` | ``0.0`` |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
- | :ref:`float<class_float>` | :ref:`tangential_accel_min<class_ParticleProcessMaterial_property_tangential_accel_min>` | ``0.0`` |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
- | :ref:`bool<class_bool>` | :ref:`turbulence_enabled<class_ParticleProcessMaterial_property_turbulence_enabled>` | ``false`` |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
- | :ref:`float<class_float>` | :ref:`turbulence_influence_max<class_ParticleProcessMaterial_property_turbulence_influence_max>` | ``0.1`` |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
- | :ref:`float<class_float>` | :ref:`turbulence_influence_min<class_ParticleProcessMaterial_property_turbulence_influence_min>` | ``0.1`` |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
- | :ref:`Texture2D<class_Texture2D>` | :ref:`turbulence_influence_over_life<class_ParticleProcessMaterial_property_turbulence_influence_over_life>` | |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
- | :ref:`float<class_float>` | :ref:`turbulence_initial_displacement_max<class_ParticleProcessMaterial_property_turbulence_initial_displacement_max>` | ``0.0`` |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
- | :ref:`float<class_float>` | :ref:`turbulence_initial_displacement_min<class_ParticleProcessMaterial_property_turbulence_initial_displacement_min>` | ``0.0`` |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
- | :ref:`float<class_float>` | :ref:`turbulence_noise_scale<class_ParticleProcessMaterial_property_turbulence_noise_scale>` | ``9.0`` |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
- | :ref:`Vector3<class_Vector3>` | :ref:`turbulence_noise_speed<class_ParticleProcessMaterial_property_turbulence_noise_speed>` | ``Vector3(0, 0, 0)`` |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
- | :ref:`float<class_float>` | :ref:`turbulence_noise_speed_random<class_ParticleProcessMaterial_property_turbulence_noise_speed_random>` | ``0.2`` |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
- | :ref:`float<class_float>` | :ref:`turbulence_noise_strength<class_ParticleProcessMaterial_property_turbulence_noise_strength>` | ``1.0`` |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
- | :ref:`Texture2D<class_Texture2D>` | :ref:`velocity_limit_curve<class_ParticleProcessMaterial_property_velocity_limit_curve>` | |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
- | :ref:`Vector3<class_Vector3>` | :ref:`velocity_pivot<class_ParticleProcessMaterial_property_velocity_pivot>` | ``Vector3(0, 0, 0)`` |
- +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+
- .. rst-class:: classref-reftable-group
- Methods
- -------
- .. table::
- :widths: auto
- +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Vector2<class_Vector2>` | :ref:`get_param<class_ParticleProcessMaterial_method_get_param>`\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`\ ) |const| |
- +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`float<class_float>` | :ref:`get_param_max<class_ParticleProcessMaterial_method_get_param_max>`\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`\ ) |const| |
- +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`float<class_float>` | :ref:`get_param_min<class_ParticleProcessMaterial_method_get_param_min>`\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`\ ) |const| |
- +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Texture2D<class_Texture2D>` | :ref:`get_param_texture<class_ParticleProcessMaterial_method_get_param_texture>`\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`\ ) |const| |
- +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`bool<class_bool>` | :ref:`get_particle_flag<class_ParticleProcessMaterial_method_get_particle_flag>`\ (\ particle_flag\: :ref:`ParticleFlags<enum_ParticleProcessMaterial_ParticleFlags>`\ ) |const| |
- +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | |void| | :ref:`set_param<class_ParticleProcessMaterial_method_set_param>`\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`, value\: :ref:`Vector2<class_Vector2>`\ ) |
- +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | |void| | :ref:`set_param_max<class_ParticleProcessMaterial_method_set_param_max>`\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`, value\: :ref:`float<class_float>`\ ) |
- +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | |void| | :ref:`set_param_min<class_ParticleProcessMaterial_method_set_param_min>`\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`, value\: :ref:`float<class_float>`\ ) |
- +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | |void| | :ref:`set_param_texture<class_ParticleProcessMaterial_method_set_param_texture>`\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`, texture\: :ref:`Texture2D<class_Texture2D>`\ ) |
- +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | |void| | :ref:`set_particle_flag<class_ParticleProcessMaterial_method_set_particle_flag>`\ (\ particle_flag\: :ref:`ParticleFlags<enum_ParticleProcessMaterial_ParticleFlags>`, enable\: :ref:`bool<class_bool>`\ ) |
- +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- .. rst-class:: classref-section-separator
- ----
- .. rst-class:: classref-descriptions-group
- Enumerations
- ------------
- .. _enum_ParticleProcessMaterial_Parameter:
- .. rst-class:: classref-enumeration
- enum **Parameter**: :ref:`๐<enum_ParticleProcessMaterial_Parameter>`
- .. _class_ParticleProcessMaterial_constant_PARAM_INITIAL_LINEAR_VELOCITY:
- .. rst-class:: classref-enumeration-constant
- :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` **PARAM_INITIAL_LINEAR_VELOCITY** = ``0``
- Use with :ref:`set_param_min<class_ParticleProcessMaterial_method_set_param_min>`, :ref:`set_param_max<class_ParticleProcessMaterial_method_set_param_max>`, and :ref:`set_param_texture<class_ParticleProcessMaterial_method_set_param_texture>` to set initial velocity properties.
- .. _class_ParticleProcessMaterial_constant_PARAM_ANGULAR_VELOCITY:
- .. rst-class:: classref-enumeration-constant
- :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` **PARAM_ANGULAR_VELOCITY** = ``1``
- Use with :ref:`set_param_min<class_ParticleProcessMaterial_method_set_param_min>`, :ref:`set_param_max<class_ParticleProcessMaterial_method_set_param_max>`, and :ref:`set_param_texture<class_ParticleProcessMaterial_method_set_param_texture>` to set angular velocity properties.
- .. _class_ParticleProcessMaterial_constant_PARAM_ORBIT_VELOCITY:
- .. rst-class:: classref-enumeration-constant
- :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` **PARAM_ORBIT_VELOCITY** = ``2``
- Use with :ref:`set_param_min<class_ParticleProcessMaterial_method_set_param_min>`, :ref:`set_param_max<class_ParticleProcessMaterial_method_set_param_max>`, and :ref:`set_param_texture<class_ParticleProcessMaterial_method_set_param_texture>` to set orbital velocity properties.
- .. _class_ParticleProcessMaterial_constant_PARAM_LINEAR_ACCEL:
- .. rst-class:: classref-enumeration-constant
- :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` **PARAM_LINEAR_ACCEL** = ``3``
- Use with :ref:`set_param_min<class_ParticleProcessMaterial_method_set_param_min>`, :ref:`set_param_max<class_ParticleProcessMaterial_method_set_param_max>`, and :ref:`set_param_texture<class_ParticleProcessMaterial_method_set_param_texture>` to set linear acceleration properties.
- .. _class_ParticleProcessMaterial_constant_PARAM_RADIAL_ACCEL:
- .. rst-class:: classref-enumeration-constant
- :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` **PARAM_RADIAL_ACCEL** = ``4``
- Use with :ref:`set_param_min<class_ParticleProcessMaterial_method_set_param_min>`, :ref:`set_param_max<class_ParticleProcessMaterial_method_set_param_max>`, and :ref:`set_param_texture<class_ParticleProcessMaterial_method_set_param_texture>` to set radial acceleration properties.
- .. _class_ParticleProcessMaterial_constant_PARAM_TANGENTIAL_ACCEL:
- .. rst-class:: classref-enumeration-constant
- :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` **PARAM_TANGENTIAL_ACCEL** = ``5``
- Use with :ref:`set_param_min<class_ParticleProcessMaterial_method_set_param_min>`, :ref:`set_param_max<class_ParticleProcessMaterial_method_set_param_max>`, and :ref:`set_param_texture<class_ParticleProcessMaterial_method_set_param_texture>` to set tangential acceleration properties.
- .. _class_ParticleProcessMaterial_constant_PARAM_DAMPING:
- .. rst-class:: classref-enumeration-constant
- :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` **PARAM_DAMPING** = ``6``
- Use with :ref:`set_param_min<class_ParticleProcessMaterial_method_set_param_min>`, :ref:`set_param_max<class_ParticleProcessMaterial_method_set_param_max>`, and :ref:`set_param_texture<class_ParticleProcessMaterial_method_set_param_texture>` to set damping properties.
- .. _class_ParticleProcessMaterial_constant_PARAM_ANGLE:
- .. rst-class:: classref-enumeration-constant
- :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` **PARAM_ANGLE** = ``7``
- Use with :ref:`set_param_min<class_ParticleProcessMaterial_method_set_param_min>`, :ref:`set_param_max<class_ParticleProcessMaterial_method_set_param_max>`, and :ref:`set_param_texture<class_ParticleProcessMaterial_method_set_param_texture>` to set angle properties.
- .. _class_ParticleProcessMaterial_constant_PARAM_SCALE:
- .. rst-class:: classref-enumeration-constant
- :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` **PARAM_SCALE** = ``8``
- Use with :ref:`set_param_min<class_ParticleProcessMaterial_method_set_param_min>`, :ref:`set_param_max<class_ParticleProcessMaterial_method_set_param_max>`, and :ref:`set_param_texture<class_ParticleProcessMaterial_method_set_param_texture>` to set scale properties.
- .. _class_ParticleProcessMaterial_constant_PARAM_HUE_VARIATION:
- .. rst-class:: classref-enumeration-constant
- :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` **PARAM_HUE_VARIATION** = ``9``
- Use with :ref:`set_param_min<class_ParticleProcessMaterial_method_set_param_min>`, :ref:`set_param_max<class_ParticleProcessMaterial_method_set_param_max>`, and :ref:`set_param_texture<class_ParticleProcessMaterial_method_set_param_texture>` to set hue variation properties.
- .. _class_ParticleProcessMaterial_constant_PARAM_ANIM_SPEED:
- .. rst-class:: classref-enumeration-constant
- :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` **PARAM_ANIM_SPEED** = ``10``
- Use with :ref:`set_param_min<class_ParticleProcessMaterial_method_set_param_min>`, :ref:`set_param_max<class_ParticleProcessMaterial_method_set_param_max>`, and :ref:`set_param_texture<class_ParticleProcessMaterial_method_set_param_texture>` to set animation speed properties.
- .. _class_ParticleProcessMaterial_constant_PARAM_ANIM_OFFSET:
- .. rst-class:: classref-enumeration-constant
- :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` **PARAM_ANIM_OFFSET** = ``11``
- Use with :ref:`set_param_min<class_ParticleProcessMaterial_method_set_param_min>`, :ref:`set_param_max<class_ParticleProcessMaterial_method_set_param_max>`, and :ref:`set_param_texture<class_ParticleProcessMaterial_method_set_param_texture>` to set animation offset properties.
- .. _class_ParticleProcessMaterial_constant_PARAM_RADIAL_VELOCITY:
- .. rst-class:: classref-enumeration-constant
- :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` **PARAM_RADIAL_VELOCITY** = ``15``
- Use with :ref:`set_param_min<class_ParticleProcessMaterial_method_set_param_min>`, :ref:`set_param_max<class_ParticleProcessMaterial_method_set_param_max>`, and :ref:`set_param_texture<class_ParticleProcessMaterial_method_set_param_texture>` to set radial velocity properties.
- .. _class_ParticleProcessMaterial_constant_PARAM_DIRECTIONAL_VELOCITY:
- .. rst-class:: classref-enumeration-constant
- :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` **PARAM_DIRECTIONAL_VELOCITY** = ``16``
- Use with :ref:`set_param_min<class_ParticleProcessMaterial_method_set_param_min>`, :ref:`set_param_max<class_ParticleProcessMaterial_method_set_param_max>`, and :ref:`set_param_texture<class_ParticleProcessMaterial_method_set_param_texture>` to set directional velocity properties.
- .. _class_ParticleProcessMaterial_constant_PARAM_SCALE_OVER_VELOCITY:
- .. rst-class:: classref-enumeration-constant
- :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` **PARAM_SCALE_OVER_VELOCITY** = ``17``
- Use with :ref:`set_param_min<class_ParticleProcessMaterial_method_set_param_min>`, :ref:`set_param_max<class_ParticleProcessMaterial_method_set_param_max>`, and :ref:`set_param_texture<class_ParticleProcessMaterial_method_set_param_texture>` to set scale over velocity properties.
- .. _class_ParticleProcessMaterial_constant_PARAM_MAX:
- .. rst-class:: classref-enumeration-constant
- :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` **PARAM_MAX** = ``18``
- Represents the size of the :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` enum.
- .. _class_ParticleProcessMaterial_constant_PARAM_TURB_VEL_INFLUENCE:
- .. rst-class:: classref-enumeration-constant
- :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` **PARAM_TURB_VEL_INFLUENCE** = ``13``
- Use with :ref:`set_param_min<class_ParticleProcessMaterial_method_set_param_min>` and :ref:`set_param_max<class_ParticleProcessMaterial_method_set_param_max>` to set the turbulence minimum und maximum influence on each particles velocity.
- .. _class_ParticleProcessMaterial_constant_PARAM_TURB_INIT_DISPLACEMENT:
- .. rst-class:: classref-enumeration-constant
- :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` **PARAM_TURB_INIT_DISPLACEMENT** = ``14``
- Use with :ref:`set_param_min<class_ParticleProcessMaterial_method_set_param_min>` and :ref:`set_param_max<class_ParticleProcessMaterial_method_set_param_max>` to set the turbulence minimum and maximum displacement of the particles spawn position.
- .. _class_ParticleProcessMaterial_constant_PARAM_TURB_INFLUENCE_OVER_LIFE:
- .. rst-class:: classref-enumeration-constant
- :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>` **PARAM_TURB_INFLUENCE_OVER_LIFE** = ``12``
- Use with :ref:`set_param_texture<class_ParticleProcessMaterial_method_set_param_texture>` to set the turbulence influence over the particles life time.
- .. rst-class:: classref-item-separator
- ----
- .. _enum_ParticleProcessMaterial_ParticleFlags:
- .. rst-class:: classref-enumeration
- enum **ParticleFlags**: :ref:`๐<enum_ParticleProcessMaterial_ParticleFlags>`
- .. _class_ParticleProcessMaterial_constant_PARTICLE_FLAG_ALIGN_Y_TO_VELOCITY:
- .. rst-class:: classref-enumeration-constant
- :ref:`ParticleFlags<enum_ParticleProcessMaterial_ParticleFlags>` **PARTICLE_FLAG_ALIGN_Y_TO_VELOCITY** = ``0``
- Use with :ref:`set_particle_flag<class_ParticleProcessMaterial_method_set_particle_flag>` to set :ref:`particle_flag_align_y<class_ParticleProcessMaterial_property_particle_flag_align_y>`.
- .. _class_ParticleProcessMaterial_constant_PARTICLE_FLAG_ROTATE_Y:
- .. rst-class:: classref-enumeration-constant
- :ref:`ParticleFlags<enum_ParticleProcessMaterial_ParticleFlags>` **PARTICLE_FLAG_ROTATE_Y** = ``1``
- Use with :ref:`set_particle_flag<class_ParticleProcessMaterial_method_set_particle_flag>` to set :ref:`particle_flag_rotate_y<class_ParticleProcessMaterial_property_particle_flag_rotate_y>`.
- .. _class_ParticleProcessMaterial_constant_PARTICLE_FLAG_DISABLE_Z:
- .. rst-class:: classref-enumeration-constant
- :ref:`ParticleFlags<enum_ParticleProcessMaterial_ParticleFlags>` **PARTICLE_FLAG_DISABLE_Z** = ``2``
- Use with :ref:`set_particle_flag<class_ParticleProcessMaterial_method_set_particle_flag>` to set :ref:`particle_flag_disable_z<class_ParticleProcessMaterial_property_particle_flag_disable_z>`.
- .. _class_ParticleProcessMaterial_constant_PARTICLE_FLAG_DAMPING_AS_FRICTION:
- .. rst-class:: classref-enumeration-constant
- :ref:`ParticleFlags<enum_ParticleProcessMaterial_ParticleFlags>` **PARTICLE_FLAG_DAMPING_AS_FRICTION** = ``3``
- .. container:: contribute
- There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
- .. _class_ParticleProcessMaterial_constant_PARTICLE_FLAG_MAX:
- .. rst-class:: classref-enumeration-constant
- :ref:`ParticleFlags<enum_ParticleProcessMaterial_ParticleFlags>` **PARTICLE_FLAG_MAX** = ``4``
- Represents the size of the :ref:`ParticleFlags<enum_ParticleProcessMaterial_ParticleFlags>` enum.
- .. rst-class:: classref-item-separator
- ----
- .. _enum_ParticleProcessMaterial_EmissionShape:
- .. rst-class:: classref-enumeration
- enum **EmissionShape**: :ref:`๐<enum_ParticleProcessMaterial_EmissionShape>`
- .. _class_ParticleProcessMaterial_constant_EMISSION_SHAPE_POINT:
- .. rst-class:: classref-enumeration-constant
- :ref:`EmissionShape<enum_ParticleProcessMaterial_EmissionShape>` **EMISSION_SHAPE_POINT** = ``0``
- All particles will be emitted from a single point.
- .. _class_ParticleProcessMaterial_constant_EMISSION_SHAPE_SPHERE:
- .. rst-class:: classref-enumeration-constant
- :ref:`EmissionShape<enum_ParticleProcessMaterial_EmissionShape>` **EMISSION_SHAPE_SPHERE** = ``1``
- Particles will be emitted in the volume of a sphere.
- .. _class_ParticleProcessMaterial_constant_EMISSION_SHAPE_SPHERE_SURFACE:
- .. rst-class:: classref-enumeration-constant
- :ref:`EmissionShape<enum_ParticleProcessMaterial_EmissionShape>` **EMISSION_SHAPE_SPHERE_SURFACE** = ``2``
- Particles will be emitted on the surface of a sphere.
- .. _class_ParticleProcessMaterial_constant_EMISSION_SHAPE_BOX:
- .. rst-class:: classref-enumeration-constant
- :ref:`EmissionShape<enum_ParticleProcessMaterial_EmissionShape>` **EMISSION_SHAPE_BOX** = ``3``
- Particles will be emitted in the volume of a box.
- .. _class_ParticleProcessMaterial_constant_EMISSION_SHAPE_POINTS:
- .. rst-class:: classref-enumeration-constant
- :ref:`EmissionShape<enum_ParticleProcessMaterial_EmissionShape>` **EMISSION_SHAPE_POINTS** = ``4``
- Particles will be emitted at a position determined by sampling a random point on the :ref:`emission_point_texture<class_ParticleProcessMaterial_property_emission_point_texture>`. Particle color will be modulated by :ref:`emission_color_texture<class_ParticleProcessMaterial_property_emission_color_texture>`.
- .. _class_ParticleProcessMaterial_constant_EMISSION_SHAPE_DIRECTED_POINTS:
- .. rst-class:: classref-enumeration-constant
- :ref:`EmissionShape<enum_ParticleProcessMaterial_EmissionShape>` **EMISSION_SHAPE_DIRECTED_POINTS** = ``5``
- Particles will be emitted at a position determined by sampling a random point on the :ref:`emission_point_texture<class_ParticleProcessMaterial_property_emission_point_texture>`. Particle velocity and rotation will be set based on :ref:`emission_normal_texture<class_ParticleProcessMaterial_property_emission_normal_texture>`. Particle color will be modulated by :ref:`emission_color_texture<class_ParticleProcessMaterial_property_emission_color_texture>`.
- .. _class_ParticleProcessMaterial_constant_EMISSION_SHAPE_RING:
- .. rst-class:: classref-enumeration-constant
- :ref:`EmissionShape<enum_ParticleProcessMaterial_EmissionShape>` **EMISSION_SHAPE_RING** = ``6``
- Particles will be emitted in a ring or cylinder.
- .. _class_ParticleProcessMaterial_constant_EMISSION_SHAPE_MAX:
- .. rst-class:: classref-enumeration-constant
- :ref:`EmissionShape<enum_ParticleProcessMaterial_EmissionShape>` **EMISSION_SHAPE_MAX** = ``7``
- Represents the size of the :ref:`EmissionShape<enum_ParticleProcessMaterial_EmissionShape>` enum.
- .. rst-class:: classref-item-separator
- ----
- .. _enum_ParticleProcessMaterial_SubEmitterMode:
- .. rst-class:: classref-enumeration
- enum **SubEmitterMode**: :ref:`๐<enum_ParticleProcessMaterial_SubEmitterMode>`
- .. _class_ParticleProcessMaterial_constant_SUB_EMITTER_DISABLED:
- .. rst-class:: classref-enumeration-constant
- :ref:`SubEmitterMode<enum_ParticleProcessMaterial_SubEmitterMode>` **SUB_EMITTER_DISABLED** = ``0``
- .. container:: contribute
- There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
- .. _class_ParticleProcessMaterial_constant_SUB_EMITTER_CONSTANT:
- .. rst-class:: classref-enumeration-constant
- :ref:`SubEmitterMode<enum_ParticleProcessMaterial_SubEmitterMode>` **SUB_EMITTER_CONSTANT** = ``1``
- .. container:: contribute
- There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
- .. _class_ParticleProcessMaterial_constant_SUB_EMITTER_AT_END:
- .. rst-class:: classref-enumeration-constant
- :ref:`SubEmitterMode<enum_ParticleProcessMaterial_SubEmitterMode>` **SUB_EMITTER_AT_END** = ``2``
- .. container:: contribute
- There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
- .. _class_ParticleProcessMaterial_constant_SUB_EMITTER_AT_COLLISION:
- .. rst-class:: classref-enumeration-constant
- :ref:`SubEmitterMode<enum_ParticleProcessMaterial_SubEmitterMode>` **SUB_EMITTER_AT_COLLISION** = ``3``
- .. container:: contribute
- There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
- .. _class_ParticleProcessMaterial_constant_SUB_EMITTER_MAX:
- .. rst-class:: classref-enumeration-constant
- :ref:`SubEmitterMode<enum_ParticleProcessMaterial_SubEmitterMode>` **SUB_EMITTER_MAX** = ``4``
- Represents the size of the :ref:`SubEmitterMode<enum_ParticleProcessMaterial_SubEmitterMode>` enum.
- .. rst-class:: classref-item-separator
- ----
- .. _enum_ParticleProcessMaterial_CollisionMode:
- .. rst-class:: classref-enumeration
- enum **CollisionMode**: :ref:`๐<enum_ParticleProcessMaterial_CollisionMode>`
- .. _class_ParticleProcessMaterial_constant_COLLISION_DISABLED:
- .. rst-class:: classref-enumeration-constant
- :ref:`CollisionMode<enum_ParticleProcessMaterial_CollisionMode>` **COLLISION_DISABLED** = ``0``
- No collision for particles. Particles will go through :ref:`GPUParticlesCollision3D<class_GPUParticlesCollision3D>` nodes.
- .. _class_ParticleProcessMaterial_constant_COLLISION_RIGID:
- .. rst-class:: classref-enumeration-constant
- :ref:`CollisionMode<enum_ParticleProcessMaterial_CollisionMode>` **COLLISION_RIGID** = ``1``
- :ref:`RigidBody3D<class_RigidBody3D>`-style collision for particles using :ref:`GPUParticlesCollision3D<class_GPUParticlesCollision3D>` nodes.
- .. _class_ParticleProcessMaterial_constant_COLLISION_HIDE_ON_CONTACT:
- .. rst-class:: classref-enumeration-constant
- :ref:`CollisionMode<enum_ParticleProcessMaterial_CollisionMode>` **COLLISION_HIDE_ON_CONTACT** = ``2``
- Hide particles instantly when colliding with a :ref:`GPUParticlesCollision3D<class_GPUParticlesCollision3D>` node. This can be combined with a subemitter that uses the :ref:`COLLISION_RIGID<class_ParticleProcessMaterial_constant_COLLISION_RIGID>` collision mode to "replace" the parent particle with the subemitter on impact.
- .. _class_ParticleProcessMaterial_constant_COLLISION_MAX:
- .. rst-class:: classref-enumeration-constant
- :ref:`CollisionMode<enum_ParticleProcessMaterial_CollisionMode>` **COLLISION_MAX** = ``3``
- Represents the size of the :ref:`CollisionMode<enum_ParticleProcessMaterial_CollisionMode>` enum.
- .. rst-class:: classref-section-separator
- ----
- .. rst-class:: classref-descriptions-group
- Property Descriptions
- ---------------------
- .. _class_ParticleProcessMaterial_property_alpha_curve:
- .. rst-class:: classref-property
- :ref:`Texture2D<class_Texture2D>` **alpha_curve** :ref:`๐<class_ParticleProcessMaterial_property_alpha_curve>`
- .. rst-class:: classref-property-setget
- - |void| **set_alpha_curve**\ (\ value\: :ref:`Texture2D<class_Texture2D>`\ )
- - :ref:`Texture2D<class_Texture2D>` **get_alpha_curve**\ (\ )
- The alpha value of each particle's color will be multiplied by this :ref:`CurveTexture<class_CurveTexture>` over its lifetime.
- \ **Note:** :ref:`alpha_curve<class_ParticleProcessMaterial_property_alpha_curve>` multiplies the particle mesh's vertex colors. To have a visible effect on a :ref:`BaseMaterial3D<class_BaseMaterial3D>`, :ref:`BaseMaterial3D.vertex_color_use_as_albedo<class_BaseMaterial3D_property_vertex_color_use_as_albedo>` *must* be ``true``. For a :ref:`ShaderMaterial<class_ShaderMaterial>`, ``ALBEDO *= COLOR.rgb;`` must be inserted in the shader's ``fragment()`` function. Otherwise, :ref:`alpha_curve<class_ParticleProcessMaterial_property_alpha_curve>` will have no visible effect.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_angle_curve:
- .. rst-class:: classref-property
- :ref:`Texture2D<class_Texture2D>` **angle_curve** :ref:`๐<class_ParticleProcessMaterial_property_angle_curve>`
- .. rst-class:: classref-property-setget
- - |void| **set_param_texture**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`, texture\: :ref:`Texture2D<class_Texture2D>`\ )
- - :ref:`Texture2D<class_Texture2D>` **get_param_texture**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`\ ) |const|
- Each particle's rotation will be animated along this :ref:`CurveTexture<class_CurveTexture>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_angle_max:
- .. rst-class:: classref-property
- :ref:`float<class_float>` **angle_max** = ``0.0`` :ref:`๐<class_ParticleProcessMaterial_property_angle_max>`
- .. rst-class:: classref-property-setget
- - |void| **set_param_max**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`, value\: :ref:`float<class_float>`\ )
- - :ref:`float<class_float>` **get_param_max**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`\ ) |const|
- Maximum initial rotation applied to each particle, in degrees.
- Only applied when :ref:`particle_flag_disable_z<class_ParticleProcessMaterial_property_particle_flag_disable_z>` or :ref:`particle_flag_rotate_y<class_ParticleProcessMaterial_property_particle_flag_rotate_y>` are ``true`` or the :ref:`BaseMaterial3D<class_BaseMaterial3D>` being used to draw the particle is using :ref:`BaseMaterial3D.BILLBOARD_PARTICLES<class_BaseMaterial3D_constant_BILLBOARD_PARTICLES>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_angle_min:
- .. rst-class:: classref-property
- :ref:`float<class_float>` **angle_min** = ``0.0`` :ref:`๐<class_ParticleProcessMaterial_property_angle_min>`
- .. rst-class:: classref-property-setget
- - |void| **set_param_min**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`, value\: :ref:`float<class_float>`\ )
- - :ref:`float<class_float>` **get_param_min**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`\ ) |const|
- Minimum equivalent of :ref:`angle_max<class_ParticleProcessMaterial_property_angle_max>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_angular_velocity_curve:
- .. rst-class:: classref-property
- :ref:`Texture2D<class_Texture2D>` **angular_velocity_curve** :ref:`๐<class_ParticleProcessMaterial_property_angular_velocity_curve>`
- .. rst-class:: classref-property-setget
- - |void| **set_param_texture**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`, texture\: :ref:`Texture2D<class_Texture2D>`\ )
- - :ref:`Texture2D<class_Texture2D>` **get_param_texture**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`\ ) |const|
- Each particle's angular velocity (rotation speed) will vary along this :ref:`CurveTexture<class_CurveTexture>` over its lifetime.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_angular_velocity_max:
- .. rst-class:: classref-property
- :ref:`float<class_float>` **angular_velocity_max** = ``0.0`` :ref:`๐<class_ParticleProcessMaterial_property_angular_velocity_max>`
- .. rst-class:: classref-property-setget
- - |void| **set_param_max**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`, value\: :ref:`float<class_float>`\ )
- - :ref:`float<class_float>` **get_param_max**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`\ ) |const|
- Maximum initial angular velocity (rotation speed) applied to each particle in *degrees* per second.
- Only applied when :ref:`particle_flag_disable_z<class_ParticleProcessMaterial_property_particle_flag_disable_z>` or :ref:`particle_flag_rotate_y<class_ParticleProcessMaterial_property_particle_flag_rotate_y>` are ``true`` or the :ref:`BaseMaterial3D<class_BaseMaterial3D>` being used to draw the particle is using :ref:`BaseMaterial3D.BILLBOARD_PARTICLES<class_BaseMaterial3D_constant_BILLBOARD_PARTICLES>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_angular_velocity_min:
- .. rst-class:: classref-property
- :ref:`float<class_float>` **angular_velocity_min** = ``0.0`` :ref:`๐<class_ParticleProcessMaterial_property_angular_velocity_min>`
- .. rst-class:: classref-property-setget
- - |void| **set_param_min**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`, value\: :ref:`float<class_float>`\ )
- - :ref:`float<class_float>` **get_param_min**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`\ ) |const|
- Minimum equivalent of :ref:`angular_velocity_max<class_ParticleProcessMaterial_property_angular_velocity_max>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_anim_offset_curve:
- .. rst-class:: classref-property
- :ref:`Texture2D<class_Texture2D>` **anim_offset_curve** :ref:`๐<class_ParticleProcessMaterial_property_anim_offset_curve>`
- .. rst-class:: classref-property-setget
- - |void| **set_param_texture**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`, texture\: :ref:`Texture2D<class_Texture2D>`\ )
- - :ref:`Texture2D<class_Texture2D>` **get_param_texture**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`\ ) |const|
- Each particle's animation offset will vary along this :ref:`CurveTexture<class_CurveTexture>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_anim_offset_max:
- .. rst-class:: classref-property
- :ref:`float<class_float>` **anim_offset_max** = ``0.0`` :ref:`๐<class_ParticleProcessMaterial_property_anim_offset_max>`
- .. rst-class:: classref-property-setget
- - |void| **set_param_max**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`, value\: :ref:`float<class_float>`\ )
- - :ref:`float<class_float>` **get_param_max**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`\ ) |const|
- Maximum animation offset that corresponds to frame index in the texture. ``0`` is the first frame, ``1`` is the last one. See :ref:`CanvasItemMaterial.particles_animation<class_CanvasItemMaterial_property_particles_animation>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_anim_offset_min:
- .. rst-class:: classref-property
- :ref:`float<class_float>` **anim_offset_min** = ``0.0`` :ref:`๐<class_ParticleProcessMaterial_property_anim_offset_min>`
- .. rst-class:: classref-property-setget
- - |void| **set_param_min**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`, value\: :ref:`float<class_float>`\ )
- - :ref:`float<class_float>` **get_param_min**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`\ ) |const|
- Minimum equivalent of :ref:`anim_offset_max<class_ParticleProcessMaterial_property_anim_offset_max>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_anim_speed_curve:
- .. rst-class:: classref-property
- :ref:`Texture2D<class_Texture2D>` **anim_speed_curve** :ref:`๐<class_ParticleProcessMaterial_property_anim_speed_curve>`
- .. rst-class:: classref-property-setget
- - |void| **set_param_texture**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`, texture\: :ref:`Texture2D<class_Texture2D>`\ )
- - :ref:`Texture2D<class_Texture2D>` **get_param_texture**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`\ ) |const|
- Each particle's animation speed will vary along this :ref:`CurveTexture<class_CurveTexture>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_anim_speed_max:
- .. rst-class:: classref-property
- :ref:`float<class_float>` **anim_speed_max** = ``0.0`` :ref:`๐<class_ParticleProcessMaterial_property_anim_speed_max>`
- .. rst-class:: classref-property-setget
- - |void| **set_param_max**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`, value\: :ref:`float<class_float>`\ )
- - :ref:`float<class_float>` **get_param_max**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`\ ) |const|
- Maximum particle animation speed. Animation speed of ``1`` means that the particles will make full ``0`` to ``1`` offset cycle during lifetime, ``2`` means ``2`` cycles etc.
- With animation speed greater than ``1``, remember to enable :ref:`CanvasItemMaterial.particles_anim_loop<class_CanvasItemMaterial_property_particles_anim_loop>` property if you want the animation to repeat.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_anim_speed_min:
- .. rst-class:: classref-property
- :ref:`float<class_float>` **anim_speed_min** = ``0.0`` :ref:`๐<class_ParticleProcessMaterial_property_anim_speed_min>`
- .. rst-class:: classref-property-setget
- - |void| **set_param_min**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`, value\: :ref:`float<class_float>`\ )
- - :ref:`float<class_float>` **get_param_min**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`\ ) |const|
- Minimum equivalent of :ref:`anim_speed_max<class_ParticleProcessMaterial_property_anim_speed_max>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_attractor_interaction_enabled:
- .. rst-class:: classref-property
- :ref:`bool<class_bool>` **attractor_interaction_enabled** = ``true`` :ref:`๐<class_ParticleProcessMaterial_property_attractor_interaction_enabled>`
- .. rst-class:: classref-property-setget
- - |void| **set_attractor_interaction_enabled**\ (\ value\: :ref:`bool<class_bool>`\ )
- - :ref:`bool<class_bool>` **is_attractor_interaction_enabled**\ (\ )
- If ``true``, interaction with particle attractors is enabled. In 3D, attraction only occurs within the area defined by the :ref:`GPUParticles3D<class_GPUParticles3D>` node's :ref:`GPUParticles3D.visibility_aabb<class_GPUParticles3D_property_visibility_aabb>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_collision_bounce:
- .. rst-class:: classref-property
- :ref:`float<class_float>` **collision_bounce** :ref:`๐<class_ParticleProcessMaterial_property_collision_bounce>`
- .. rst-class:: classref-property-setget
- - |void| **set_collision_bounce**\ (\ value\: :ref:`float<class_float>`\ )
- - :ref:`float<class_float>` **get_collision_bounce**\ (\ )
- The particles' bounciness. Values range from ``0`` (no bounce) to ``1`` (full bounciness). Only effective if :ref:`collision_mode<class_ParticleProcessMaterial_property_collision_mode>` is :ref:`COLLISION_RIGID<class_ParticleProcessMaterial_constant_COLLISION_RIGID>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_collision_friction:
- .. rst-class:: classref-property
- :ref:`float<class_float>` **collision_friction** :ref:`๐<class_ParticleProcessMaterial_property_collision_friction>`
- .. rst-class:: classref-property-setget
- - |void| **set_collision_friction**\ (\ value\: :ref:`float<class_float>`\ )
- - :ref:`float<class_float>` **get_collision_friction**\ (\ )
- The particles' friction. Values range from ``0`` (frictionless) to ``1`` (maximum friction). Only effective if :ref:`collision_mode<class_ParticleProcessMaterial_property_collision_mode>` is :ref:`COLLISION_RIGID<class_ParticleProcessMaterial_constant_COLLISION_RIGID>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_collision_mode:
- .. rst-class:: classref-property
- :ref:`CollisionMode<enum_ParticleProcessMaterial_CollisionMode>` **collision_mode** = ``0`` :ref:`๐<class_ParticleProcessMaterial_property_collision_mode>`
- .. rst-class:: classref-property-setget
- - |void| **set_collision_mode**\ (\ value\: :ref:`CollisionMode<enum_ParticleProcessMaterial_CollisionMode>`\ )
- - :ref:`CollisionMode<enum_ParticleProcessMaterial_CollisionMode>` **get_collision_mode**\ (\ )
- The particles' collision mode.
- \ **Note:** 3D Particles can only collide with :ref:`GPUParticlesCollision3D<class_GPUParticlesCollision3D>` nodes, not :ref:`PhysicsBody3D<class_PhysicsBody3D>` nodes. To make particles collide with various objects, you can add :ref:`GPUParticlesCollision3D<class_GPUParticlesCollision3D>` nodes as children of :ref:`PhysicsBody3D<class_PhysicsBody3D>` nodes. In 3D, collisions only occur within the area defined by the :ref:`GPUParticles3D<class_GPUParticles3D>` node's :ref:`GPUParticles3D.visibility_aabb<class_GPUParticles3D_property_visibility_aabb>`.
- \ **Note:** 2D Particles can only collide with :ref:`LightOccluder2D<class_LightOccluder2D>` nodes, not :ref:`PhysicsBody2D<class_PhysicsBody2D>` nodes.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_collision_use_scale:
- .. rst-class:: classref-property
- :ref:`bool<class_bool>` **collision_use_scale** = ``false`` :ref:`๐<class_ParticleProcessMaterial_property_collision_use_scale>`
- .. rst-class:: classref-property-setget
- - |void| **set_collision_use_scale**\ (\ value\: :ref:`bool<class_bool>`\ )
- - :ref:`bool<class_bool>` **is_collision_using_scale**\ (\ )
- If ``true``, :ref:`GPUParticles3D.collision_base_size<class_GPUParticles3D_property_collision_base_size>` is multiplied by the particle's effective scale (see :ref:`scale_min<class_ParticleProcessMaterial_property_scale_min>`, :ref:`scale_max<class_ParticleProcessMaterial_property_scale_max>`, :ref:`scale_curve<class_ParticleProcessMaterial_property_scale_curve>`, and :ref:`scale_over_velocity_curve<class_ParticleProcessMaterial_property_scale_over_velocity_curve>`).
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_color:
- .. rst-class:: classref-property
- :ref:`Color<class_Color>` **color** = ``Color(1, 1, 1, 1)`` :ref:`๐<class_ParticleProcessMaterial_property_color>`
- .. rst-class:: classref-property-setget
- - |void| **set_color**\ (\ value\: :ref:`Color<class_Color>`\ )
- - :ref:`Color<class_Color>` **get_color**\ (\ )
- Each particle's initial color. If the :ref:`GPUParticles2D<class_GPUParticles2D>`'s ``texture`` is defined, it will be multiplied by this color.
- \ **Note:** :ref:`color<class_ParticleProcessMaterial_property_color>` multiplies the particle mesh's vertex colors. To have a visible effect on a :ref:`BaseMaterial3D<class_BaseMaterial3D>`, :ref:`BaseMaterial3D.vertex_color_use_as_albedo<class_BaseMaterial3D_property_vertex_color_use_as_albedo>` *must* be ``true``. For a :ref:`ShaderMaterial<class_ShaderMaterial>`, ``ALBEDO *= COLOR.rgb;`` must be inserted in the shader's ``fragment()`` function. Otherwise, :ref:`color<class_ParticleProcessMaterial_property_color>` will have no visible effect.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_color_initial_ramp:
- .. rst-class:: classref-property
- :ref:`Texture2D<class_Texture2D>` **color_initial_ramp** :ref:`๐<class_ParticleProcessMaterial_property_color_initial_ramp>`
- .. rst-class:: classref-property-setget
- - |void| **set_color_initial_ramp**\ (\ value\: :ref:`Texture2D<class_Texture2D>`\ )
- - :ref:`Texture2D<class_Texture2D>` **get_color_initial_ramp**\ (\ )
- Each particle's initial color will vary along this :ref:`GradientTexture1D<class_GradientTexture1D>` (multiplied with :ref:`color<class_ParticleProcessMaterial_property_color>`).
- \ **Note:** :ref:`color_initial_ramp<class_ParticleProcessMaterial_property_color_initial_ramp>` multiplies the particle mesh's vertex colors. To have a visible effect on a :ref:`BaseMaterial3D<class_BaseMaterial3D>`, :ref:`BaseMaterial3D.vertex_color_use_as_albedo<class_BaseMaterial3D_property_vertex_color_use_as_albedo>` *must* be ``true``. For a :ref:`ShaderMaterial<class_ShaderMaterial>`, ``ALBEDO *= COLOR.rgb;`` must be inserted in the shader's ``fragment()`` function. Otherwise, :ref:`color_initial_ramp<class_ParticleProcessMaterial_property_color_initial_ramp>` will have no visible effect.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_color_ramp:
- .. rst-class:: classref-property
- :ref:`Texture2D<class_Texture2D>` **color_ramp** :ref:`๐<class_ParticleProcessMaterial_property_color_ramp>`
- .. rst-class:: classref-property-setget
- - |void| **set_color_ramp**\ (\ value\: :ref:`Texture2D<class_Texture2D>`\ )
- - :ref:`Texture2D<class_Texture2D>` **get_color_ramp**\ (\ )
- Each particle's color will vary along this :ref:`GradientTexture1D<class_GradientTexture1D>` over its lifetime (multiplied with :ref:`color<class_ParticleProcessMaterial_property_color>`).
- \ **Note:** :ref:`color_ramp<class_ParticleProcessMaterial_property_color_ramp>` multiplies the particle mesh's vertex colors. To have a visible effect on a :ref:`BaseMaterial3D<class_BaseMaterial3D>`, :ref:`BaseMaterial3D.vertex_color_use_as_albedo<class_BaseMaterial3D_property_vertex_color_use_as_albedo>` *must* be ``true``. For a :ref:`ShaderMaterial<class_ShaderMaterial>`, ``ALBEDO *= COLOR.rgb;`` must be inserted in the shader's ``fragment()`` function. Otherwise, :ref:`color_ramp<class_ParticleProcessMaterial_property_color_ramp>` will have no visible effect.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_damping_curve:
- .. rst-class:: classref-property
- :ref:`Texture2D<class_Texture2D>` **damping_curve** :ref:`๐<class_ParticleProcessMaterial_property_damping_curve>`
- .. rst-class:: classref-property-setget
- - |void| **set_param_texture**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`, texture\: :ref:`Texture2D<class_Texture2D>`\ )
- - :ref:`Texture2D<class_Texture2D>` **get_param_texture**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`\ ) |const|
- Damping will vary along this :ref:`CurveTexture<class_CurveTexture>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_damping_max:
- .. rst-class:: classref-property
- :ref:`float<class_float>` **damping_max** = ``0.0`` :ref:`๐<class_ParticleProcessMaterial_property_damping_max>`
- .. rst-class:: classref-property-setget
- - |void| **set_param_max**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`, value\: :ref:`float<class_float>`\ )
- - :ref:`float<class_float>` **get_param_max**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`\ ) |const|
- The maximum rate at which particles lose velocity. For example value of ``100`` means that the particle will go from ``100`` velocity to ``0`` in ``1`` second.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_damping_min:
- .. rst-class:: classref-property
- :ref:`float<class_float>` **damping_min** = ``0.0`` :ref:`๐<class_ParticleProcessMaterial_property_damping_min>`
- .. rst-class:: classref-property-setget
- - |void| **set_param_min**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`, value\: :ref:`float<class_float>`\ )
- - :ref:`float<class_float>` **get_param_min**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`\ ) |const|
- Minimum equivalent of :ref:`damping_max<class_ParticleProcessMaterial_property_damping_max>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_direction:
- .. rst-class:: classref-property
- :ref:`Vector3<class_Vector3>` **direction** = ``Vector3(1, 0, 0)`` :ref:`๐<class_ParticleProcessMaterial_property_direction>`
- .. rst-class:: classref-property-setget
- - |void| **set_direction**\ (\ value\: :ref:`Vector3<class_Vector3>`\ )
- - :ref:`Vector3<class_Vector3>` **get_direction**\ (\ )
- Unit vector specifying the particles' emission direction.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_directional_velocity_curve:
- .. rst-class:: classref-property
- :ref:`Texture2D<class_Texture2D>` **directional_velocity_curve** :ref:`๐<class_ParticleProcessMaterial_property_directional_velocity_curve>`
- .. rst-class:: classref-property-setget
- - |void| **set_param_texture**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`, texture\: :ref:`Texture2D<class_Texture2D>`\ )
- - :ref:`Texture2D<class_Texture2D>` **get_param_texture**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`\ ) |const|
- A curve that specifies the velocity along each of the axes of the particle system along its lifetime.
- \ **Note:** Animated velocities will not be affected by damping, use :ref:`velocity_limit_curve<class_ParticleProcessMaterial_property_velocity_limit_curve>` instead.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_directional_velocity_max:
- .. rst-class:: classref-property
- :ref:`float<class_float>` **directional_velocity_max** :ref:`๐<class_ParticleProcessMaterial_property_directional_velocity_max>`
- .. rst-class:: classref-property-setget
- - |void| **set_param_max**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`, value\: :ref:`float<class_float>`\ )
- - :ref:`float<class_float>` **get_param_max**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`\ ) |const|
- Maximum directional velocity value, which is multiplied by :ref:`directional_velocity_curve<class_ParticleProcessMaterial_property_directional_velocity_curve>`.
- \ **Note:** Animated velocities will not be affected by damping, use :ref:`velocity_limit_curve<class_ParticleProcessMaterial_property_velocity_limit_curve>` instead.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_directional_velocity_min:
- .. rst-class:: classref-property
- :ref:`float<class_float>` **directional_velocity_min** :ref:`๐<class_ParticleProcessMaterial_property_directional_velocity_min>`
- .. rst-class:: classref-property-setget
- - |void| **set_param_min**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`, value\: :ref:`float<class_float>`\ )
- - :ref:`float<class_float>` **get_param_min**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`\ ) |const|
- Minimum directional velocity value, which is multiplied by :ref:`directional_velocity_curve<class_ParticleProcessMaterial_property_directional_velocity_curve>`.
- \ **Note:** Animated velocities will not be affected by damping, use :ref:`velocity_limit_curve<class_ParticleProcessMaterial_property_velocity_limit_curve>` instead.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_emission_box_extents:
- .. rst-class:: classref-property
- :ref:`Vector3<class_Vector3>` **emission_box_extents** :ref:`๐<class_ParticleProcessMaterial_property_emission_box_extents>`
- .. rst-class:: classref-property-setget
- - |void| **set_emission_box_extents**\ (\ value\: :ref:`Vector3<class_Vector3>`\ )
- - :ref:`Vector3<class_Vector3>` **get_emission_box_extents**\ (\ )
- The box's extents if :ref:`emission_shape<class_ParticleProcessMaterial_property_emission_shape>` is set to :ref:`EMISSION_SHAPE_BOX<class_ParticleProcessMaterial_constant_EMISSION_SHAPE_BOX>`.
- \ **Note:** :ref:`emission_box_extents<class_ParticleProcessMaterial_property_emission_box_extents>` starts from the center point and applies the X, Y, and Z values in both directions. The size is twice the area of the extents.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_emission_color_texture:
- .. rst-class:: classref-property
- :ref:`Texture2D<class_Texture2D>` **emission_color_texture** :ref:`๐<class_ParticleProcessMaterial_property_emission_color_texture>`
- .. rst-class:: classref-property-setget
- - |void| **set_emission_color_texture**\ (\ value\: :ref:`Texture2D<class_Texture2D>`\ )
- - :ref:`Texture2D<class_Texture2D>` **get_emission_color_texture**\ (\ )
- Particle color will be modulated by color determined by sampling this texture at the same point as the :ref:`emission_point_texture<class_ParticleProcessMaterial_property_emission_point_texture>`.
- \ **Note:** :ref:`emission_color_texture<class_ParticleProcessMaterial_property_emission_color_texture>` multiplies the particle mesh's vertex colors. To have a visible effect on a :ref:`BaseMaterial3D<class_BaseMaterial3D>`, :ref:`BaseMaterial3D.vertex_color_use_as_albedo<class_BaseMaterial3D_property_vertex_color_use_as_albedo>` *must* be ``true``. For a :ref:`ShaderMaterial<class_ShaderMaterial>`, ``ALBEDO *= COLOR.rgb;`` must be inserted in the shader's ``fragment()`` function. Otherwise, :ref:`emission_color_texture<class_ParticleProcessMaterial_property_emission_color_texture>` will have no visible effect.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_emission_curve:
- .. rst-class:: classref-property
- :ref:`Texture2D<class_Texture2D>` **emission_curve** :ref:`๐<class_ParticleProcessMaterial_property_emission_curve>`
- .. rst-class:: classref-property-setget
- - |void| **set_emission_curve**\ (\ value\: :ref:`Texture2D<class_Texture2D>`\ )
- - :ref:`Texture2D<class_Texture2D>` **get_emission_curve**\ (\ )
- Each particle's color will be multiplied by this :ref:`CurveTexture<class_CurveTexture>` over its lifetime.
- \ **Note:** :ref:`emission_curve<class_ParticleProcessMaterial_property_emission_curve>` multiplies the particle mesh's vertex colors. To have a visible effect on a :ref:`BaseMaterial3D<class_BaseMaterial3D>`, :ref:`BaseMaterial3D.vertex_color_use_as_albedo<class_BaseMaterial3D_property_vertex_color_use_as_albedo>` *must* be ``true``. For a :ref:`ShaderMaterial<class_ShaderMaterial>`, ``ALBEDO *= COLOR.rgb;`` must be inserted in the shader's ``fragment()`` function. Otherwise, :ref:`emission_curve<class_ParticleProcessMaterial_property_emission_curve>` will have no visible effect.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_emission_normal_texture:
- .. rst-class:: classref-property
- :ref:`Texture2D<class_Texture2D>` **emission_normal_texture** :ref:`๐<class_ParticleProcessMaterial_property_emission_normal_texture>`
- .. rst-class:: classref-property-setget
- - |void| **set_emission_normal_texture**\ (\ value\: :ref:`Texture2D<class_Texture2D>`\ )
- - :ref:`Texture2D<class_Texture2D>` **get_emission_normal_texture**\ (\ )
- Particle velocity and rotation will be set by sampling this texture at the same point as the :ref:`emission_point_texture<class_ParticleProcessMaterial_property_emission_point_texture>`. Used only in :ref:`EMISSION_SHAPE_DIRECTED_POINTS<class_ParticleProcessMaterial_constant_EMISSION_SHAPE_DIRECTED_POINTS>`. Can be created automatically from mesh or node by selecting "Create Emission Points from Mesh/Node" under the "Particles" tool in the toolbar.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_emission_point_count:
- .. rst-class:: classref-property
- :ref:`int<class_int>` **emission_point_count** :ref:`๐<class_ParticleProcessMaterial_property_emission_point_count>`
- .. rst-class:: classref-property-setget
- - |void| **set_emission_point_count**\ (\ value\: :ref:`int<class_int>`\ )
- - :ref:`int<class_int>` **get_emission_point_count**\ (\ )
- The number of emission points if :ref:`emission_shape<class_ParticleProcessMaterial_property_emission_shape>` is set to :ref:`EMISSION_SHAPE_POINTS<class_ParticleProcessMaterial_constant_EMISSION_SHAPE_POINTS>` or :ref:`EMISSION_SHAPE_DIRECTED_POINTS<class_ParticleProcessMaterial_constant_EMISSION_SHAPE_DIRECTED_POINTS>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_emission_point_texture:
- .. rst-class:: classref-property
- :ref:`Texture2D<class_Texture2D>` **emission_point_texture** :ref:`๐<class_ParticleProcessMaterial_property_emission_point_texture>`
- .. rst-class:: classref-property-setget
- - |void| **set_emission_point_texture**\ (\ value\: :ref:`Texture2D<class_Texture2D>`\ )
- - :ref:`Texture2D<class_Texture2D>` **get_emission_point_texture**\ (\ )
- Particles will be emitted at positions determined by sampling this texture at a random position. Used with :ref:`EMISSION_SHAPE_POINTS<class_ParticleProcessMaterial_constant_EMISSION_SHAPE_POINTS>` and :ref:`EMISSION_SHAPE_DIRECTED_POINTS<class_ParticleProcessMaterial_constant_EMISSION_SHAPE_DIRECTED_POINTS>`. Can be created automatically from mesh or node by selecting "Create Emission Points from Mesh/Node" under the "Particles" tool in the toolbar.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_emission_ring_axis:
- .. rst-class:: classref-property
- :ref:`Vector3<class_Vector3>` **emission_ring_axis** :ref:`๐<class_ParticleProcessMaterial_property_emission_ring_axis>`
- .. rst-class:: classref-property-setget
- - |void| **set_emission_ring_axis**\ (\ value\: :ref:`Vector3<class_Vector3>`\ )
- - :ref:`Vector3<class_Vector3>` **get_emission_ring_axis**\ (\ )
- The axis of the ring when using the emitter :ref:`EMISSION_SHAPE_RING<class_ParticleProcessMaterial_constant_EMISSION_SHAPE_RING>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_emission_ring_cone_angle:
- .. rst-class:: classref-property
- :ref:`float<class_float>` **emission_ring_cone_angle** :ref:`๐<class_ParticleProcessMaterial_property_emission_ring_cone_angle>`
- .. rst-class:: classref-property-setget
- - |void| **set_emission_ring_cone_angle**\ (\ value\: :ref:`float<class_float>`\ )
- - :ref:`float<class_float>` **get_emission_ring_cone_angle**\ (\ )
- The angle of the cone when using the emitter :ref:`EMISSION_SHAPE_RING<class_ParticleProcessMaterial_constant_EMISSION_SHAPE_RING>`. The default angle of 90 degrees results in a ring, while an angle of 0 degrees results in a cone. Intermediate values will result in a ring where one end is larger than the other.
- \ **Note:** Depending on :ref:`emission_ring_height<class_ParticleProcessMaterial_property_emission_ring_height>`, the angle may be clamped if the ring's end is reached to form a perfect cone.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_emission_ring_height:
- .. rst-class:: classref-property
- :ref:`float<class_float>` **emission_ring_height** :ref:`๐<class_ParticleProcessMaterial_property_emission_ring_height>`
- .. rst-class:: classref-property-setget
- - |void| **set_emission_ring_height**\ (\ value\: :ref:`float<class_float>`\ )
- - :ref:`float<class_float>` **get_emission_ring_height**\ (\ )
- The height of the ring when using the emitter :ref:`EMISSION_SHAPE_RING<class_ParticleProcessMaterial_constant_EMISSION_SHAPE_RING>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_emission_ring_inner_radius:
- .. rst-class:: classref-property
- :ref:`float<class_float>` **emission_ring_inner_radius** :ref:`๐<class_ParticleProcessMaterial_property_emission_ring_inner_radius>`
- .. rst-class:: classref-property-setget
- - |void| **set_emission_ring_inner_radius**\ (\ value\: :ref:`float<class_float>`\ )
- - :ref:`float<class_float>` **get_emission_ring_inner_radius**\ (\ )
- The inner radius of the ring when using the emitter :ref:`EMISSION_SHAPE_RING<class_ParticleProcessMaterial_constant_EMISSION_SHAPE_RING>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_emission_ring_radius:
- .. rst-class:: classref-property
- :ref:`float<class_float>` **emission_ring_radius** :ref:`๐<class_ParticleProcessMaterial_property_emission_ring_radius>`
- .. rst-class:: classref-property-setget
- - |void| **set_emission_ring_radius**\ (\ value\: :ref:`float<class_float>`\ )
- - :ref:`float<class_float>` **get_emission_ring_radius**\ (\ )
- The radius of the ring when using the emitter :ref:`EMISSION_SHAPE_RING<class_ParticleProcessMaterial_constant_EMISSION_SHAPE_RING>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_emission_shape:
- .. rst-class:: classref-property
- :ref:`EmissionShape<enum_ParticleProcessMaterial_EmissionShape>` **emission_shape** = ``0`` :ref:`๐<class_ParticleProcessMaterial_property_emission_shape>`
- .. rst-class:: classref-property-setget
- - |void| **set_emission_shape**\ (\ value\: :ref:`EmissionShape<enum_ParticleProcessMaterial_EmissionShape>`\ )
- - :ref:`EmissionShape<enum_ParticleProcessMaterial_EmissionShape>` **get_emission_shape**\ (\ )
- Particles will be emitted inside this region. Use :ref:`EmissionShape<enum_ParticleProcessMaterial_EmissionShape>` constants for values.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_emission_shape_offset:
- .. rst-class:: classref-property
- :ref:`Vector3<class_Vector3>` **emission_shape_offset** = ``Vector3(0, 0, 0)`` :ref:`๐<class_ParticleProcessMaterial_property_emission_shape_offset>`
- .. rst-class:: classref-property-setget
- - |void| **set_emission_shape_offset**\ (\ value\: :ref:`Vector3<class_Vector3>`\ )
- - :ref:`Vector3<class_Vector3>` **get_emission_shape_offset**\ (\ )
- The offset for the :ref:`emission_shape<class_ParticleProcessMaterial_property_emission_shape>`, in local space.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_emission_shape_scale:
- .. rst-class:: classref-property
- :ref:`Vector3<class_Vector3>` **emission_shape_scale** = ``Vector3(1, 1, 1)`` :ref:`๐<class_ParticleProcessMaterial_property_emission_shape_scale>`
- .. rst-class:: classref-property-setget
- - |void| **set_emission_shape_scale**\ (\ value\: :ref:`Vector3<class_Vector3>`\ )
- - :ref:`Vector3<class_Vector3>` **get_emission_shape_scale**\ (\ )
- The scale of the :ref:`emission_shape<class_ParticleProcessMaterial_property_emission_shape>`, in local space.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_emission_sphere_radius:
- .. rst-class:: classref-property
- :ref:`float<class_float>` **emission_sphere_radius** :ref:`๐<class_ParticleProcessMaterial_property_emission_sphere_radius>`
- .. rst-class:: classref-property-setget
- - |void| **set_emission_sphere_radius**\ (\ value\: :ref:`float<class_float>`\ )
- - :ref:`float<class_float>` **get_emission_sphere_radius**\ (\ )
- The sphere's radius if :ref:`emission_shape<class_ParticleProcessMaterial_property_emission_shape>` is set to :ref:`EMISSION_SHAPE_SPHERE<class_ParticleProcessMaterial_constant_EMISSION_SHAPE_SPHERE>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_flatness:
- .. rst-class:: classref-property
- :ref:`float<class_float>` **flatness** = ``0.0`` :ref:`๐<class_ParticleProcessMaterial_property_flatness>`
- .. rst-class:: classref-property-setget
- - |void| **set_flatness**\ (\ value\: :ref:`float<class_float>`\ )
- - :ref:`float<class_float>` **get_flatness**\ (\ )
- Amount of :ref:`spread<class_ParticleProcessMaterial_property_spread>` along the Y axis.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_gravity:
- .. rst-class:: classref-property
- :ref:`Vector3<class_Vector3>` **gravity** = ``Vector3(0, -9.8, 0)`` :ref:`๐<class_ParticleProcessMaterial_property_gravity>`
- .. rst-class:: classref-property-setget
- - |void| **set_gravity**\ (\ value\: :ref:`Vector3<class_Vector3>`\ )
- - :ref:`Vector3<class_Vector3>` **get_gravity**\ (\ )
- Gravity applied to every particle.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_hue_variation_curve:
- .. rst-class:: classref-property
- :ref:`Texture2D<class_Texture2D>` **hue_variation_curve** :ref:`๐<class_ParticleProcessMaterial_property_hue_variation_curve>`
- .. rst-class:: classref-property-setget
- - |void| **set_param_texture**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`, texture\: :ref:`Texture2D<class_Texture2D>`\ )
- - :ref:`Texture2D<class_Texture2D>` **get_param_texture**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`\ ) |const|
- Each particle's hue will vary along this :ref:`CurveTexture<class_CurveTexture>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_hue_variation_max:
- .. rst-class:: classref-property
- :ref:`float<class_float>` **hue_variation_max** = ``0.0`` :ref:`๐<class_ParticleProcessMaterial_property_hue_variation_max>`
- .. rst-class:: classref-property-setget
- - |void| **set_param_max**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`, value\: :ref:`float<class_float>`\ )
- - :ref:`float<class_float>` **get_param_max**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`\ ) |const|
- Maximum initial hue variation applied to each particle. It will shift the particle color's hue.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_hue_variation_min:
- .. rst-class:: classref-property
- :ref:`float<class_float>` **hue_variation_min** = ``0.0`` :ref:`๐<class_ParticleProcessMaterial_property_hue_variation_min>`
- .. rst-class:: classref-property-setget
- - |void| **set_param_min**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`, value\: :ref:`float<class_float>`\ )
- - :ref:`float<class_float>` **get_param_min**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`\ ) |const|
- Minimum equivalent of :ref:`hue_variation_max<class_ParticleProcessMaterial_property_hue_variation_max>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_inherit_velocity_ratio:
- .. rst-class:: classref-property
- :ref:`float<class_float>` **inherit_velocity_ratio** = ``0.0`` :ref:`๐<class_ParticleProcessMaterial_property_inherit_velocity_ratio>`
- .. rst-class:: classref-property-setget
- - |void| **set_inherit_velocity_ratio**\ (\ value\: :ref:`float<class_float>`\ )
- - :ref:`float<class_float>` **get_inherit_velocity_ratio**\ (\ )
- Percentage of the velocity of the respective :ref:`GPUParticles2D<class_GPUParticles2D>` or :ref:`GPUParticles3D<class_GPUParticles3D>` inherited by each particle when spawning.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_initial_velocity_max:
- .. rst-class:: classref-property
- :ref:`float<class_float>` **initial_velocity_max** = ``0.0`` :ref:`๐<class_ParticleProcessMaterial_property_initial_velocity_max>`
- .. rst-class:: classref-property-setget
- - |void| **set_param_max**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`, value\: :ref:`float<class_float>`\ )
- - :ref:`float<class_float>` **get_param_max**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`\ ) |const|
- Maximum initial velocity magnitude for each particle. Direction comes from :ref:`direction<class_ParticleProcessMaterial_property_direction>` and :ref:`spread<class_ParticleProcessMaterial_property_spread>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_initial_velocity_min:
- .. rst-class:: classref-property
- :ref:`float<class_float>` **initial_velocity_min** = ``0.0`` :ref:`๐<class_ParticleProcessMaterial_property_initial_velocity_min>`
- .. rst-class:: classref-property-setget
- - |void| **set_param_min**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`, value\: :ref:`float<class_float>`\ )
- - :ref:`float<class_float>` **get_param_min**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`\ ) |const|
- Minimum equivalent of :ref:`initial_velocity_max<class_ParticleProcessMaterial_property_initial_velocity_max>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_lifetime_randomness:
- .. rst-class:: classref-property
- :ref:`float<class_float>` **lifetime_randomness** = ``0.0`` :ref:`๐<class_ParticleProcessMaterial_property_lifetime_randomness>`
- .. rst-class:: classref-property-setget
- - |void| **set_lifetime_randomness**\ (\ value\: :ref:`float<class_float>`\ )
- - :ref:`float<class_float>` **get_lifetime_randomness**\ (\ )
- Particle lifetime randomness ratio. The equation for the lifetime of a particle is ``lifetime * (1.0 - randf() * lifetime_randomness)``. For example, a :ref:`lifetime_randomness<class_ParticleProcessMaterial_property_lifetime_randomness>` of ``0.4`` scales the lifetime between ``0.6`` to ``1.0`` of its original value.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_linear_accel_curve:
- .. rst-class:: classref-property
- :ref:`Texture2D<class_Texture2D>` **linear_accel_curve** :ref:`๐<class_ParticleProcessMaterial_property_linear_accel_curve>`
- .. rst-class:: classref-property-setget
- - |void| **set_param_texture**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`, texture\: :ref:`Texture2D<class_Texture2D>`\ )
- - :ref:`Texture2D<class_Texture2D>` **get_param_texture**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`\ ) |const|
- Each particle's linear acceleration will vary along this :ref:`CurveTexture<class_CurveTexture>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_linear_accel_max:
- .. rst-class:: classref-property
- :ref:`float<class_float>` **linear_accel_max** = ``0.0`` :ref:`๐<class_ParticleProcessMaterial_property_linear_accel_max>`
- .. rst-class:: classref-property-setget
- - |void| **set_param_max**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`, value\: :ref:`float<class_float>`\ )
- - :ref:`float<class_float>` **get_param_max**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`\ ) |const|
- Maximum linear acceleration applied to each particle in the direction of motion.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_linear_accel_min:
- .. rst-class:: classref-property
- :ref:`float<class_float>` **linear_accel_min** = ``0.0`` :ref:`๐<class_ParticleProcessMaterial_property_linear_accel_min>`
- .. rst-class:: classref-property-setget
- - |void| **set_param_min**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`, value\: :ref:`float<class_float>`\ )
- - :ref:`float<class_float>` **get_param_min**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`\ ) |const|
- Minimum equivalent of :ref:`linear_accel_max<class_ParticleProcessMaterial_property_linear_accel_max>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_orbit_velocity_curve:
- .. rst-class:: classref-property
- :ref:`Texture2D<class_Texture2D>` **orbit_velocity_curve** :ref:`๐<class_ParticleProcessMaterial_property_orbit_velocity_curve>`
- .. rst-class:: classref-property-setget
- - |void| **set_param_texture**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`, texture\: :ref:`Texture2D<class_Texture2D>`\ )
- - :ref:`Texture2D<class_Texture2D>` **get_param_texture**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`\ ) |const|
- Each particle's orbital velocity will vary along this :ref:`CurveTexture<class_CurveTexture>`.
- \ **Note:** For 3D orbital velocity, use a :ref:`CurveXYZTexture<class_CurveXYZTexture>`.
- \ **Note:** Animated velocities will not be affected by damping, use :ref:`velocity_limit_curve<class_ParticleProcessMaterial_property_velocity_limit_curve>` instead.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_orbit_velocity_max:
- .. rst-class:: classref-property
- :ref:`float<class_float>` **orbit_velocity_max** = ``0.0`` :ref:`๐<class_ParticleProcessMaterial_property_orbit_velocity_max>`
- .. rst-class:: classref-property-setget
- - |void| **set_param_max**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`, value\: :ref:`float<class_float>`\ )
- - :ref:`float<class_float>` **get_param_max**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`\ ) |const|
- Maximum orbital velocity applied to each particle. Makes the particles circle around origin. Specified in number of full rotations around origin per second.
- \ **Note:** Animated velocities will not be affected by damping, use :ref:`velocity_limit_curve<class_ParticleProcessMaterial_property_velocity_limit_curve>` instead.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_orbit_velocity_min:
- .. rst-class:: classref-property
- :ref:`float<class_float>` **orbit_velocity_min** = ``0.0`` :ref:`๐<class_ParticleProcessMaterial_property_orbit_velocity_min>`
- .. rst-class:: classref-property-setget
- - |void| **set_param_min**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`, value\: :ref:`float<class_float>`\ )
- - :ref:`float<class_float>` **get_param_min**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`\ ) |const|
- Minimum equivalent of :ref:`orbit_velocity_max<class_ParticleProcessMaterial_property_orbit_velocity_max>`.
- \ **Note:** Animated velocities will not be affected by damping, use :ref:`velocity_limit_curve<class_ParticleProcessMaterial_property_velocity_limit_curve>` instead.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_particle_flag_align_y:
- .. rst-class:: classref-property
- :ref:`bool<class_bool>` **particle_flag_align_y** = ``false`` :ref:`๐<class_ParticleProcessMaterial_property_particle_flag_align_y>`
- .. rst-class:: classref-property-setget
- - |void| **set_particle_flag**\ (\ particle_flag\: :ref:`ParticleFlags<enum_ParticleProcessMaterial_ParticleFlags>`, enable\: :ref:`bool<class_bool>`\ )
- - :ref:`bool<class_bool>` **get_particle_flag**\ (\ particle_flag\: :ref:`ParticleFlags<enum_ParticleProcessMaterial_ParticleFlags>`\ ) |const|
- Align Y axis of particle with the direction of its velocity.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_particle_flag_damping_as_friction:
- .. rst-class:: classref-property
- :ref:`bool<class_bool>` **particle_flag_damping_as_friction** = ``false`` :ref:`๐<class_ParticleProcessMaterial_property_particle_flag_damping_as_friction>`
- .. rst-class:: classref-property-setget
- - |void| **set_particle_flag**\ (\ particle_flag\: :ref:`ParticleFlags<enum_ParticleProcessMaterial_ParticleFlags>`, enable\: :ref:`bool<class_bool>`\ )
- - :ref:`bool<class_bool>` **get_particle_flag**\ (\ particle_flag\: :ref:`ParticleFlags<enum_ParticleProcessMaterial_ParticleFlags>`\ ) |const|
- Changes the behavior of the damping properties from a linear deceleration to a deceleration based on speed percentage.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_particle_flag_disable_z:
- .. rst-class:: classref-property
- :ref:`bool<class_bool>` **particle_flag_disable_z** = ``false`` :ref:`๐<class_ParticleProcessMaterial_property_particle_flag_disable_z>`
- .. rst-class:: classref-property-setget
- - |void| **set_particle_flag**\ (\ particle_flag\: :ref:`ParticleFlags<enum_ParticleProcessMaterial_ParticleFlags>`, enable\: :ref:`bool<class_bool>`\ )
- - :ref:`bool<class_bool>` **get_particle_flag**\ (\ particle_flag\: :ref:`ParticleFlags<enum_ParticleProcessMaterial_ParticleFlags>`\ ) |const|
- If ``true``, particles will not move on the z axis.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_particle_flag_rotate_y:
- .. rst-class:: classref-property
- :ref:`bool<class_bool>` **particle_flag_rotate_y** = ``false`` :ref:`๐<class_ParticleProcessMaterial_property_particle_flag_rotate_y>`
- .. rst-class:: classref-property-setget
- - |void| **set_particle_flag**\ (\ particle_flag\: :ref:`ParticleFlags<enum_ParticleProcessMaterial_ParticleFlags>`, enable\: :ref:`bool<class_bool>`\ )
- - :ref:`bool<class_bool>` **get_particle_flag**\ (\ particle_flag\: :ref:`ParticleFlags<enum_ParticleProcessMaterial_ParticleFlags>`\ ) |const|
- If ``true``, particles rotate around Y axis by :ref:`angle_min<class_ParticleProcessMaterial_property_angle_min>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_radial_accel_curve:
- .. rst-class:: classref-property
- :ref:`Texture2D<class_Texture2D>` **radial_accel_curve** :ref:`๐<class_ParticleProcessMaterial_property_radial_accel_curve>`
- .. rst-class:: classref-property-setget
- - |void| **set_param_texture**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`, texture\: :ref:`Texture2D<class_Texture2D>`\ )
- - :ref:`Texture2D<class_Texture2D>` **get_param_texture**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`\ ) |const|
- Each particle's radial acceleration will vary along this :ref:`CurveTexture<class_CurveTexture>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_radial_accel_max:
- .. rst-class:: classref-property
- :ref:`float<class_float>` **radial_accel_max** = ``0.0`` :ref:`๐<class_ParticleProcessMaterial_property_radial_accel_max>`
- .. rst-class:: classref-property-setget
- - |void| **set_param_max**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`, value\: :ref:`float<class_float>`\ )
- - :ref:`float<class_float>` **get_param_max**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`\ ) |const|
- Maximum radial acceleration applied to each particle. Makes particle accelerate away from the origin or towards it if negative.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_radial_accel_min:
- .. rst-class:: classref-property
- :ref:`float<class_float>` **radial_accel_min** = ``0.0`` :ref:`๐<class_ParticleProcessMaterial_property_radial_accel_min>`
- .. rst-class:: classref-property-setget
- - |void| **set_param_min**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`, value\: :ref:`float<class_float>`\ )
- - :ref:`float<class_float>` **get_param_min**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`\ ) |const|
- Minimum equivalent of :ref:`radial_accel_max<class_ParticleProcessMaterial_property_radial_accel_max>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_radial_velocity_curve:
- .. rst-class:: classref-property
- :ref:`Texture2D<class_Texture2D>` **radial_velocity_curve** :ref:`๐<class_ParticleProcessMaterial_property_radial_velocity_curve>`
- .. rst-class:: classref-property-setget
- - |void| **set_param_texture**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`, texture\: :ref:`Texture2D<class_Texture2D>`\ )
- - :ref:`Texture2D<class_Texture2D>` **get_param_texture**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`\ ) |const|
- A :ref:`CurveTexture<class_CurveTexture>` that defines the velocity over the particle's lifetime away (or toward) the :ref:`velocity_pivot<class_ParticleProcessMaterial_property_velocity_pivot>`.
- \ **Note:** Animated velocities will not be affected by damping, use :ref:`velocity_limit_curve<class_ParticleProcessMaterial_property_velocity_limit_curve>` instead.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_radial_velocity_max:
- .. rst-class:: classref-property
- :ref:`float<class_float>` **radial_velocity_max** = ``0.0`` :ref:`๐<class_ParticleProcessMaterial_property_radial_velocity_max>`
- .. rst-class:: classref-property-setget
- - |void| **set_param_max**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`, value\: :ref:`float<class_float>`\ )
- - :ref:`float<class_float>` **get_param_max**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`\ ) |const|
- Maximum radial velocity applied to each particle. Makes particles move away from the :ref:`velocity_pivot<class_ParticleProcessMaterial_property_velocity_pivot>`, or toward it if negative.
- \ **Note:** Animated velocities will not be affected by damping, use :ref:`velocity_limit_curve<class_ParticleProcessMaterial_property_velocity_limit_curve>` instead.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_radial_velocity_min:
- .. rst-class:: classref-property
- :ref:`float<class_float>` **radial_velocity_min** = ``0.0`` :ref:`๐<class_ParticleProcessMaterial_property_radial_velocity_min>`
- .. rst-class:: classref-property-setget
- - |void| **set_param_min**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`, value\: :ref:`float<class_float>`\ )
- - :ref:`float<class_float>` **get_param_min**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`\ ) |const|
- Minimum radial velocity applied to each particle. Makes particles move away from the :ref:`velocity_pivot<class_ParticleProcessMaterial_property_velocity_pivot>`, or toward it if negative.
- \ **Note:** Animated velocities will not be affected by damping, use :ref:`velocity_limit_curve<class_ParticleProcessMaterial_property_velocity_limit_curve>` instead.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_scale_curve:
- .. rst-class:: classref-property
- :ref:`Texture2D<class_Texture2D>` **scale_curve** :ref:`๐<class_ParticleProcessMaterial_property_scale_curve>`
- .. rst-class:: classref-property-setget
- - |void| **set_param_texture**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`, texture\: :ref:`Texture2D<class_Texture2D>`\ )
- - :ref:`Texture2D<class_Texture2D>` **get_param_texture**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`\ ) |const|
- Each particle's scale will vary along this :ref:`CurveTexture<class_CurveTexture>` over its lifetime. If a :ref:`CurveXYZTexture<class_CurveXYZTexture>` is supplied instead, the scale will be separated per-axis.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_scale_max:
- .. rst-class:: classref-property
- :ref:`float<class_float>` **scale_max** = ``1.0`` :ref:`๐<class_ParticleProcessMaterial_property_scale_max>`
- .. rst-class:: classref-property-setget
- - |void| **set_param_max**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`, value\: :ref:`float<class_float>`\ )
- - :ref:`float<class_float>` **get_param_max**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`\ ) |const|
- Maximum initial scale applied to each particle.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_scale_min:
- .. rst-class:: classref-property
- :ref:`float<class_float>` **scale_min** = ``1.0`` :ref:`๐<class_ParticleProcessMaterial_property_scale_min>`
- .. rst-class:: classref-property-setget
- - |void| **set_param_min**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`, value\: :ref:`float<class_float>`\ )
- - :ref:`float<class_float>` **get_param_min**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`\ ) |const|
- Minimum equivalent of :ref:`scale_max<class_ParticleProcessMaterial_property_scale_max>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_scale_over_velocity_curve:
- .. rst-class:: classref-property
- :ref:`Texture2D<class_Texture2D>` **scale_over_velocity_curve** :ref:`๐<class_ParticleProcessMaterial_property_scale_over_velocity_curve>`
- .. rst-class:: classref-property-setget
- - |void| **set_param_texture**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`, texture\: :ref:`Texture2D<class_Texture2D>`\ )
- - :ref:`Texture2D<class_Texture2D>` **get_param_texture**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`\ ) |const|
- Either a :ref:`CurveTexture<class_CurveTexture>` or a :ref:`CurveXYZTexture<class_CurveXYZTexture>` that scales each particle based on its velocity.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_scale_over_velocity_max:
- .. rst-class:: classref-property
- :ref:`float<class_float>` **scale_over_velocity_max** = ``0.0`` :ref:`๐<class_ParticleProcessMaterial_property_scale_over_velocity_max>`
- .. rst-class:: classref-property-setget
- - |void| **set_param_max**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`, value\: :ref:`float<class_float>`\ )
- - :ref:`float<class_float>` **get_param_max**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`\ ) |const|
- Maximum velocity value reference for :ref:`scale_over_velocity_curve<class_ParticleProcessMaterial_property_scale_over_velocity_curve>`.
- \ :ref:`scale_over_velocity_curve<class_ParticleProcessMaterial_property_scale_over_velocity_curve>` will be interpolated between :ref:`scale_over_velocity_min<class_ParticleProcessMaterial_property_scale_over_velocity_min>` and :ref:`scale_over_velocity_max<class_ParticleProcessMaterial_property_scale_over_velocity_max>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_scale_over_velocity_min:
- .. rst-class:: classref-property
- :ref:`float<class_float>` **scale_over_velocity_min** = ``0.0`` :ref:`๐<class_ParticleProcessMaterial_property_scale_over_velocity_min>`
- .. rst-class:: classref-property-setget
- - |void| **set_param_min**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`, value\: :ref:`float<class_float>`\ )
- - :ref:`float<class_float>` **get_param_min**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`\ ) |const|
- Minimum velocity value reference for :ref:`scale_over_velocity_curve<class_ParticleProcessMaterial_property_scale_over_velocity_curve>`.
- \ :ref:`scale_over_velocity_curve<class_ParticleProcessMaterial_property_scale_over_velocity_curve>` will be interpolated between :ref:`scale_over_velocity_min<class_ParticleProcessMaterial_property_scale_over_velocity_min>` and :ref:`scale_over_velocity_max<class_ParticleProcessMaterial_property_scale_over_velocity_max>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_spread:
- .. rst-class:: classref-property
- :ref:`float<class_float>` **spread** = ``45.0`` :ref:`๐<class_ParticleProcessMaterial_property_spread>`
- .. rst-class:: classref-property-setget
- - |void| **set_spread**\ (\ value\: :ref:`float<class_float>`\ )
- - :ref:`float<class_float>` **get_spread**\ (\ )
- Each particle's initial direction range from ``+spread`` to ``-spread`` degrees.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_sub_emitter_amount_at_collision:
- .. rst-class:: classref-property
- :ref:`int<class_int>` **sub_emitter_amount_at_collision** :ref:`๐<class_ParticleProcessMaterial_property_sub_emitter_amount_at_collision>`
- .. rst-class:: classref-property-setget
- - |void| **set_sub_emitter_amount_at_collision**\ (\ value\: :ref:`int<class_int>`\ )
- - :ref:`int<class_int>` **get_sub_emitter_amount_at_collision**\ (\ )
- The amount of particles to spawn from the subemitter node when a collision occurs. When combined with :ref:`COLLISION_HIDE_ON_CONTACT<class_ParticleProcessMaterial_constant_COLLISION_HIDE_ON_CONTACT>` on the main particles material, this can be used to achieve effects such as raindrops hitting the ground.
- \ **Note:** This value shouldn't exceed :ref:`GPUParticles2D.amount<class_GPUParticles2D_property_amount>` or :ref:`GPUParticles3D.amount<class_GPUParticles3D_property_amount>` defined on the *subemitter node* (not the main node), relative to the subemitter's particle lifetime. If the number of particles is exceeded, no new particles will spawn from the subemitter until enough particles have expired.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_sub_emitter_amount_at_end:
- .. rst-class:: classref-property
- :ref:`int<class_int>` **sub_emitter_amount_at_end** :ref:`๐<class_ParticleProcessMaterial_property_sub_emitter_amount_at_end>`
- .. rst-class:: classref-property-setget
- - |void| **set_sub_emitter_amount_at_end**\ (\ value\: :ref:`int<class_int>`\ )
- - :ref:`int<class_int>` **get_sub_emitter_amount_at_end**\ (\ )
- The amount of particles to spawn from the subemitter node when the particle expires.
- \ **Note:** This value shouldn't exceed :ref:`GPUParticles2D.amount<class_GPUParticles2D_property_amount>` or :ref:`GPUParticles3D.amount<class_GPUParticles3D_property_amount>` defined on the *subemitter node* (not the main node), relative to the subemitter's particle lifetime. If the number of particles is exceeded, no new particles will spawn from the subemitter until enough particles have expired.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_sub_emitter_frequency:
- .. rst-class:: classref-property
- :ref:`float<class_float>` **sub_emitter_frequency** :ref:`๐<class_ParticleProcessMaterial_property_sub_emitter_frequency>`
- .. rst-class:: classref-property-setget
- - |void| **set_sub_emitter_frequency**\ (\ value\: :ref:`float<class_float>`\ )
- - :ref:`float<class_float>` **get_sub_emitter_frequency**\ (\ )
- The frequency at which particles should be emitted from the subemitter node. One particle will be spawned every :ref:`sub_emitter_frequency<class_ParticleProcessMaterial_property_sub_emitter_frequency>` seconds.
- \ **Note:** This value shouldn't exceed :ref:`GPUParticles2D.amount<class_GPUParticles2D_property_amount>` or :ref:`GPUParticles3D.amount<class_GPUParticles3D_property_amount>` defined on the *subemitter node* (not the main node), relative to the subemitter's particle lifetime. If the number of particles is exceeded, no new particles will spawn from the subemitter until enough particles have expired.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_sub_emitter_keep_velocity:
- .. rst-class:: classref-property
- :ref:`bool<class_bool>` **sub_emitter_keep_velocity** = ``false`` :ref:`๐<class_ParticleProcessMaterial_property_sub_emitter_keep_velocity>`
- .. rst-class:: classref-property-setget
- - |void| **set_sub_emitter_keep_velocity**\ (\ value\: :ref:`bool<class_bool>`\ )
- - :ref:`bool<class_bool>` **get_sub_emitter_keep_velocity**\ (\ )
- If ``true``, the subemitter inherits the parent particle's velocity when it spawns.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_sub_emitter_mode:
- .. rst-class:: classref-property
- :ref:`SubEmitterMode<enum_ParticleProcessMaterial_SubEmitterMode>` **sub_emitter_mode** = ``0`` :ref:`๐<class_ParticleProcessMaterial_property_sub_emitter_mode>`
- .. rst-class:: classref-property-setget
- - |void| **set_sub_emitter_mode**\ (\ value\: :ref:`SubEmitterMode<enum_ParticleProcessMaterial_SubEmitterMode>`\ )
- - :ref:`SubEmitterMode<enum_ParticleProcessMaterial_SubEmitterMode>` **get_sub_emitter_mode**\ (\ )
- The particle subemitter mode (see :ref:`GPUParticles2D.sub_emitter<class_GPUParticles2D_property_sub_emitter>` and :ref:`GPUParticles3D.sub_emitter<class_GPUParticles3D_property_sub_emitter>`).
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_tangential_accel_curve:
- .. rst-class:: classref-property
- :ref:`Texture2D<class_Texture2D>` **tangential_accel_curve** :ref:`๐<class_ParticleProcessMaterial_property_tangential_accel_curve>`
- .. rst-class:: classref-property-setget
- - |void| **set_param_texture**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`, texture\: :ref:`Texture2D<class_Texture2D>`\ )
- - :ref:`Texture2D<class_Texture2D>` **get_param_texture**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`\ ) |const|
- Each particle's tangential acceleration will vary along this :ref:`CurveTexture<class_CurveTexture>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_tangential_accel_max:
- .. rst-class:: classref-property
- :ref:`float<class_float>` **tangential_accel_max** = ``0.0`` :ref:`๐<class_ParticleProcessMaterial_property_tangential_accel_max>`
- .. rst-class:: classref-property-setget
- - |void| **set_param_max**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`, value\: :ref:`float<class_float>`\ )
- - :ref:`float<class_float>` **get_param_max**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`\ ) |const|
- Maximum tangential acceleration applied to each particle. Tangential acceleration is perpendicular to the particle's velocity giving the particles a swirling motion.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_tangential_accel_min:
- .. rst-class:: classref-property
- :ref:`float<class_float>` **tangential_accel_min** = ``0.0`` :ref:`๐<class_ParticleProcessMaterial_property_tangential_accel_min>`
- .. rst-class:: classref-property-setget
- - |void| **set_param_min**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`, value\: :ref:`float<class_float>`\ )
- - :ref:`float<class_float>` **get_param_min**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`\ ) |const|
- Minimum equivalent of :ref:`tangential_accel_max<class_ParticleProcessMaterial_property_tangential_accel_max>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_turbulence_enabled:
- .. rst-class:: classref-property
- :ref:`bool<class_bool>` **turbulence_enabled** = ``false`` :ref:`๐<class_ParticleProcessMaterial_property_turbulence_enabled>`
- .. rst-class:: classref-property-setget
- - |void| **set_turbulence_enabled**\ (\ value\: :ref:`bool<class_bool>`\ )
- - :ref:`bool<class_bool>` **get_turbulence_enabled**\ (\ )
- If ``true``, enables turbulence for the particle system. Turbulence can be used to vary particle movement according to its position (based on a 3D noise pattern). In 3D, :ref:`GPUParticlesAttractorVectorField3D<class_GPUParticlesAttractorVectorField3D>` with :ref:`NoiseTexture3D<class_NoiseTexture3D>` can be used as an alternative to turbulence that works in world space and with multiple particle systems reacting in the same way.
- \ **Note:** Enabling turbulence has a high performance cost on the GPU. Only enable turbulence on a few particle systems at once at most, and consider disabling it when targeting mobile/web platforms.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_turbulence_influence_max:
- .. rst-class:: classref-property
- :ref:`float<class_float>` **turbulence_influence_max** = ``0.1`` :ref:`๐<class_ParticleProcessMaterial_property_turbulence_influence_max>`
- .. rst-class:: classref-property-setget
- - |void| **set_param_max**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`, value\: :ref:`float<class_float>`\ )
- - :ref:`float<class_float>` **get_param_max**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`\ ) |const|
- Maximum turbulence influence on each particle.
- The actual amount of turbulence influence on each particle is calculated as a random value between :ref:`turbulence_influence_min<class_ParticleProcessMaterial_property_turbulence_influence_min>` and :ref:`turbulence_influence_max<class_ParticleProcessMaterial_property_turbulence_influence_max>` and multiplied by the amount of turbulence influence from :ref:`turbulence_influence_over_life<class_ParticleProcessMaterial_property_turbulence_influence_over_life>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_turbulence_influence_min:
- .. rst-class:: classref-property
- :ref:`float<class_float>` **turbulence_influence_min** = ``0.1`` :ref:`๐<class_ParticleProcessMaterial_property_turbulence_influence_min>`
- .. rst-class:: classref-property-setget
- - |void| **set_param_min**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`, value\: :ref:`float<class_float>`\ )
- - :ref:`float<class_float>` **get_param_min**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`\ ) |const|
- Minimum turbulence influence on each particle.
- The actual amount of turbulence influence on each particle is calculated as a random value between :ref:`turbulence_influence_min<class_ParticleProcessMaterial_property_turbulence_influence_min>` and :ref:`turbulence_influence_max<class_ParticleProcessMaterial_property_turbulence_influence_max>` and multiplied by the amount of turbulence influence from :ref:`turbulence_influence_over_life<class_ParticleProcessMaterial_property_turbulence_influence_over_life>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_turbulence_influence_over_life:
- .. rst-class:: classref-property
- :ref:`Texture2D<class_Texture2D>` **turbulence_influence_over_life** :ref:`๐<class_ParticleProcessMaterial_property_turbulence_influence_over_life>`
- .. rst-class:: classref-property-setget
- - |void| **set_param_texture**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`, texture\: :ref:`Texture2D<class_Texture2D>`\ )
- - :ref:`Texture2D<class_Texture2D>` **get_param_texture**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`\ ) |const|
- Each particle's amount of turbulence will be influenced along this :ref:`CurveTexture<class_CurveTexture>` over its life time.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_turbulence_initial_displacement_max:
- .. rst-class:: classref-property
- :ref:`float<class_float>` **turbulence_initial_displacement_max** = ``0.0`` :ref:`๐<class_ParticleProcessMaterial_property_turbulence_initial_displacement_max>`
- .. rst-class:: classref-property-setget
- - |void| **set_param_max**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`, value\: :ref:`float<class_float>`\ )
- - :ref:`float<class_float>` **get_param_max**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`\ ) |const|
- Maximum displacement of each particle's spawn position by the turbulence.
- The actual amount of displacement will be a factor of the underlying turbulence multiplied by a random value between :ref:`turbulence_initial_displacement_min<class_ParticleProcessMaterial_property_turbulence_initial_displacement_min>` and :ref:`turbulence_initial_displacement_max<class_ParticleProcessMaterial_property_turbulence_initial_displacement_max>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_turbulence_initial_displacement_min:
- .. rst-class:: classref-property
- :ref:`float<class_float>` **turbulence_initial_displacement_min** = ``0.0`` :ref:`๐<class_ParticleProcessMaterial_property_turbulence_initial_displacement_min>`
- .. rst-class:: classref-property-setget
- - |void| **set_param_min**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`, value\: :ref:`float<class_float>`\ )
- - :ref:`float<class_float>` **get_param_min**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`\ ) |const|
- Minimum displacement of each particle's spawn position by the turbulence.
- The actual amount of displacement will be a factor of the underlying turbulence multiplied by a random value between :ref:`turbulence_initial_displacement_min<class_ParticleProcessMaterial_property_turbulence_initial_displacement_min>` and :ref:`turbulence_initial_displacement_max<class_ParticleProcessMaterial_property_turbulence_initial_displacement_max>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_turbulence_noise_scale:
- .. rst-class:: classref-property
- :ref:`float<class_float>` **turbulence_noise_scale** = ``9.0`` :ref:`๐<class_ParticleProcessMaterial_property_turbulence_noise_scale>`
- .. rst-class:: classref-property-setget
- - |void| **set_turbulence_noise_scale**\ (\ value\: :ref:`float<class_float>`\ )
- - :ref:`float<class_float>` **get_turbulence_noise_scale**\ (\ )
- This value controls the overall scale/frequency of the turbulence noise pattern.
- A small scale will result in smaller features with more detail while a high scale will result in smoother noise with larger features.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_turbulence_noise_speed:
- .. rst-class:: classref-property
- :ref:`Vector3<class_Vector3>` **turbulence_noise_speed** = ``Vector3(0, 0, 0)`` :ref:`๐<class_ParticleProcessMaterial_property_turbulence_noise_speed>`
- .. rst-class:: classref-property-setget
- - |void| **set_turbulence_noise_speed**\ (\ value\: :ref:`Vector3<class_Vector3>`\ )
- - :ref:`Vector3<class_Vector3>` **get_turbulence_noise_speed**\ (\ )
- A scrolling velocity for the turbulence field. This sets a directional trend for the pattern to move in over time.
- The default value of ``Vector3(0, 0, 0)`` turns off the scrolling.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_turbulence_noise_speed_random:
- .. rst-class:: classref-property
- :ref:`float<class_float>` **turbulence_noise_speed_random** = ``0.2`` :ref:`๐<class_ParticleProcessMaterial_property_turbulence_noise_speed_random>`
- .. rst-class:: classref-property-setget
- - |void| **set_turbulence_noise_speed_random**\ (\ value\: :ref:`float<class_float>`\ )
- - :ref:`float<class_float>` **get_turbulence_noise_speed_random**\ (\ )
- The in-place rate of change of the turbulence field. This defines how quickly the noise pattern varies over time.
- A value of 0.0 will result in a fixed pattern.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_turbulence_noise_strength:
- .. rst-class:: classref-property
- :ref:`float<class_float>` **turbulence_noise_strength** = ``1.0`` :ref:`๐<class_ParticleProcessMaterial_property_turbulence_noise_strength>`
- .. rst-class:: classref-property-setget
- - |void| **set_turbulence_noise_strength**\ (\ value\: :ref:`float<class_float>`\ )
- - :ref:`float<class_float>` **get_turbulence_noise_strength**\ (\ )
- The turbulence noise strength. Increasing this will result in a stronger, more contrasting, flow pattern.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_velocity_limit_curve:
- .. rst-class:: classref-property
- :ref:`Texture2D<class_Texture2D>` **velocity_limit_curve** :ref:`๐<class_ParticleProcessMaterial_property_velocity_limit_curve>`
- .. rst-class:: classref-property-setget
- - |void| **set_velocity_limit_curve**\ (\ value\: :ref:`Texture2D<class_Texture2D>`\ )
- - :ref:`Texture2D<class_Texture2D>` **get_velocity_limit_curve**\ (\ )
- A :ref:`CurveTexture<class_CurveTexture>` that defines the maximum velocity of a particle during its lifetime.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_property_velocity_pivot:
- .. rst-class:: classref-property
- :ref:`Vector3<class_Vector3>` **velocity_pivot** = ``Vector3(0, 0, 0)`` :ref:`๐<class_ParticleProcessMaterial_property_velocity_pivot>`
- .. rst-class:: classref-property-setget
- - |void| **set_velocity_pivot**\ (\ value\: :ref:`Vector3<class_Vector3>`\ )
- - :ref:`Vector3<class_Vector3>` **get_velocity_pivot**\ (\ )
- A pivot point used to calculate radial and orbital velocity of particles.
- .. rst-class:: classref-section-separator
- ----
- .. rst-class:: classref-descriptions-group
- Method Descriptions
- -------------------
- .. _class_ParticleProcessMaterial_method_get_param:
- .. rst-class:: classref-method
- :ref:`Vector2<class_Vector2>` **get_param**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`\ ) |const| :ref:`๐<class_ParticleProcessMaterial_method_get_param>`
- Returns the minimum and maximum values of the given ``param`` as a vector.
- The ``x`` component of the returned vector corresponds to minimum and the ``y`` component corresponds to maximum.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_method_get_param_max:
- .. rst-class:: classref-method
- :ref:`float<class_float>` **get_param_max**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`\ ) |const| :ref:`๐<class_ParticleProcessMaterial_method_get_param_max>`
- Returns the maximum value range for the given parameter.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_method_get_param_min:
- .. rst-class:: classref-method
- :ref:`float<class_float>` **get_param_min**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`\ ) |const| :ref:`๐<class_ParticleProcessMaterial_method_get_param_min>`
- Returns the minimum value range for the given parameter.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_method_get_param_texture:
- .. rst-class:: classref-method
- :ref:`Texture2D<class_Texture2D>` **get_param_texture**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`\ ) |const| :ref:`๐<class_ParticleProcessMaterial_method_get_param_texture>`
- Returns the :ref:`Texture2D<class_Texture2D>` used by the specified parameter.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_method_get_particle_flag:
- .. rst-class:: classref-method
- :ref:`bool<class_bool>` **get_particle_flag**\ (\ particle_flag\: :ref:`ParticleFlags<enum_ParticleProcessMaterial_ParticleFlags>`\ ) |const| :ref:`๐<class_ParticleProcessMaterial_method_get_particle_flag>`
- Returns ``true`` if the specified particle flag is enabled. See :ref:`ParticleFlags<enum_ParticleProcessMaterial_ParticleFlags>` for options.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_method_set_param:
- .. rst-class:: classref-method
- |void| **set_param**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`, value\: :ref:`Vector2<class_Vector2>`\ ) :ref:`๐<class_ParticleProcessMaterial_method_set_param>`
- Sets the minimum and maximum values of the given ``param``.
- The ``x`` component of the argument vector corresponds to minimum and the ``y`` component corresponds to maximum.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_method_set_param_max:
- .. rst-class:: classref-method
- |void| **set_param_max**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`, value\: :ref:`float<class_float>`\ ) :ref:`๐<class_ParticleProcessMaterial_method_set_param_max>`
- Sets the maximum value range for the given parameter.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_method_set_param_min:
- .. rst-class:: classref-method
- |void| **set_param_min**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`, value\: :ref:`float<class_float>`\ ) :ref:`๐<class_ParticleProcessMaterial_method_set_param_min>`
- Sets the minimum value range for the given parameter.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_method_set_param_texture:
- .. rst-class:: classref-method
- |void| **set_param_texture**\ (\ param\: :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`, texture\: :ref:`Texture2D<class_Texture2D>`\ ) :ref:`๐<class_ParticleProcessMaterial_method_set_param_texture>`
- Sets the :ref:`Texture2D<class_Texture2D>` for the specified :ref:`Parameter<enum_ParticleProcessMaterial_Parameter>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_ParticleProcessMaterial_method_set_particle_flag:
- .. rst-class:: classref-method
- |void| **set_particle_flag**\ (\ particle_flag\: :ref:`ParticleFlags<enum_ParticleProcessMaterial_ParticleFlags>`, enable\: :ref:`bool<class_bool>`\ ) :ref:`๐<class_ParticleProcessMaterial_method_set_particle_flag>`
- If ``true``, enables the specified particle flag. See :ref:`ParticleFlags<enum_ParticleProcessMaterial_ParticleFlags>` for options.
- .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
- .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
- .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
- .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
- .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
- .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
- .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
- .. |void| replace:: :abbr:`void (No return value.)`
|