Screen & Edge Overlay

v1.0

You can set and reset overrides through the Northstar Overlay component (child of your Canvas), or on the individual Northstar Icons, whichever works best for your use case.

Reference Northstar Overlay:

NorthstarOverlay.Instance.SetOverrideColor("Default", Color.Blue);

Get a reference to Northstar Overlay to call the Set and Reset methods, such as using Northstar.Instance

Available Runtime Overrides

Remember, each Set method will have two signatures, one for a single icon, and one for all of a string type. There will also be two Reset methods for each. Each Set method will take in an appropriate value as well.

// Clamps the maximum opacity for the icon.
SetOverrideMaxOpacity(northstarIcon, 0.5f);
ResetOverrideMaxOpacity(northstarIcon);

// Clamps the maximum icon size.
SetOverrideMaxSize(northstarIcon, 30);
ResetOverrideMaxSize(northstarIcon);


// Sets the color of each of the icons
// NOTE: Compass Bar color handled by NorthstarCompassbar!
SetOverrideColor(northstarIcon, Color.Cyan); // Sets both Screen & Edge Overlay
ResetOverrideColor(northstarIcon); // Sets both Screen & Edge Overlay

SetOverrideScreenColor(northstarIcon, Color.Cyan); // Screen Overlay Only
ResetOverrideScreenColor(northstarIcon); // Screen Overlay Only

SetOverrideEdgeColor(northstarIcon, Color.Cyan); // Edge Overlay Only
ResetOverrideEdgeColor(northstarIcon); // Edge Overlay Only

// Sets the sprite to use for the icon. Color and opacity are handled separately.
SetOverrideSprite(northstarIcon, newSpriteValue);
ResetOverrideSprite(northstarIcon);


// Sets the color of the "Arrow" icon at the edge overlay
// Note: "Initial" color is the color when the arrow starts to appear
// Note: Opacity is controlled by the maximum opacity of the icon!
SetOverrideArrowColor(northstarIcon, Color.Yellow);
ResetOverrideArrowColor(northstarIcon);

SetOverrideArrowColorInitial(northstarIcon, Color.Yellow);
ResetOverrideArrowColorInitial(northstarIcon);


// Sets the minimum distance at which the distance opacity starts being affected. 
// (i.e. everything closer than this value is 100% "visible")
SetOverrideDistanceMin(northstarIcon, 50); // Sets both Screen & Edge Overlay
ResetOverrideDistanceMin(northstarIcon); // Sets both Screen & Edge Overlay

SetOverrideScreenDistanceMin(northstarIcon, 50); // Screen Overlay Only
ResetOverrideScreenDistanceMin(northstarIcon); // Screen Overlay Only

SetOverrideEdgeDistanceMin(northstarIcon, 50); // Edge Overlay Only
ResetOverrideEdgeDistanceMin(northstarIcon); // Edge Overlay Only


// Sets the maximum distance at which the distance opacity fades out. 
// (i.e. everything further than this value is 0% "visible")
SetOverrideDistanceMax(northstarIcon, 200); // Sets both Screen & Edge Overlay
ResetOverrideDistanceMax(northstarIcon); // Sets both Screen & Edge Overlay

SetOverrideScreenDistanceMax(northstarIcon, 200); // Screen Overlay Only
ResetOverrideScreenDistanceMax(northstarIcon); // Screen Overlay Only

SetOverrideEdgeDistanceMax(northstarIcon, 200); // Edge Overlay Only
ResetOverrideEdgeDistanceMax(northstarIcon); // Edge Overlay Only