public override float CalculateOffset(float spread, float size, float thickness)Calculates the offset of the reticle image based on the reticle spread and size. The offset is calculated differently based on the reticle type.
| spread | The amount of spread to apply. |
| size | The size of the reticle image. |
| thickness | The thickness of the reticle image. |
| float | The offset of the reticle image. |
public override float CalculateOffset(float spread, float size, float thickness)Calculates the offset of the reticle image based on the reticle spread and size. The offset is calculated differently based on the reticle type.
| spread | The amount of spread to apply. |
| size | The size of the reticle image. |
| thickness | The thickness of the reticle image. |
| float | The offset of the reticle image. |
public class CircularReticleSpread : PositionalReticleSpreadHandles reticle spread by changing the position of circular shaped reticle images.
| CalculateOffset | Calculates the offset of the reticle image based on the reticle spread and size. The offset is calculated differently based on the reticle type. |
| Update | Updates the reticle's spread by changing the transform of the image. |
public class CircularReticleSpread : PositionalReticleSpreadHandles reticle spread by changing the position of circular shaped reticle images.
| CalculateOffset | Calculates the offset of the reticle image based on the reticle spread and size. The offset is calculated differently based on the reticle type. |
| Update | Updates the reticle's spread by changing the transform of the image. |
public Color color { get; set; }The color of the reticle.
public Color color { get; set; }The color of the reticle.
public ReticleConfiguration config { get; }The crosshair reticle configuration being edited (Read only).
public ReticleConfiguration config { get; }The crosshair reticle configuration being edited (Read only).
public sealed class CrosshairEditor : MonoBehaviourProvides realtime editing of a simple crosshair reticle.
| reticle | The crosshair reticle being edited (Read only). |
| config | The crosshair reticle configuration being edited (Read only). |
| color | The color of the reticle. |
| size | The overall size of the reticle. |
| thickness | The thickness of the reticle crosshairs. |
| offset | The offset of the reticle images from the center point. The offset is used as the amount of spread for static reticles. |
| outline | Draws an outline around the reticle images. |
| outlineOpacity | The opacity of the reticle outline. |
| outlineThickness | The thickness of the reticle outline. |
public sealed class CrosshairEditor : MonoBehaviourProvides realtime editing of a simple crosshair reticle.
| reticle | The crosshair reticle being edited (Read only). |
| config | The crosshair reticle configuration being edited (Read only). |
| color | The color of the reticle. |
| size | The overall size of the reticle. |
| thickness | The thickness of the reticle crosshairs. |
| offset | The offset of the reticle images from the center point. The offset is used as the amount of spread for static reticles. |
| outline | Draws an outline around the reticle images. |
| outlineOpacity | The opacity of the reticle outline. |
| outlineThickness | The thickness of the reticle outline. |
public float offset { get; set; }The offset of the reticle images from the center point. The offset is used as the amount of spread for static reticles.
public float offset { get; set; }The offset of the reticle images from the center point. The offset is used as the amount of spread for static reticles.
public bool outline { get; set; }Draws an outline around the reticle images.
public bool outline { get; set; }Draws an outline around the reticle images.
public float outlineOpacity { get; set; }The opacity of the reticle outline.
public float outlineOpacity { get; set; }The opacity of the reticle outline.
public float outlineThickness { get; set; }The thickness of the reticle outline.
public float outlineThickness { get; set; }The thickness of the reticle outline.
public Reticle reticle { get; }The crosshair reticle being edited (Read only).
public Reticle reticle { get; }The crosshair reticle being edited (Read only).
public float size { get; set; }The overall size of the reticle.
public float size { get; set; }The overall size of the reticle.
public float thickness { get; set; }The thickness of the reticle crosshairs.
public float thickness { get; set; }The thickness of the reticle crosshairs.
public bool animatedFades the hitmarker in and out.
public bool animatedFades the hitmarker in and out.
public CanvasGroup canvasGroup { get; }The canvas group that sets the alpha of the hitmarker (Read only).
public CanvasGroup canvasGroup { get; }The canvas group that sets the alpha of the hitmarker (Read only).
public float durationThe amount of seconds the hitmarker stays active.
public float durationThe amount of seconds the hitmarker stays active.
public sealed class Hitmarker : MonoBehaviourAnimates a hitmarker reticle when triggered.
| canvasGroup | The canvas group that sets the alpha of the hitmarker (Read only). |
| duration | The amount of seconds the hitmarker stays active. |
| animated | Fades the hitmarker in and out. |
public sealed class Hitmarker : MonoBehaviourAnimates a hitmarker reticle when triggered.
| canvasGroup | The canvas group that sets the alpha of the hitmarker (Read only). |
| duration | The amount of seconds the hitmarker stays active. |
| animated | Fades the hitmarker in and out. |
public override void Update(RectTransform transform, ReticleConfiguration config, float spread, int index)Updates the reticle's spread by changing the transform of the image.
| transform | The transform of the reticle image to update. |
| config | The reticle configuration being used. |
| spread | The amount of spread to apply. |
| index | The index of the reticle image. The spread offset might depend on the index for cardinal images. |
public override void Update(RectTransform transform, ReticleConfiguration config, float spread, int index)Updates the reticle's spread by changing the transform of the image.
| transform | The transform of the reticle image to update. |
| config | The reticle configuration being used. |
| spread | The amount of spread to apply. |
| index | The index of the reticle image. The spread offset might depend on the index for cardinal images. |
public class NoReticleSpread : ReticleSpreadPrevents all reticle spread by ignoring updates.
| Update | Updates the reticle's spread by changing the transform of the image. |
public class NoReticleSpread : ReticleSpreadPrevents all reticle spread by ignoring updates.
| Update | Updates the reticle's spread by changing the transform of the image. |
public abstract float CalculateOffset(float spread, float size, float thickness)Calculates the offset of the reticle image based on the reticle spread and size. The offset is calculated differently based on the reticle type.
| spread | The amount of spread to apply. |
| size | The size of the reticle image. |
| thickness | The thickness of the reticle image. |
| float | The offset of the reticle image. |
public abstract float CalculateOffset(float spread, float size, float thickness)Calculates the offset of the reticle image based on the reticle spread and size. The offset is calculated differently based on the reticle type.
| spread | The amount of spread to apply. |
| size | The size of the reticle image. |
| thickness | The thickness of the reticle image. |
| float | The offset of the reticle image. |
public override void Update(RectTransform transform, ReticleConfiguration config, float spread, int index)Updates the reticle's spread by changing the transform of the image.
| transform | The transform of the reticle image to update. |
| config | The reticle configuration being used. |
| spread | The amount of spread to apply. |
| index | The index of the reticle image. The spread offset might depend on the index for cardinal images. |
public override void Update(RectTransform transform, ReticleConfiguration config, float spread, int index)Updates the reticle's spread by changing the transform of the image.
| transform | The transform of the reticle image to update. |
| config | The reticle configuration being used. |
| spread | The amount of spread to apply. |
| index | The index of the reticle image. The spread offset might depend on the index for cardinal images. |
public abstract class PositionalReticleSpread : ReticleSpreadHandles reticle spread by changing the position of the reticle image(s).
| Update | Updates the reticle's spread by changing the transform of the image. |
| CalculateOffset | Calculates the offset of the reticle image based on the reticle spread and size. The offset is calculated differently based on the reticle type. |
public abstract class PositionalReticleSpread : ReticleSpreadHandles reticle spread by changing the position of the reticle image(s).
| Update | Updates the reticle's spread by changing the transform of the image. |
| CalculateOffset | Calculates the offset of the reticle image based on the reticle spread and size. The offset is calculated differently based on the reticle type. |
public override float CalculateOffset(float spread, float size, float thickness)Calculates the offset of the reticle image based on the reticle spread and size. The offset is calculated differently based on the reticle type.
| spread | The amount of spread to apply. |
| size | The size of the reticle image. |
| thickness | The thickness of the reticle image. |
| float | The offset of the reticle image. |
public override float CalculateOffset(float spread, float size, float thickness)Calculates the offset of the reticle image based on the reticle spread and size. The offset is calculated differently based on the reticle type.
| spread | The amount of spread to apply. |
| size | The size of the reticle image. |
| thickness | The thickness of the reticle image. |
| float | The offset of the reticle image. |
public class RectangularReticleSpread : PositionalReticleSpreadHandles reticle spread by changing the position of rectangular shaped reticle images.
| CalculateOffset | Calculates the offset of the reticle image based on the reticle spread and size. The offset is calculated differently based on the reticle type. |
| Update | Updates the reticle's spread by changing the transform of the image. |
public class RectangularReticleSpread : PositionalReticleSpreadHandles reticle spread by changing the position of rectangular shaped reticle images.
| CalculateOffset | Calculates the offset of the reticle image based on the reticle spread and size. The offset is calculated differently based on the reticle type. |
| Update | Updates the reticle's spread by changing the transform of the image. |
public Color color { get; set; }The active color of the reticle.
public Color color { get; set; }The active color of the reticle.
public ReticleConfiguration config { get; set; }The configuration applied to the reticle.
public ReticleConfiguration config { get; set; }The configuration applied to the reticle.
public List<ReticleImage> images { get; }References of each child reticle image (Read only).
public List<ReticleImage> images { get; }References of each child reticle image (Read only).
public sealed class Reticle : MonoBehaviourGenerates and controls a reticle based on a set configuration.
| pregenerated | When set to false the reticle will be generated on start, otherwise it is assumed the reticle images are already created and configured. |
| images | References of each child reticle image (Read only). |
| spreader | Applies reticle spread to each image (Read only). |
| config | The configuration applied to the reticle. |
| color | The active color of the reticle. |
| spread | The amount of spread applied to the reticle. This is often used as an indication of a weapon's accuracy. |
public sealed class Reticle : MonoBehaviourGenerates and controls a reticle based on a set configuration.
| pregenerated | When set to false the reticle will be generated on start, otherwise it is assumed the reticle images are already created and configured. |
| images | References of each child reticle image (Read only). |
| spreader | Applies reticle spread to each image (Read only). |
| config | The configuration applied to the reticle. |
| color | The active color of the reticle. |
| spread | The amount of spread applied to the reticle. This is often used as an indication of a weapon's accuracy. |
public bool pregeneratedWhen set to false the reticle will be generated on start, otherwise it is assumed the reticle images are already created and configured.
public bool pregeneratedWhen set to false the reticle will be generated on start, otherwise it is assumed the reticle images are already created and configured.
public float spread { get; set; }The amount of spread applied to the reticle. This is often used as an indication of a weapon's accuracy.
public float spread { get; set; }The amount of spread applied to the reticle. This is often used as an indication of a weapon's accuracy.
public ReticleSpread spreader { get; }Applies reticle spread to each image (Read only).
public ReticleSpread spreader { get; }Applies reticle spread to each image (Read only).
public void Apply()Applies the bloom to the reticle.
public void Apply()Applies the bloom to the reticle.
public float baseSpread { get; }The base amount of spread on the reticle without bloom (Read only).
public float baseSpread { get; }The base amount of spread on the reticle without bloom (Read only).
public float bloom { get; }The current amount of bloom applied to the reticle (Read only).
public float bloom { get; }The current amount of bloom applied to the reticle (Read only).
public float decayRateHow quickly the reticle bloom decays back to zero.
public float decayRateHow quickly the reticle bloom decays back to zero.
public class ReticleBloom : MonoBehaviourHandles dynamically changing the spread of a reticle based on a given bloom amount. Bloom is a way of visualizing the accuracy of a weapon. The more bloom the less accurate a weapon is. Bloom is added and removed when the behavior is enabled or disabled, repectively.
| reticle | The reticle that the bloom effect is applied to. |
| spread | The amount of spread to apply to the reticle when bloomed. |
| maxSpread | The maximum amount of spread that can be applied to the reticle. |
| decayRate | How quickly the reticle bloom decays back to zero. |
| bloom | The current amount of bloom applied to the reticle (Read only). |
| baseSpread | The base amount of spread on the reticle without bloom (Read only). |
| Apply | Applies the bloom to the reticle. |
public class ReticleBloom : MonoBehaviourHandles dynamically changing the spread of a reticle based on a given bloom amount. Bloom is a way of visualizing the accuracy of a weapon. The more bloom the less accurate a weapon is. Bloom is added and removed when the behavior is enabled or disabled, repectively.
| reticle | The reticle that the bloom effect is applied to. |
| spread | The amount of spread to apply to the reticle when bloomed. |
| maxSpread | The maximum amount of spread that can be applied to the reticle. |
| decayRate | How quickly the reticle bloom decays back to zero. |
| bloom | The current amount of bloom applied to the reticle (Read only). |
| baseSpread | The base amount of spread on the reticle without bloom (Read only). |
| Apply | Applies the bloom to the reticle. |
public float maxSpreadThe maximum amount of spread that can be applied to the reticle.
public float maxSpreadThe maximum amount of spread that can be applied to the reticle.
public Reticle reticleThe reticle that the bloom effect is applied to.
public Reticle reticleThe reticle that the bloom effect is applied to.
public float spreadThe amount of spread to apply to the reticle when bloomed.
public float spreadThe amount of spread to apply to the reticle when bloomed.
Cardinal = 0Displays the reticle images along the cardinal axes.
Cardinal = 0Displays the reticle images along the cardinal axes.
Radial = 1Displays the reticle images in a radial pattern around the center point.
Radial = 1Displays the reticle images in a radial pattern around the center point.
public enum LayoutDetermines how the reticle images are displayed which changes how the reticle is positioned.
| Cardinal | Displays the reticle images along the cardinal axes. |
| Radial | Displays the reticle images in a radial pattern around the center point. |
public enum LayoutDetermines how the reticle images are displayed which changes how the reticle is positioned.
| Cardinal | Displays the reticle images along the cardinal axes. |
| Radial | Displays the reticle images in a radial pattern around the center point. |
Circular = 1Defines the reticle images as circular with a set radius.
Circular = 1Defines the reticle images as circular with a set radius.
Rectangular = 0Defines the reticle images as rectangular with a set width and height.
Rectangular = 0Defines the reticle images as rectangular with a set width and height.
public enum ShapeDefines the overall shape of the reticle images which changes how the reticle is sized.
| Rectangular | Defines the reticle images as rectangular with a set width and height. |
| Circular | Defines the reticle images as circular with a set radius. |
public enum ShapeDefines the overall shape of the reticle images which changes how the reticle is sized.
| Rectangular | Defines the reticle images as rectangular with a set width and height. |
| Circular | Defines the reticle images as circular with a set radius. |
Dynamic = 2Indicates the reticle has spread and the amount can change dynamically.
Dynamic = 2Indicates the reticle has spread and the amount can change dynamically.
None = 0Indicates the reticle does not spread.
None = 0Indicates the reticle does not spread.
Static = 1Indicates the reticle has spread but the amount does not change.
Static = 1Indicates the reticle has spread but the amount does not change.
public enum SpreadDetermines the behavior of the reticle spread.
| None | Indicates the reticle does not spread. |
| Static | Indicates the reticle has spread but the amount does not change. |
| Dynamic | Indicates the reticle has spread and the amount can change dynamically. |
public enum SpreadDetermines the behavior of the reticle spread.
| None | Indicates the reticle does not spread. |
| Static | Indicates the reticle has spread but the amount does not change. |
| Dynamic | Indicates the reticle has spread and the amount can change dynamically. |
public Vector3 centerThe center point of the reticle.
public Vector3 centerThe center point of the reticle.
public Color colorThe color of the reticle images.
public Color colorThe color of the reticle images.
public int elementsThe amount of images that make up the reticle.
public int elementsThe amount of images that make up the reticle.
public sealed class ReticleConfiguration : ScriptableObjectDefines all reticle configuration properties that can be saved as a predefined asset.
| sprite | The sprite rendered for each reticle image. |
| shape | The shape of the reticle images. |
| spread | The behavior of the reticle spread. |
| color | The color of the reticle images. |
| elements | The amount of images that make up the reticle. |
| layout | Determines how the reticle images are displayed. |
| center | The center point of the reticle. |
| size | The overall size of the reticle. |
| thickness | The thickness of reticle crosshairs (only applicable to rectangular shaped reticle images). |
| offset | The offset of the reticle images from the center point. The offset is used as the amount of spread for static reticles. |
| rotation | The local rotation of the reticle. |
| outline | Draws an outline around the reticle images. |
| outlineColor | The color of the reticle outline. |
| outlineDistance | The distance of the reticle outline effect from the base sprite. |
| mask | Applies a mask fill to the reticle. |
| maskFillAmount | The percentage of fill applied to the reticle mask. |
public sealed class ReticleConfiguration : ScriptableObjectDefines all reticle configuration properties that can be saved as a predefined asset.
| sprite | The sprite rendered for each reticle image. |
| shape | The shape of the reticle images. |
| spread | The behavior of the reticle spread. |
| color | The color of the reticle images. |
| elements | The amount of images that make up the reticle. |
| layout | Determines how the reticle images are displayed. |
| center | The center point of the reticle. |
| size | The overall size of the reticle. |
| thickness | The thickness of reticle crosshairs (only applicable to rectangular shaped reticle images). |
| offset | The offset of the reticle images from the center point. The offset is used as the amount of spread for static reticles. |
| rotation | The local rotation of the reticle. |
| outline | Draws an outline around the reticle images. |
| outlineColor | The color of the reticle outline. |
| outlineDistance | The distance of the reticle outline effect from the base sprite. |
| mask | Applies a mask fill to the reticle. |
| maskFillAmount | The percentage of fill applied to the reticle mask. |
public ReticleConfiguration.Layout layoutDetermines how the reticle images are displayed.
public ReticleConfiguration.Layout layoutDetermines how the reticle images are displayed.
public bool maskApplies a mask fill to the reticle.
public bool maskApplies a mask fill to the reticle.
public float maskFillAmountThe percentage of fill applied to the reticle mask.
public float maskFillAmountThe percentage of fill applied to the reticle mask.
public float offsetThe offset of the reticle images from the center point. The offset is used as the amount of spread for static reticles.
public float offsetThe offset of the reticle images from the center point. The offset is used as the amount of spread for static reticles.
public bool outlineDraws an outline around the reticle images.
public bool outlineDraws an outline around the reticle images.
public Color outlineColorThe color of the reticle outline.
public Color outlineColorThe color of the reticle outline.
public Vector2 outlineDistanceThe distance of the reticle outline effect from the base sprite.
public Vector2 outlineDistanceThe distance of the reticle outline effect from the base sprite.
public float rotationThe local rotation of the reticle.
public float rotationThe local rotation of the reticle.
public ReticleConfiguration.Shape shapeThe shape of the reticle images.
public ReticleConfiguration.Shape shapeThe shape of the reticle images.
public float sizeThe overall size of the reticle.
public float sizeThe overall size of the reticle.
public ReticleConfiguration.Spread spreadThe behavior of the reticle spread.
public ReticleConfiguration.Spread spreadThe behavior of the reticle spread.
public Sprite spriteThe sprite rendered for each reticle image.
public Sprite spriteThe sprite rendered for each reticle image.
public float thicknessThe thickness of reticle crosshairs (only applicable to rectangular shaped reticle images).
public float thicknessThe thickness of reticle crosshairs (only applicable to rectangular shaped reticle images).
public void Add(Reticle reticle)Adds a reticle to the group.
| reticle | The reticle to add. |
public void Add(Reticle reticle)Adds a reticle to the group.
| reticle | The reticle to add. |
protected virtual void Awake()A Unity lifecycle method called when the behavior is initialized.
protected virtual void Awake()A Unity lifecycle method called when the behavior is initialized.
public void Clear()Removes all reticles from the group.
public void Clear()Removes all reticles from the group.
public void Remove(Reticle reticle)Removes a reticle from the group.
| reticle | The reticle to remove. |
public void Remove(int index)Removes a reticle from the group at the given index.
| index | The index of the reticle to remove. |
public void Remove(Reticle reticle)Removes a reticle from the group.
| reticle | The reticle to remove. |
public void Remove(int index)Removes a reticle from the group at the given index.
| index | The index of the reticle to remove. |
public class ReticleGroup : MonoBehaviourGroups together multiple reticles into one.
| reticles | The reticles contained in the group (Read only). |
| Awake | A Unity lifecycle method called when the behavior is initialized. |
| Add | Adds a reticle to the group. |
| Remove | Removes a reticle from the group. |
| Clear | Removes all reticles from the group. |
public class ReticleGroup : MonoBehaviourGroups together multiple reticles into one.
| reticles | The reticles contained in the group (Read only). |
| Awake | A Unity lifecycle method called when the behavior is initialized. |
| Add | Adds a reticle to the group. |
| Remove | Removes a reticle from the group. |
| Clear | Removes all reticles from the group. |
public List<Reticle> reticles { get; protected set; }The reticles contained in the group (Read only).
public List<Reticle> reticles { get; protected set; }The reticles contained in the group (Read only).
public void SetMask(ReticleConfiguration.Shape shape, bool masked, float fillAmount)Sets or removes the image mask.
| shape | The shape of the reticle image, e.g., rectangular or circular. |
| masked | True to add the mask, false to remove it. |
| fillAmount | The amount of the image to show when masked. |
public void SetMask(ReticleConfiguration.Shape shape, bool masked, float fillAmount)Sets or removes the image mask.
| shape | The shape of the reticle image, e.g., rectangular or circular. |
| masked | True to add the mask, false to remove it. |
| fillAmount | The amount of the image to show when masked. |
public void SetOutline(bool outlined, Color color, Vector2 distance)Sets or removes an outline effect on the image.
| outlined | |
| color | The color of the outline effect. |
| distance | The distance of the outline effect. |
public void SetOutline(bool outlined, Color color, Vector2 distance)Sets or removes an outline effect on the image.
| outlined | |
| color | The color of the outline effect. |
| distance | The distance of the outline effect. |
public void SetPosition(Vector3 offset)Sets the local offset position of the reticle image.
| offset | The local offset position of the reticle image. |
public void SetPosition(Vector3 offset)Sets the local offset position of the reticle image.
| offset | The local offset position of the reticle image. |
public void SetRotation(float rotation, int index)Sets the rotation of the image.
| rotation | The rotation of the image as an angle in degrees. |
| index | The index of the image to factor into the amount of rotation. This is used to automatically rotate images in a pattern. |
public void SetRotation(float rotation, int index)Sets the rotation of the image.
| rotation | The rotation of the image as an angle in degrees. |
| index | The index of the image to factor into the amount of rotation. This is used to automatically rotate images in a pattern. |
public void SetSize(ReticleConfiguration.Shape shape, float size, float thickness)Sets the size of the reticle image.
| shape | The shape of the reticle image, e.g., rectangular or circular. |
| size | The length or radius of the reticle image depending on the image shape. |
| thickness | The thickness of the reticle image (only applicable to rectangular shaped images). |
public void SetSize(ReticleConfiguration.Shape shape, float size, float thickness)Sets the size of the reticle image.
| shape | The shape of the reticle image, e.g., rectangular or circular. |
| size | The length or radius of the reticle image depending on the image shape. |
| thickness | The thickness of the reticle image (only applicable to rectangular shaped images). |
public sealed class ReticleImage : ImageProvides methods to change the styling of a reticle image.
| SetSize | Sets the size of the reticle image. |
| SetPosition | Sets the local offset position of the reticle image. |
| SetRotation | Sets the rotation of the image. |
| SetMask | Sets or removes the image mask. |
| SetOutline | Sets or removes an outline effect on the image. |
public sealed class ReticleImage : ImageProvides methods to change the styling of a reticle image.
| SetSize | Sets the size of the reticle image. |
| SetPosition | Sets the local offset position of the reticle image. |
| SetRotation | Sets the rotation of the image. |
| SetMask | Sets or removes the image mask. |
| SetOutline | Sets or removes an outline effect on the image. |
public abstract void Update(RectTransform transform, ReticleConfiguration config, float spread, int index)Updates the reticle's spread by changing the transform of the image.
| transform | The transform of the reticle image to update. |
| config | The reticle configuration being used. |
| spread | The amount of spread to apply. |
| index | The index of the reticle image. The spread offset might depend on the index for cardinal images. |
public abstract void Update(RectTransform transform, ReticleConfiguration config, float spread, int index)Updates the reticle's spread by changing the transform of the image.
| transform | The transform of the reticle image to update. |
| config | The reticle configuration being used. |
| spread | The amount of spread to apply. |
| index | The index of the reticle image. The spread offset might depend on the index for cardinal images. |
public abstract class ReticleSpreadAn abstract type that defines how a reticle handles spread.
| Update | Updates the reticle's spread by changing the transform of the image. |
public abstract class ReticleSpreadAn abstract type that defines how a reticle handles spread.
| Update | Updates the reticle's spread by changing the transform of the image. |
public class ReticleTarget : MonoBehaviourIndicates an entity that can be targeted by a reticle.
| reticleColor | The color of the reticle when the target is looked at. |
public class ReticleTarget : MonoBehaviourIndicates an entity that can be targeted by a reticle.
| reticleColor | The color of the reticle when the target is looked at. |
public Color reticleColorThe color of the reticle when the target is looked at.
public Color reticleColorThe color of the reticle when the target is looked at.
public static Color cautiousA common color for cautious targets, usually yellow.
public static Color cautiousA common color for cautious targets, usually yellow.
public static Color friendlyA common color for friendly targets, usually green.
public static Color friendlyA common color for friendly targets, usually green.
public static Color hostileA common color for hostile targets, usually red.
public static Color hostileA common color for hostile targets, usually red.
public static class ColorsA set of colors that commonly represent targets.
| neutral | A common color for neutral targets, usually white. |
| friendly | A common color for friendly targets, usually green. |
| hostile | A common color for hostile targets, usually red. |
| cautious | A common color for cautious targets, usually yellow. |
public static class ColorsA set of colors that commonly represent targets.
| neutral | A common color for neutral targets, usually white. |
| friendly | A common color for friendly targets, usually green. |
| hostile | A common color for hostile targets, usually red. |
| cautious | A common color for cautious targets, usually yellow. |
public static Color neutralA common color for neutral targets, usually white.
public static Color neutralA common color for neutral targets, usually white.
public virtual void ChangeAppearance(ReticleTarget target)Changes the appearance of the reticle to reflect the target.
| target | The target to set the reticle apperance for. |
public virtual void ChangeAppearance(ReticleTarget target)Changes the appearance of the reticle to reflect the target.
| target | The target to set the reticle apperance for. |
public virtual void ResetAppearance()Resets the appearance of the reticle to the default reticle config.
public virtual void ResetAppearance()Resets the appearance of the reticle to the default reticle config.
public void Scan()Performs a scan to see if the reticle should change appearance based on the target object being looked at.
public void Scan()Performs a scan to see if the reticle should change appearance based on the target object being looked at.
public class ReticleTargeting : MonoBehaviourHandles changing the appearance of the reticle when targeting other objects. For example, the reticle might become red when targeting an enemy or green when targeting a friendly character.
| reticle | The reticle that changes color (Read only). |
| lookTransform | The transform from which raycasts originate, usually the camera. |
| scanRate | The amount of seconds between raycasts. |
| nextScanTime | The time at which the next scan will occur (Read only). |
| maxDistance | The max distance the ray can check for targets. |
| layerMask | The layers that can be targeted by the reticle. |
| Scan | Performs a scan to see if the reticle should change appearance based on the target object being looked at. |
| ChangeAppearance | Changes the appearance of the reticle to reflect the target. |
| ResetAppearance | Resets the appearance of the reticle to the default reticle config. |
public class ReticleTargeting : MonoBehaviourHandles changing the appearance of the reticle when targeting other objects. For example, the reticle might become red when targeting an enemy or green when targeting a friendly character.
| reticle | The reticle that changes color (Read only). |
| lookTransform | The transform from which raycasts originate, usually the camera. |
| scanRate | The amount of seconds between raycasts. |
| nextScanTime | The time at which the next scan will occur (Read only). |
| maxDistance | The max distance the ray can check for targets. |
| layerMask | The layers that can be targeted by the reticle. |
| Scan | Performs a scan to see if the reticle should change appearance based on the target object being looked at. |
| ChangeAppearance | Changes the appearance of the reticle to reflect the target. |
| ResetAppearance | Resets the appearance of the reticle to the default reticle config. |
public LayerMask layerMaskThe layers that can be targeted by the reticle.
public LayerMask layerMaskThe layers that can be targeted by the reticle.
public Transform lookTransformThe transform from which raycasts originate, usually the camera.
public Transform lookTransformThe transform from which raycasts originate, usually the camera.
public float maxDistanceThe max distance the ray can check for targets.
public float maxDistanceThe max distance the ray can check for targets.
public float nextScanTime { get; }The time at which the next scan will occur (Read only).
public float nextScanTime { get; }The time at which the next scan will occur (Read only).
public Reticle reticle { get; }The reticle that changes color (Read only).
public Reticle reticle { get; }The reticle that changes color (Read only).
public float scanRateThe amount of seconds between raycasts.
public float scanRateThe amount of seconds between raycasts.
public override void Update(RectTransform transform, ReticleConfiguration config, float spread, int index)Updates the reticle's spread by changing the transform of the image.
| transform | The transform of the reticle image to update. |
| config | The reticle configuration being used. |
| spread | The amount of spread to apply. |
| index | The index of the reticle image. The spread offset might depend on the index for cardinal images. |
public override void Update(RectTransform transform, ReticleConfiguration config, float spread, int index)Updates the reticle's spread by changing the transform of the image.
| transform | The transform of the reticle image to update. |
| config | The reticle configuration being used. |
| spread | The amount of spread to apply. |
| index | The index of the reticle image. The spread offset might depend on the index for cardinal images. |
public class ScalingReticleSpread : ReticleSpreadHandles reticle spread by scaling the reticle image(s) to increase the overall size.
| Update | Updates the reticle's spread by changing the transform of the image. |
public class ScalingReticleSpread : ReticleSpreadHandles reticle spread by scaling the reticle image(s) to increase the overall size.
| Update | Updates the reticle's spread by changing the transform of the image. |
Handles reticle spread by changing the position of circular shaped reticle images.
Provides realtime editing of a simple crosshair reticle.
Animates a hitmarker reticle when triggered.
Prevents all reticle spread by ignoring updates.
Handles reticle spread by changing the position of the reticle image(s).
Handles reticle spread by changing the position of rectangular shaped reticle images.
Generates and controls a reticle based on a set configuration.
Handles dynamically changing the spread of a reticle based on a given bloom amount. Bloom is a way of visualizing the accuracy of a weapon. The more bloom the less accurate a weapon is. Bloom is added and removed when the behavior is enabled or disabled, repectively.
Defines all reticle configuration properties that can be saved as a predefined asset.
Groups together multiple reticles into one.
Provides methods to change the styling of a reticle image.
An abstract type that defines how a reticle handles spread.
Indicates an entity that can be targeted by a reticle.
Handles changing the appearance of the reticle when targeting other objects. For example, the reticle might become red when targeting an enemy or green when targeting a friendly character.
A set of colors that commonly represent targets.
Handles reticle spread by scaling the reticle image(s) to increase the overall size.
Determines how the reticle images are displayed which changes how the reticle is positioned.
Defines the overall shape of the reticle images which changes how the reticle is sized.
Determines the behavior of the reticle spread.
Handles reticle spread by changing the position of circular shaped reticle images.
Provides realtime editing of a simple crosshair reticle.
Animates a hitmarker reticle when triggered.
Prevents all reticle spread by ignoring updates.
Handles reticle spread by changing the position of the reticle image(s).
Handles reticle spread by changing the position of rectangular shaped reticle images.
Generates and controls a reticle based on a set configuration.
Handles dynamically changing the spread of a reticle based on a given bloom amount. Bloom is a way of visualizing the accuracy of a weapon. The more bloom the less accurate a weapon is. Bloom is added and removed when the behavior is enabled or disabled, repectively.
Defines all reticle configuration properties that can be saved as a predefined asset.
Groups together multiple reticles into one.
Provides methods to change the styling of a reticle image.
An abstract type that defines how a reticle handles spread.
Indicates an entity that can be targeted by a reticle.
Handles changing the appearance of the reticle when targeting other objects. For example, the reticle might become red when targeting an enemy or green when targeting a friendly character.
A set of colors that commonly represent targets.
Handles reticle spread by scaling the reticle image(s) to increase the overall size.
Determines how the reticle images are displayed which changes how the reticle is positioned.
Defines the overall shape of the reticle images which changes how the reticle is sized.
Determines the behavior of the reticle spread.
All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.
Use the Unity Package Manager to install the UI Reticles package.
Window > Package ManagerImport the package namespace in each script or file you want to use it. You may need to regenerate project files/assemblies first.
using Zigurous.Reticles;
-Copyright (c) 2021 Zigurous. All Rights Reserved.
Copyright (c) 2021 Zigurous. All Rights Reserved.
The UI Reticles package provides customizable UI reticles and related scripts for controlling reticle behaviors in Unity. Included in the package are 12+ pre-configured reticles.