Skip to content

GUIComponent

Jump to bottom
Crusha K. Rool edited this page Feb 16, 2019 · 1 revision

Overview of the GUIComponent's most important variables and delegates.

Table of Contents

Important Variables

Contains a summary of possible and important variables to be set in the defaultproperties of the Component. Note that most of these variables are also to be used in the subclasses of GUIComponent.

bEnabled

  • Bool, True by default.
  • If True, process and draw this component otherwise skip it.

Tag

  • String, no default.
  • You should assign a unique Tag to each Component when you create it to find it later with GUIMenuScene.FindComponentByTag()

PosX, PosY

  • Float, no default.
  • This tells where to render the component in the HUD.

PosXEnd, PosYEnd

  • Float, no default.
  • This tells where to stop rendering the component in the HUD.

bRelativePosX, bRelativePosY, bRelativeWidth, bRelativeHeight

  • Bool, all True by default.
  • Use relative values instead of absolute ones (for PosX,PosY,PosXEnd and PosYEnd).

Priority

  • Int, 1 by default
  • The component with priority 0 will be drawn first and then the others in ascending order on top of it. Components with the same priority are drawn in the order they were created.

bCircularComponentShape

  • Bool, no default (False).
  • If True, perform enclosing checks against a circular shape rather than a box. This gives a more accurate representation for RadioButtons and similar. The diameter of the circle is the height of the Component.

Delegates

Note that Delegates have to be set at runtime, best in the MenuScene's PostBeginPlay().

On Become Enabled

Full: delegate OnBecomeEnabled(optional GUIComponent Component = self)

Called when the Component is enabled (bEnabled turns True).

On Become Disabled

Full: delegate OnBecomeDisabled(optional GUIComponent Component = self)

Called when the Component is disabled (bEnabled turns False).

On Mouse Entered

Full: delegate OnMouseEntered(optional GUIComponent Component = self)

Called when the Mouse enters the Components boundaries, as defined by PosX, PosY, PosXEnd and PosYEnd.

On Mouse Exited

Full: delegate OnMouseExited(optional GUIComponent Component = self)

Called when the Mouse exits the Components boundaries.

On Mouse Pressed

Full: delegate OnMousePressed(optional GUIComponent Component = self, optional byte ButtonNum)

Called when the component receives a mouse press.

On Mouse Released

Full: delegate OnMouseReleased(optional GUIComponent Component = self, optional byte ButtonNum)

Called when the mouse press stops.

On Mouse Clicked

Full: delegate OnMouseClicked(optional GUIComponent Component = self, optional byte ButtonNum)

Called when the component is clicked, currently not used.

On Mouse Wheel Up

Full: delegate OnMouseWheelUp(optional GUIComponent Component = self)

Called when the mousewheel is scrolled up and this component receives that input.

On Mouse Wheel Down

Full: delegate OnMouseWheelDown(optional GUIComponent Component = self)

Called when the mousewheel is scrolled down and this component receives that input.

On Property Changed

Full: delegate OnPropertyChanged(optional GUIComponent Component = self)

  • General purpose delegate that gets called by appropriate subclasses when their represented property changes.
  • For instance when a slider gets moved or a checkbox gets ticked or a combobox gets a new member selected.
Called when a specific property gets changed. Only implemented in:
  • GUICheckButtonComponent, when the bChecked value changes.
  • GUIBaseSliderComponent, when the GUISliderButtonComponent changes position and thus changes the Sliders progress.

On Input Key

Full: delegate bool OnInputKey( int ControllerId, name Key, EInputEvent Event, float AmountDepressed = 1.f, bool bGamepad = FALSE )

Called when the component receives a key input.

Used in the example content mainly to detect Enter and Escape input, though some components also process other inputs by default.

  • Process an input key event routed through unrealscript from another object. This method is assigned as the value for the
  • OnRecievedNativeInputKey delegate so that native input events are routed to this unrealscript function.
  • @param ControllerId the controller that generated this input key event
  • @param Key the name of the key which an event occured for (KEY_Up, KEY_Down, etc.)
  • @param EventType the type of event which occured (pressed, released, etc.)
  • @param AmountDepressed for analog keys, the depression percent.
  • @return true to consume the key event, false to pass it on.
Clone this wiki locally