Back To Index

FloatingBar

Jump To Parameters
Jump To Function Definitions

Parameter Definitions

Select the parameter name from below to jump directly to it on this page.

allImages
allTexts
colorBarFillOffset
coloredBar
controller
displayBarNumber
displayTime
displayType
fadeOut
fadeSpeed
fillBar
fillDelay
fillSpeed
onlyEnableForNoneOwner
realTimeTracking
startHidden
type

allImages

All images to fade in and out

Back To Top

allTexts

All texts to fade in and out

Back To Top

colorBarFillOffset

If the bars are not quite the same size then you need to have the bars at a different fill amount.”
Use this offset to achieve this

Back To Top

coloredBar

The actual colored bar to resize according to the selected number.

Back To Top

controller

Required if using real time tracking. Will always keep track of the “
values in the controller and update the bars for you.

Back To Top

displayBarNumber

The text to show based on the current value of your bar.

Back To Top

displayTime

How long to display this UI before disabling it after a change (Only matters if fade out is true).

Back To Top

displayType

How to display your tracked number in the displayBarNumber field.\n\n”
Whole = Convert float to int.\n”
Percent = Convert the number to a percent value\n”
Raw = Display the raw tracked number

Back To Top

fadeOut

Instead of just turning off the elements you want to slowly fade this images out.

Back To Top

fadeSpeed

How fast to fade the texts/images.

Back To Top

fillBar

Will adjust a set delay later after the colored bar.

Back To Top

fillDelay

How long to wait before adjusting the fill bar.

Back To Top

fillSpeed

How fast to adjust the fill bar.

Back To Top

onlyEnableForNoneOwner

Only show this bar if this is a networked player that you are not controlling. (i.e. other players that are not you)

Back To Top

realTimeTracking

If you want to have this function be the thing that is keeping “
track of the values. Uses the update method. Less efficent but saves “
you some extra work.

Back To Top

startHidden

Will only display for set amount of time only if the tracked number changes.

Back To Top

type

What type of floating bar is this?\n\n”
Health = Track the vThirdPersonController’s health.\n”
Stamina = Track the vThirdPersonController’s stamina\n”
Custom = Input a custom component that exposes a function called "CustomOutputValue" “
that outputs a float value for you to track.

Back To Top

Function Definitions

Select the function name from below to jump directly to it on this page.

Awake
DelayAdjustFillBar
DelayFadeElements
GetRemaining
GetWholeNumber
SetBarValue
SetElementsAlpha
Start
Update
UpdateMaxValue
UpdateTrackedValue

protected virtual void Awake()

Sets the starting fill amount and the starting alpha values.

No parameters

Back To Top

protected virtual IEnumerator DelayAdjustFillBar()

Makes it so the fill amount doesn’t adjust to the new amount for a few seconds. The wait time is based on the fillDelay parameter.

No parameters

Back To Top

protected virtual IEnumerator DelayFadeElements()

Will not fade the elements after changing for a few seconds. Then calls the SetElementsAlpha function.

No parameters

Back To Top

protected virtual float GetRemaining()

Returns a percentage float comparing the current with the max values.

No parameters

Back To Top

protected virtual int GetWholeNumber()

Returns the current value as a whole number

No parameters

Back To Top

protected virtual void SetBarValue()

Sets the text and fill amounts based on the displayType parameter.

No parameters

Back To Top

protected virtual void SetElementsAlpha(float setAlpha)

Sets the alpha values on the images and text elements in the allTexts and allImages list.

Back To Top

protected virtual void Start()

Finds and sets the bar values based on the current settings in the vThirdPersonController

No parameters

Back To Top

protected virtual void Update()

Dynamically updates the alpha and fill amount values based on changes in the vThirdPersonController and the settings on this component.

No parameters

Back To Top

public virtual void UpdateMaxValue(float value)

Can override the max value to compare against. This value is used to display percentages. This is normally the maxStamina or maxHealth values in the vThirdPersonController.

Back To Top

public virtual void UpdateTrackedValue(float value)

Can override the value to be displayed. This is normally the currentHealth or currentStamina in the vThirdPersonController

Back To Top