Particle System Properties: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
No edit summary
No edit summary
 
(12 intermediate revisions by 6 users not shown)
Line 1: Line 1:
{{otherlang2
{{LanguageBar}}
|zh-cn= Particle System Properties:zh-cn
{{back|Category:Particle System}}
}}
{{stub}}
{{stub}}
''Properties are values that every particle system has without anything added to it.''
''Properties are values that every particle system has without anything added to it.''


== Properties ==
== Properties ==
; max_particles
{{todo|Some of these properties are only in later engine branches. That needs to be documented.}}
: The limit at which no new particles will be emitted until other particles are removed.
 
; material
; aggregation radius <code><[[float]]></code>
: The material used for all particles in the system. If using multiple renderers they must share this material.
*{{todo|Description needed.}}
; bounding_box_min
 
; bounding_box_max
; batch particle systems <code><[[bool]]></code>
: By default the bounding box is set to enclose only the exact center of every particle. Min and max are used to expand it. The system will not be rendered if the bounding box is not visible. The values can be negative.
*{{todo|Description needed.}}
; cull_radius
 
; cull_cost
; bounding_box_max <code><[[vector3]]></code>
; cull_control_point
*The bounding box for the particle system. It only encloses the exact center of every particle. The particle system will not be rendered if the bounding box is not visible.
; cull_replacement_definition
 
: [[LOD|Level of detail]]?
; bounding_box_min <code><[[vector3]]></code>
; radius
*The bounding box for the particle system. It only encloses the exact center of every particle. The particle system will not be rendered if the bounding box is not visible.
: The default size of all particles.
 
; color
; color <code><[[color]]></code>
: Default color. The alpha field is ignored.
*The default color for the particle system. The alpha value is ignored.
; rotation
 
: Default rotation.
; control point to disable rendering <code><[[int]]></code>
; rotation_speed
*Allows you to choose a control point that, if visible to the client, will disable rendering the particle system. The default value is -1 and will make it render everywhere.
: Default rotation speed.
 
; sequence_number
; control point to only enable rendering <code><[[int]]></code>
; sequence_number 1
*The particle system will only be rendered if the given control point is visible to the player. The default value is -1 and will make it render everywhere.
; group id
 
; maximum time step
; cull_control_point <code><[[int]]></code>
; maximum sim tick rate
*If the cheat ConVar <code>cl_particle_retire_cost</code> is not 0, the selected control point is used as the vector center to help calculate the size a particle takes up on a client's screen, compared to the maximum area when culling/retiring a particle system. {{todo|Verify}}
; minimum sim tick rate
 
; minimum rendered frames
; cull_cost <code><[[float]]></code>
; control point to disable rendering if it is the camera
*If the cheat ConVar <code>cl_particle_retire_cost</code> is not 0, then it is used as a mulitplier when calculating whether a particle system is using more than the screen's maximum area. If a particle system exceeds the maximum viewspace, it will be culled. {{todo|Verify}}
; maximum draw distance
 
; time to sleep when not drawn
; cull_radius <code><[[float]]></code>
; Sort particles
*If the cheat ConVar <code>cl_particle_retire_cost</code> is not 0, then it is used (mostly) as a mulitplier when calculating whether a particle system is using more than the screen's maximum area. If a particle system exceeds the maximum viewspace, it will be culled. {{todo|Verify}}
; batch particle systems
 
; view model effect
; cull_replacement_definition <code><[[string]]></code>
*If the cheat ConVar <code>cl_particle_retire_cost</code> is not 0 and when this particle system is culled/retired, it will be replaced with this one. {{todo|Verify}}
 
; draw through leafsystem <code><[[bool]]></code>
*{{todo|Description needed.}}
 
; fallback max count <code><[[int]]></code>
*{{todo|Description needed.}}
 
; fallback replacement definition <code><[[string]]></code>
*{{todo|Description needed.}}
 
; freeze simulation after time <code><[[float]]></code>
*Forces the particle system to freeze after the set amount of seconds.
 
; group id <code><[[int]]></code>
*{{todo|Description needed.}}
 
; initial_particles <code><[[int]]></code>
*The particle will spawn with a specific amount of particles. Similar to the emitter [[emit_instantaneously]].
 
; material <code><[[string]]></code>
* The material used for all particles in the system. If you are using multiple renderers they must share this material.
 
; max_particles <code><[[int]]></code>
* The limit at which no new particles will be emitted until other particles are removed.
 
; maximum draw distance <code><[[float]]></code>
* The maximum distance at which the particle system is rendered. The particle system will not be visible beyond this value.
 
; maximum sim tick rate <code><[[float]]></code>
*{{todo|Description needed.}}
 
; maximum time step <code><[[float]]></code>
* The maximum time it takes for the system properties to simulate. Use this to achieve a "jitter" or stutter effect in your particle system.
 
; minimum CPU level <code><[[int]]></code>
*{{todo|Description needed.}}
 
; minimum free particles to aggregate <code><[[int]]></code>
*{{todo|Description needed.}}
 
; minimum GPU level <code><[[int]]></code>
*{{todo|Description needed.}}
 
; minimum rendered frames <code><[[int]]></code>
*{{todo|Description needed.}}
 
; minimum sim tick rate <code><[[float]]></code>
*{{todo|Description needed.}}
 
; minimum simulation time step <code><[[float]]></code>
* The time it takes for the particle emitter to "wake up" again and the minimum time it takes for the system properties to simulate. Use this to achieve a "jitter" or stutter effect in your particle system.
 
; name <code><[[string]]></code>
* This is the name of the specific particle system.
 
; normal <code><[[vector3]]></code>
*{{todo|Description needed.}}
 
; preventNameBasedLookup <code><[[bool]]></code>
*{{todo|Description needed.}}
 
; radius <code><[[float]]></code>
* The default size of all the spawned particles.
 
; rotation <code><[[float]]></code>
* The default rotation of the emitted particles.
 
; rotation_speed <code><[[float]]></code>
* Default rotation speed.
 
; screen space effect <code><[[bool]]></code>
* Whether or not the particle system is a screen effect.
 
; sequence_number <code><[[int]]></code>
* When using a material with a [[Animated Particles|sequenced sheet texture]], this will control the initial sequence of every particle.
 
; sequence_number 1 <code><[[int]]></code>
* Same as sequence_number, except this controls the second initial sequence in dual-sequence materials.
 
; Sort particles <code><[[bool]]></code>
* Whether or not the particles should have their render order sorted each frame. If set to 0, older particles will always render on top of newer ones.
 
; time to sleep when not drawn <code><[[float]]></code>
*{{todo|Description needed.}}
 
; view model effect <code><[[bool]]></code>
* Makes this particle system and all of its children render as part of the [[viewmodel]]. Useful for effects such as first-person weapon muzzleflashes, as otherwise they would always render behind the viewmodel.


[[Category: Particle System]]
[[Category: Particle System]]

Latest revision as of 23:16, 2 September 2024

English (en)中文 (zh)Translate (Translate)
← Category:Particle System

Stub

This article or section is a stub. You can help by expanding it.

Properties are values that every particle system has without anything added to it.

Properties

Todo: Some of these properties are only in later engine branches. That needs to be documented.
aggregation radius <float>
  • Todo: Description needed.
batch particle systems <bool>
  • Todo: Description needed.
bounding_box_max <vector3>
  • The bounding box for the particle system. It only encloses the exact center of every particle. The particle system will not be rendered if the bounding box is not visible.
bounding_box_min <vector3>
  • The bounding box for the particle system. It only encloses the exact center of every particle. The particle system will not be rendered if the bounding box is not visible.
color <color>
  • The default color for the particle system. The alpha value is ignored.
control point to disable rendering <int>
  • Allows you to choose a control point that, if visible to the client, will disable rendering the particle system. The default value is -1 and will make it render everywhere.
control point to only enable rendering <int>
  • The particle system will only be rendered if the given control point is visible to the player. The default value is -1 and will make it render everywhere.
cull_control_point <int>
  • If the cheat ConVar cl_particle_retire_cost is not 0, the selected control point is used as the vector center to help calculate the size a particle takes up on a client's screen, compared to the maximum area when culling/retiring a particle system.
    Todo: Verify
cull_cost <float>
  • If the cheat ConVar cl_particle_retire_cost is not 0, then it is used as a mulitplier when calculating whether a particle system is using more than the screen's maximum area. If a particle system exceeds the maximum viewspace, it will be culled.
    Todo: Verify
cull_radius <float>
  • If the cheat ConVar cl_particle_retire_cost is not 0, then it is used (mostly) as a mulitplier when calculating whether a particle system is using more than the screen's maximum area. If a particle system exceeds the maximum viewspace, it will be culled.
    Todo: Verify
cull_replacement_definition <string>
  • If the cheat ConVar cl_particle_retire_cost is not 0 and when this particle system is culled/retired, it will be replaced with this one.
    Todo: Verify
draw through leafsystem <bool>
  • Todo: Description needed.
fallback max count <int>
  • Todo: Description needed.
fallback replacement definition <string>
  • Todo: Description needed.
freeze simulation after time <float>
  • Forces the particle system to freeze after the set amount of seconds.
group id <int>
  • Todo: Description needed.
initial_particles <int>
  • The particle will spawn with a specific amount of particles. Similar to the emitter emit_instantaneously.
material <string>
  • The material used for all particles in the system. If you are using multiple renderers they must share this material.
max_particles <int>
  • The limit at which no new particles will be emitted until other particles are removed.
maximum draw distance <float>
  • The maximum distance at which the particle system is rendered. The particle system will not be visible beyond this value.
maximum sim tick rate <float>
  • Todo: Description needed.
maximum time step <float>
  • The maximum time it takes for the system properties to simulate. Use this to achieve a "jitter" or stutter effect in your particle system.
minimum CPU level <int>
  • Todo: Description needed.
minimum free particles to aggregate <int>
  • Todo: Description needed.
minimum GPU level <int>
  • Todo: Description needed.
minimum rendered frames <int>
  • Todo: Description needed.
minimum sim tick rate <float>
  • Todo: Description needed.
minimum simulation time step <float>
  • The time it takes for the particle emitter to "wake up" again and the minimum time it takes for the system properties to simulate. Use this to achieve a "jitter" or stutter effect in your particle system.
name <string>
  • This is the name of the specific particle system.
normal <vector3>
  • Todo: Description needed.
preventNameBasedLookup <bool>
  • Todo: Description needed.
radius <float>
  • The default size of all the spawned particles.
rotation <float>
  • The default rotation of the emitted particles.
rotation_speed <float>
  • Default rotation speed.
screen space effect <bool>
  • Whether or not the particle system is a screen effect.
sequence_number <int>
sequence_number 1 <int>
  • Same as sequence_number, except this controls the second initial sequence in dual-sequence materials.
Sort particles <bool>
  • Whether or not the particles should have their render order sorted each frame. If set to 0, older particles will always render on top of newer ones.
time to sleep when not drawn <float>
  • Todo: Description needed.
view model effect <bool>
  • Makes this particle system and all of its children render as part of the viewmodel. Useful for effects such as first-person weapon muzzleflashes, as otherwise they would always render behind the viewmodel.
Retrieved from "https://developer.valvesoftware.com/w/index.php?title=Particle_System_Properties&oldid=450049"