realvirtual.Highlight Class Reference

Enhanced static multi-threaded mesh highlighting system with animation effects. More...

Public Types
enum	AnimationType {   None , Pulse , Rainbow , Strobe ,   Breathe , Electricity , Scan , MouseProximity ,   HealthBased }
enum	HighlightMode { Outline , Wireframe , Combined }

Static Public Member Functions
static void	ForceInitialize ()
	Force initialization of the highlight system (useful for ensuring cleanup works in editor)
static async void	SetHighlight (GameObject target, Color color, AnimationType animation=AnimationType.None, float width=0.001f, float speed=1f, float intensity=1f, HighlightMode mode=HighlightMode.Outline, Color? wireframeColor=null, float wireframeThickness=1f, string forceWireframeShader=null)
	Highlight a GameObject with animation.
static void	RemoveHighlight (GameObject target)
	Remove highlighting from a GameObject.
static void	RemoveAllHighlights ()
	Remove all active highlights.
static void	ForceCleanupAllHighlightObjects ()
	Force cleanup of all highlight GameObjects (use when things go wrong)
static void	SyncTransforms ()
	Synchronize outline transforms with their original objects.
static bool	IsHighlighted (GameObject target)
	Check if a GameObject is currently highlighted.
static void	DebugHighlightStatus (GameObject target)
	Debug method to check highlight status.
static async void	PulseOnce (GameObject target, Color color, float pulseDuration=1f, float width=0.001f, float intensity=1f, HighlightMode mode=HighlightMode.Outline, Color? wireframeColor=null, float wireframeThickness=1f)
	Pulse a GameObject once (one complete pulse cycle)
static async void	PulseTwice (GameObject target, Color color, float pulseDuration=1f, float width=0.001f, float intensity=1f, HighlightMode mode=HighlightMode.Outline, Color? wireframeColor=null, float wireframeThickness=1f)
	Pulse a GameObject twice (two complete pulse cycles)
static void	ChangeAnimation (GameObject target, AnimationType newAnimation, float speed=1f, float intensity=1f)
	Change animation type for existing highlight.
static void	UpdateAnimations ()
static void	Shutdown ()

Properties
static bool	PersistAcrossScenes [get, set]
	Get or set whether highlights should persist across scene changes (default: false)

Detailed Description

Enhanced static multi-threaded mesh highlighting system with animation effects.

Member Function Documentation

ChangeAnimation()

static void realvirtual.Highlight.ChangeAnimation ( GameObject  target, AnimationType  newAnimation, float  speed = 1f, float  intensity = 1f  )

static

Change animation type for existing highlight.

DebugHighlightStatus()

static void realvirtual.Highlight.DebugHighlightStatus ( GameObject  target )

static

Debug method to check highlight status.

ForceCleanupAllHighlightObjects()

static void realvirtual.Highlight.ForceCleanupAllHighlightObjects ( )

static

Force cleanup of all highlight GameObjects (use when things go wrong)

ForceInitialize()

static void realvirtual.Highlight.ForceInitialize ( )

static

Force initialization of the highlight system (useful for ensuring cleanup works in editor)

IsHighlighted()

static bool realvirtual.Highlight.IsHighlighted ( GameObject  target )

static

Check if a GameObject is currently highlighted.

PulseOnce()

static async void realvirtual.Highlight.PulseOnce ( GameObject  target, Color  color, float  pulseDuration = 1f, float  width = 0::001f, float  intensity = 1f, HighlightMode  mode = HighlightMode::Outline, Color?  wireframeColor = null, float  wireframeThickness = 1f  )

static

Pulse a GameObject once (one complete pulse cycle)

PulseTwice()

static async void realvirtual.Highlight.PulseTwice ( GameObject  target, Color  color, float  pulseDuration = 1f, float  width = 0::001f, float  intensity = 1f, HighlightMode  mode = HighlightMode::Outline, Color?  wireframeColor = null, float  wireframeThickness = 1f  )

static

Pulse a GameObject twice (two complete pulse cycles)

RemoveAllHighlights()

static void realvirtual.Highlight.RemoveAllHighlights ( )

static

Remove all active highlights.

RemoveHighlight()

static void realvirtual.Highlight.RemoveHighlight ( GameObject  target )

static

Remove highlighting from a GameObject.

SetHighlight()

static async void realvirtual.Highlight.SetHighlight ( GameObject  target, Color  color, AnimationType  animation = AnimationType::None, float  width = 0::001f, float  speed = 1f, float  intensity = 1f, HighlightMode  mode = HighlightMode::Outline, Color?  wireframeColor = null, float  wireframeThickness = 1f, string  forceWireframeShader = null  )

static

Highlight a GameObject with animation.

SyncTransforms()

static void realvirtual.Highlight.SyncTransforms ( )

static

Synchronize outline transforms with their original objects.

Property Documentation

PersistAcrossScenes

bool realvirtual.Highlight.PersistAcrossScenes

staticgetset

Get or set whether highlights should persist across scene changes (default: false)