ORK Framework  2.31.0
API Documentation
ORKFramework.GUIBoxContent Class Referenceabstract
Inheritance diagram for ORKFramework.GUIBoxContent:
ORKFramework.BestiaryHUDContent ORKFramework.CombatantHUDContent ORKFramework.ConsoleHUDContent ORKFramework.ControlHUDContent ORKFramework.DialogueContent ORKFramework.DragContent ORKFramework.ImageContent ORKFramework.InformationHUDContent ORKFramework.InteractionHUDContent ORKFramework.NavigationHUDContent ORKFramework.ObjectHUDContent ORKFramework.QuantityContent ORKFramework.QuestHUDContent ORKFramework.TimebarHUDContent ORKFramework.TooltipHUDContent ORKFramework.ValueInputContent

Public Member Functions

virtual void RegisterChanges ()
virtual void UnregisterChanges ()
virtual void Clear ()
virtual void CheckScrollKey ()
virtual void Tick ()
virtual void StartClosing ()
virtual void Closed ()
abstract void Init (GUIBox box)
abstract void ShowBefore ()
abstract void ShowAfter ()
abstract void ShowWindow ()
virtual void SetTabs (ChoiceContent[] tabs, int selection)
virtual void InitTabs (ChoiceContent[] tabs, ref ChoiceContent tabsLeftArrow, ref ChoiceContent tabsRightArrow, ref Rect textBounds, ref Rect tabsContentBounds, ref Rect tabsBounds, ref bool tabsScrollButtons, ref float tabsHeight, ref int tabsScrollOffset)
virtual void CreateNewUI ()
void CreateTabsObjects (Rect tabsContentBounds, Rect tabsBounds, ChoiceContent[] tabs, bool tabsScrollButtons, ChoiceContent leftArrow, ChoiceContent rightArrow, int scrollOffset, ButtonClick callback)
void InitializePortrait (IPortrait portrait)
void ClearInitializedPortraits ()
void StorePortraitsUpdate ()
void ClearPortraitsUpdate ()
void CreatePortraitObject (IPortrait portrait, PortraitPosition portraitPosition)
virtual void OkPressed (bool fireOnClick)
virtual bool ExternalOk ()
virtual void CancelPressed (bool fireOnClick)
void OkCancelPressed (int index)
void ShowButtons ()
virtual void ShowSelectionIcon ()
virtual void FocusGained ()
virtual void FocusLost ()
virtual void CheckUnfocusedClick ()
void SetName (string newName)
void ShowName ()
void CalculateName ()
virtual void GetInBoxPosition (ref Vector2 position)
 Transforms a screen position to box-content position. More...
virtual void GetOutOfBoxPosition (ref Vector2 position)
 Transforms an box-content position to screen position. More...
virtual bool InBox (Vector2 position)
virtual bool InContentBounds (Vector2 position)
bool CheckDragWindow (Vector2 position)
virtual DragInfo GetDragOnPosition (Vector2 position)
virtual bool CheckDrop (DragInfo drag, Vector2 position, ref GUIBoxAudioType playDropAudio)
virtual IContentSimple GetTooltip (Vector2 position)
virtual IContentSimple GetTabTooltip (Vector2 position, ChoiceContent[] tabs, Rect contentBounds, Rect bounds, int scrollOffset)
virtual IContentSimple GetSelectedTooltip ()
virtual bool MouseOverSelection (Vector2 position)
virtual bool CheckClick (Vector2 position, float releasedAfter, ref bool clickConsumed, ref bool toForeground)
virtual void OutOfBoxClick (Vector2 position)

Protected Member Functions

virtual bool IsInterfaceTick ()
void AdjustVerticalContentPosition (float change)
virtual bool IsContentVisible (Rect bounds)
virtual void StartTextTyping ()
virtual void TextTypingFinished ()
virtual void TextTypingTick (MultiContent content)
GameObject UpdatePanel ()
void CalculateButtons ()
void CreateNewUIButtons ()
void DrawChoiceIcon (Rect choiceRect)

Protected Attributes

GUIBox box
IChoice controlInterface
bool newContent = true
int selection = 0
int tabsSelection = 0
float tabsTopOffset = 0
string name = ""
bool newName = false
MultiContent nameContent
int typingIndex = 0
bool isTyping = false
float typingInterval = 0
float typingAudioInterval = 0
GUIBoxButtons okCancelSettings
ChoiceContent ok
ChoiceContent cancel
Vector2 scroll = Vector2.zero
Rect contentBounds
Rect scrollRect
bool iconFadingBack = false
Vector2 iconFadePos = Vector2.zero
float iconTime = 0
List< IPortraitportraitsInitialized
List< IPortraitportraitsClearUpdate
GameObject contentObject
GameObject scrollObject
GameObject scrollbarObject
GameObject tabsContent
RectTransform tabsRect
RectTransform scrollRectTransform
RectTransform choiceIconObject
GameObject portraitWrapper


GUIBox Box [get, set]
IChoice ControlInterface [get, set]
bool NewContent [get, set]
bool NewName [get, set]
Vector2 Scroll [get, set]
virtual bool IsTooltip [get]
virtual int Selection [get, set]
virtual int TabsSelection [get]

Member Function Documentation

◆ GetInBoxPosition()

virtual void ORKFramework.GUIBoxContent.GetInBoxPosition ( ref Vector2  position)

Transforms a screen position to box-content position.

positionThe screen position.

◆ GetOutOfBoxPosition()

virtual void ORKFramework.GUIBoxContent.GetOutOfBoxPosition ( ref Vector2  position)

Transforms an box-content position to screen position.

positionThe box-content position.