ParticleSpriteRendererclass
Renders particles as 2D sprites - can be static or animated
Constructors1
Showing 1 constructors
public ParticleSpriteRenderer()
No results match this filter.
Methods2
Showing 2 methods
No results match this filter.
Properties32
Showing 32 properties
public virtual sealed bool Sandbox.ParticleSpriteRenderer.Additive { get; set; }
Whether or not the sprite should be rendered additively.
bool—public virtual sealed Sandbox.ParticleSpriteRenderer.BillboardAlignment Sandbox.ParticleSpriteRenderer.Alignment { get; set; }
Alignment mode for the sprite's billboard behavior.
public virtual sealed float Sandbox.ParticleSpriteRenderer.BlurAmount { get; set; }
Amount of blur applied to the sprite during motion blur.
float—public virtual sealed float Sandbox.ParticleSpriteRenderer.BlurOpacity { get; set; }
Opacity of the blur effect applied to the sprite.
float—public virtual sealed float Sandbox.ParticleSpriteRenderer.BlurSpacing { get; set; }
Spacing between blur samples in the motion blur effect.
float—public virtual sealed float Sandbox.ParticleSpriteRenderer.CameraFadeFar { get; set; }
Sprites further from the camera than this are fully opaque. Between this and `Sandbox.ParticleSpriteRenderer.CameraFadeNear` they fade out. Leave at zero to disable the fade.
float—public virtual sealed float Sandbox.ParticleSpriteRenderer.CameraFadeNear { get; set; }
Sprites closer to the camera than this are completely invisible.
float—public virtual int Sandbox.ParticleSpriteRenderer.ComponentVersion { get; set; }
int—public Sandbox.Sprite.Animation Sandbox.ParticleSpriteRenderer.CurrentAnimation { get; set; }
The animation that is currently being played. Returns null if no sprite is set or the sprite has no animations.
public virtual sealed float Sandbox.ParticleSpriteRenderer.DepthFeather { get; set; }
Amount of feathering applied to the depth, softening its intersection with geometry.
float—public virtual sealed bool Sandbox.ParticleSpriteRenderer.FaceVelocity { get; set; }
Aligns the sprite to face its velocity direction.
bool—public virtual sealed float Sandbox.ParticleSpriteRenderer.FogStrength { get; set; }
The strength of the fog effect applied to the sprite. This determines how much the sprite blends with any fog in the scene.
float—public bool Sandbox.ParticleSpriteRenderer.IsAnimated { get; set; }
Whether or not the sprite is animated. This is true if the sprite has more than one animation or if the current animation has more than one frame.
bool—public virtual sealed bool Sandbox.ParticleSpriteRenderer.IsSorted { get; set; }
Interface property to determine if particles should be sorted
bool—public virtual sealed bool Sandbox.ParticleSpriteRenderer.LeadingTrail { get; set; }
Determines whether the motion blur effect includes a leading trail.
bool—public virtual sealed bool Sandbox.ParticleSpriteRenderer.Lighting { get; set; }
Whether or not the sprite should be lit by the scene lighting.
bool—public virtual sealed bool Sandbox.ParticleSpriteRenderer.MotionBlur { get; set; }
Enables motion blur effects for the sprite.
bool—public Sandbox.Texture Sandbox.ParticleSpriteRenderer.NormalTexture { get; set; }
Tangent-space normal map sampled in linear space. Use the same UV layout as the sprite texture: particle sheet sequences, frame blending and rotation are shared with the alpha mask. For sprites that change texture between frames, this map is shared by every frame.
public virtual sealed bool Sandbox.ParticleSpriteRenderer.Opaque { get; set; }
Indicates whether the sprite is opaque, optimizing rendering by skipping sorting.
bool—public virtual sealed Vector2 Sandbox.ParticleSpriteRenderer.Pivot { get; set; }
The pivot point of the sprite, used for rotation and scaling. This is in normalized coordinates (0 to 1).
public float Sandbox.ParticleSpriteRenderer.PlaybackSpeed { get; set; }
float—public bool Sandbox.ParticleSpriteRenderer.Refraction { get; set; }
Draw the sprite artwork over a refracted background in one pass. Alpha controls the artwork only. Requires a normal texture and translucent, non-additive rendering. The captured scene is already lit and fogged.
bool—public virtual sealed Sandbox.ParticleFloat Sandbox.ParticleSpriteRenderer.RefractionStrength { get; set; }
Maximum refraction offset in render pixels before the normal is applied. Alpha, depth feathering and camera fading affect artwork opacity only, never the refraction. Supports constants, random ranges and lifetime curves, like particle alpha. Zero leaves the captured background undistorted. Refraction must be disabled to return to ordinary sprite rendering.
public virtual sealed Sandbox.Texture Sandbox.ParticleSpriteRenderer.RenderTexture { get; set; }
Provides texture for rendering - implementation for IBatchedParticleSpriteRenderer
public virtual sealed float Sandbox.ParticleSpriteRenderer.RotationOffset { get; set; }
Offset applied to the rotation when facing velocity.
float—public virtual sealed float Sandbox.ParticleSpriteRenderer.Scale { get; set; }
The scale of the sprite when rendered.
float—public virtual sealed bool Sandbox.ParticleSpriteRenderer.Shadows { get; set; }
Whether or not the sprite should cast shadows in the scene.
bool—public Sandbox.ParticleSpriteRenderer.ParticleSortMode Sandbox.ParticleSpriteRenderer.SortMode { get; set; }
Sorting mode used for rendering particles.
public Sandbox.Sprite Sandbox.ParticleSpriteRenderer.Sprite { get; set; }
The sprite resource to render. This can be completely static or contain animation(s).
public string Sandbox.ParticleSpriteRenderer.StartingAnimationName { get; set; }
The animation that this sprite should start playing when the scene starts.
string—public Sandbox.Texture Sandbox.ParticleSpriteRenderer.Texture { get; set; }
The texture being displayed from the sprite given the current frame/animation.
public virtual sealed Sandbox.Rendering.FilterMode Sandbox.ParticleSpriteRenderer.TextureFilter { get; set; }
The texture filtering mode used when rendering the sprite. For pixelated sprites use `Sandbox.Rendering.FilterMode.Point`.
No results match this filter.