API Reference¶
Runtime namespace: PixitGames.HighlightKit. Public members include XML documentation for IDE tooltips. Vectors/colors use UnityEngine types.
Highlightable¶
| Members | Purpose |
|---|---|
OutlineEnabled, SetOutline(bool), SetOutline(bool, Color) |
Toggle outline/fill; optionally set a color |
OutlineColor, OutlineWidth, FillColor |
Set per-object overrides |
HasColorOverride, HasWidthOverride, HasFillOverride |
Inspect overrides |
ClearOutlineOverrides() |
Restore outline/fill defaults |
XRayEnabled, SetXRay(bool), SetXRay(bool, Color), XRayColor |
Toggle/recolor X-Ray |
HasXRayColorOverride, ClearXRayOverrides() |
Inspect/reset X-Ray override |
IncludeChildren |
Include child renderers |
RefreshRenderers() |
Recollect renderers, submeshes and alpha-clipped materials after changes |
OutlinePulse¶
Frequency, UseUnscaledTime, PulseColor, ColorA, ColorB, PulseWidth, WidthA, WidthB.
IndicatorSystem¶
API declarations (not a component script):
public static Indicator ShowCircle(Vector3 center, float radius);
public static Indicator ShowRing(Vector3 center, float innerRadius, float outerRadius);
public static Indicator ShowCone(Vector3 origin, Vector3 direction, float angle, float range);
public static Indicator ShowLine(Vector3 origin, Vector3 direction, float length, float width);
public static Indicator ShowArrow(Vector3 origin, Vector3 direction, float length, float width);
public static Indicator ShowReticle(Vector3 center, float radius);
public static void Hide(Indicator indicator);
public static void HideAll();
public static int ActiveCount { get; }
Sizes use world units and angles degrees. Cone range maps to the returned handle's Radius.
Indicator¶
| Members | Purpose |
|---|---|
IsActive, Shape |
Active state and shape |
Position, Direction |
World position and flattened direction |
Radius, InnerRadius, Angle, Length, Width |
Shape dimensions |
Color, HasColor, ClearColor() |
Set/check/clear explicit color |
IsTargetValid, Progress, Fill, Texture |
Target validity, progress 0–1, fill style and art |
Hide() |
Hide and invalidate handles |
Copies share the same indicator. See handle lifecycle.
RangeIndicator¶
Shape, Radius, InnerRadius, Angle, Length, Width, UseColor, Color, IsTargetValid, Progress, Fill, Texture, Indicator (its handle).
HighlightRendererFeature¶
| Member | Purpose |
|---|---|
Instances (static) |
Loaded features, one per renderer asset |
Quality |
HighlightQuality |
InjectionPoint |
HighlightInjectionPoint |
DebugView |
HighlightDebugView |
Outline |
OutlineSettings; see Outline |
XRay |
XRaySettings; see X-Ray |
Indicators |
IndicatorSettings; see Indicators |
Changes take effect next frame. See runtime settings.
Enums¶
| Enum | Values |
|---|---|
HighlightQuality |
Low, Medium, High |
HighlightInjectionPoint |
BeforeRenderingPostProcessing, AfterRenderingPostProcessing |
HighlightDebugView |
None, Mask, Distance |
OutlineVisibility |
VisibleOnly, Always |
XRayPattern |
None, Scanlines, Dots |
IndicatorShape |
Circle, Ring, Cone, Line, Arrow, Reticle |
IndicatorFill |
Outward, Sweep |