Class NPCSprayPainting

Wraps the spray painting action for an NPC. Use to equip the spray can, toggle spray effects, and control the animation.

public sealed class NPCSprayPainting

Inherited Members: object.GetType()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Extension Methods: ReflectionUtils.GetValueTupleItems(object)

ReflectionUtils.IsValueTuple(object)

Remarks

Requires the spray paint component to be configured on the prefab via EnsureGraffiti(string?). If not present, Begin(), End(), and SetEffect(bool, Color) are no-ops.

Whether the spray painting action is currently active (spray can equipped, animation playing).

public bool IsActive { get; }

Begins the spray painting action: equips the spray can and plays the UseSprayCan animation.

public void Begin()

No-op if the spray paint component is not on the prefab. Call EnsureGraffiti(string?) during ConfigurePrefab to add it.

Ends the spray painting action: unequips the spray can and stops the animation.

public void End()

Sets the spray effect (particle and sound) on or off.

public void SetEffect(bool enabled, Color color = null)

enabled bool: Whether the spray effect should be visible and audible.
color Color: Color for the spray particles when enabling. Ignored when disabling.