Skip to content

GUIVisualComponent

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

Base class for all components that draw Textures or Materials on the screen.

Table of Contents

Important Variables

bCanDrag

  • Bool.
  • Wether or not the component can be dragged when clicked on.

bLimitXAxis, bLimitYAxis

  • Bool.
  • If True, limits the dragging of the component.

LimitX, LimitY

  • Float.
  • Limit relative to the starting position.
  • Only used when bLimiXAxis/bLimiYAxis are True.

bCanReceiveDrop

  • Bool.
  • If True, another Component can be dropped upon this one.

Connect Class

  • ConnectClass
  • Class [GUIVisualComponent].
  • If this component can receive a drop, this is the class that should be dropped upon it.
  • Only used when bCanReceiveDrop is True.

bNoConnect

  • Bool.
  • If True, this component will be dropped where released, not only when there is a component below it that can receive the drop.

bCanHaveSelection, bCanHaveClickSelection, bCanBePressed

  • Bool.
  • If True, this component can be focused by a cursor over it / can be selected with a click / can be pressed.

bFitComponentToTexture

  • Bool.
  • Use the Texture as reference size instead matching it to the component.
  • Only takes the first DrawInfo into account.

Forced Draw Info

  • ForcedDrawInfo
  • Byte, 255 by default.
  • Can be used to force a specific DrawIndex to be used for the component.

Visual Render Info

  • (underscore)VisualRenderInfo
  • Struct, not an actual variable, see DrawInfo below.
  • Contains:

bUseMaterial

  • Bool.
  • Use Material instead of Texture.

Component Texture

  • ComponentTexture
  • Texture2D.
  • Texture to be drawn, only used when bUseMaterial is False.

Component Material

  • ComponentMaterial
  • Material.
  • Material to be drawn, only used when bUseMaterial is True.
  • Note that only the emissive channel is drawn.

Texture Scale

  • TextureScale
  • Float, 1.0 by default.
  • he texture is scaled by this factor in relation to the component boundaries.

bStretchHorizontally, bStretchVertically

  • Bool.
  • Stretching means that pixels in the center of the Texture are stretched while the boarder remains untouched to fit the texture to the size of the component.

SubUVStart

  • Vector2D.
  • Coordinates within the actual Texture/Material that describe where the top-left corner is for drawing.
  • Note that these are pixel values for the Texture/Material.

SubUVEnd

  • Vector2D.
  • Coordinates within the actual Texture/Material that describe where the bottom-right corner is for drawing.
  • Note that these are pixel values for the Texture/Material.
  • Important: these pixel values are relative to the SubUVStart values, when SubUVEnd.X is 19, that means the image will be 19 pixels wide from SubUVStart.X.

Draw Color

  • DrawColor
  • Color, White by default (R=255,G=255,B=255,A=255).
  • Color and transparency that the component will be drawn with.

Draw Info

  • DrawInfo
  • Array of GUITextureDrawInfo objects, which define what to draw and how to draw it.
  • By default ranges from 0-3, and defaults to 0 in all cases for VisualComponent. The current DrawIndex chooses which of the DrawInfos are used and is by default depending on the current state of the component, i.e. neutral, focused, pressed or selected.
  • Determines what image is drawn within the component.
Clone this wiki locally