Gorilla.UI.Dialogue.Overlay

Fields

• protected FItem : TGorillaDialogueCustomItem
  

Methods

• public constructor Create  ( AOwner :  TComponent ) ;
• public destructor Destroy  ( ) ;
• protected procedure SetItem  ( const  AValue :  TGorillaDialogueCustomItem ) ;  virtual;

  Updates the internal item link.

Properties

• public Item : TGorillaDialogueCustomItem

  A connected item for this overlay.

  read FItem
  write SetItem
  

Fields

• protected FRectangle : TRectangle
  
• protected FCharacter : TLabel
  
• protected FText : TLabel
  

Methods

• public constructor Create  ( AOwner :  TComponent ) ;
• public destructor Destroy  ( ) ;
• protected procedure DoSetText  ( ) ;  abstract virtual;

  This abstract method updates the embedded text label depending on the linked item.

• protected procedure DoSetCharacterText  ( ) ;  abstract virtual;

  This abstract method updates the embedded character label depending on the linked item.

• protected procedure DoAddCharacterTextLabel  ( ) ;  virtual;

  This method adds the character text label to the overlay. By default this method is not called.

Properties

• published Character : TLabel

  Default character label for displaying the display name of the specific item.

  read FCharacter
  
• published Text : TLabel

  Default text label for displaying the dialogue item text.

  read FText
  

Fields

• protected FAnswers : TObjectList<Gorilla.UI.Dialogue.Overlay.TGorillaDialogueAnswerOverlay>
  

Methods

• public constructor Create  ( AOwner :  TComponent ) ;
• public destructor Destroy  ( ) ;
• protected procedure SetItem  ( const  AValue :  TGorillaDialogueCustomItem ) ;  override;

  Updates the internal item link.

• protected procedure DoSetText  ( ) ;  override;

  This method updates the embedded text label depending on the linked item.

• protected procedure DoSetCharacterText  ( ) ;  override;

  This method updates the embedded character label depending on the linked item.

• public procedure ClearAnswers  ( ) ;  virtual;

  Removes all answer overlays from the question overlay.

Methods

• public constructor Create  ( AOwner :  TComponent ) ;
• public destructor Destroy  ( ) ;
• protected procedure SetItem  ( const  AValue :  TGorillaDialogueCustomItem ) ;  override;

  Updates the internal item link.

• protected procedure DoSetText  ( ) ;  override;

  This method updates the embedded text label depending on the linked item.

• protected procedure DoOnClick  ( ASender :  TObject ) ;  virtual;

  This method will automatically be executed if user clicked on the overlay.

• protected procedure DoSetCharacterText  ( ) ;  override;

Methods

• public constructor Create  ( AOwner :  TComponent ) ;
• public destructor Destroy  ( ) ;
• protected procedure SetItem  ( const  AValue :  TGorillaDialogueCustomItem ) ;  override;

  Updates the internal item link.

• protected procedure DoSetText  ( ) ;  override;

  This method updates the embedded text label depending on the linked item.

• protected procedure DoSetCharacterText  ( ) ;  override;

  This method updates the embedded character label depending on the linked item.

• protected procedure DoOnClick  ( ASender :  TObject ) ;  virtual;

  This method will automatically be executed if user clicked on the overlay.

Fields

• protected FDialogue : TGorillaDialogue
  
• protected FOverlays : TObjectList<Gorilla.UI.Dialogue.Overlay.TGorillaDialogueOverlay>
  
• protected FTimers : TObjectList<FMX.Types.TTimer>
  
• protected FViewport : TComponent
  
• protected FAudioManager : TObject
  
• protected FAudioChannels : TAudioChannels
  
• protected FOnStart : TNotifyEvent
  
• protected FOnStop : TNotifyEvent
  

Methods

• public constructor Create  ( AOwner :  TComponent ) ;
• public destructor Destroy  ( ) ;
• protected procedure SetViewport  ( const  AValue :  TComponent ) ;  virtual;
• protected procedure SetAudioManager  ( const  AValue :  TObject ) ;  virtual;
• protected procedure SetDialogue  ( const  AValue :  TGorillaDialogue ) ;  virtual;

  Sets the internal dialogue link.

• protected procedure DoExecuteEvent  ( const  AEvent :  TGorillaDialogueItemEvent; const  AScope :  TObject ) ;  virtual;
• protected procedure ExecuteEvent  ( const  AEvent :  TGorillaDialogueItemEvent; const  AScope :  TObject ) ;  virtual;

  Executes a specific dialogue item event.

• protected procedure ExecuteSubEvent  ( const  AEvent :  TGorillaDialogueItemEvent; const  AScope :  TObject ) ;  virtual;

  Executes a specific dialogue item event.

• protected procedure StopEvent  ( const  AEvent :  TGorillaDialogueItemEvent; const  AScope :  TObject ) ;

  Stops a specific event from execution. This method is used in the OnItemEventEnd callback to stop audio playback while an item was skipped.

• protected procedure DoOnEventTimer  ( ASender :  TObject ) ;  virtual;

  This is the callback method for defined "timer" item events. It will automatically remove the timer on callback. It also will automatically call the linked event by the ExecuteEvent() method.

• protected procedure DoOnAnimationFinished  ( ASender :  TObject ) ;  virtual;

  This is the internal callback method when a TAnimation is finished.

• protected procedure DoOnBeginDialogueItem  ( const  AItem :  TGorillaDialogueItem; const  AItems :  TArray<Gorilla.Utils.Dialogue.System.TGorillaDialogueItem> ) ;  virtual;

  This is the internal callback method when an item is about to be displayed.

• protected procedure DoOnEndDialogueItem  ( const  AItem :  TGorillaDialogueItem ) ;  virtual;

  This is the internal callback method, when an item is about to be stopped.

• protected procedure DoOnBeginDialogueItemEvent  ( const  AEvent :  TGorillaDialogueItemEvent; const  AScope :  TObject; var  AHandled :  Boolean ) ;  virtual;

  This is the internal callback method when an event is about to be started.

• protected procedure DoOnEndDialogueItemEvent  ( const  AEvent :  TGorillaDialogueItemEvent; const  AScope :  TObject ) ;  virtual;

  This is the internal callback method when an event is about to be stopped.

• protected procedure DoOnStartDialogue  ( const  ADialogue :  TGorillaDialogue; const  AItems :  TArray<Gorilla.Utils.Dialogue.System.TGorillaDialogueItem> ) ;  virtual;

  This is the internal callback method when a dialogue was started.

• protected procedure DoOnStopDialogue  ( const  ADialogue :  TGorillaDialogue ) ;  virtual;

  This is the internal callback method when a dialogue was stopped.

• protected procedure DoShowItem  ( const  AItem :  TGorillaDialogueItem; const  ADoStartItem :  Boolean ) ;  virtual;

  Visualizes a specific item as overlay component inside of the HUD. If the DoStartItem argument is set, the method will automatically start execution of the provided item.

• protected procedure DoShowItems  ( const  AItems :  TArray<Gorilla.Utils.Dialogue.System.TGorillaDialogueItem> ) ;  virtual;

  Iterates through the given item list an executes the DoShowItem() method for each element.

• protected procedure DoStartItems  ( const  AItems :  TArray<Gorilla.Utils.Dialogue.System.TGorillaDialogueItem> ) ;  virtual;

  Iterates through the given dialogue item list and starts all items.

• public procedure Start  ( ) ;  virtual;

  Starts the applied dialogue.

• public procedure Stop  ( ) ;  virtual;

  Stops a currently active dialogue.

• public procedure Clear  ( const  AClearAll :  Boolean  =  False ) ;  virtual;

  Clears all currently available overlays from the HUD component.

• public procedure ClearTimers  ( const  AClearAll :  Boolean ) ;  virtual;

  Clears all timers. If AClearAll is set to false, the method will only clear local timers.

• public function FindElement  ( const  AParent :  TFmxObject; const  AName :  string; const  ADeep :  Boolean )  : TFmxObject ;  virtual;

  Tries to find a specific component identified by its name.

Properties

• public Dialogue : TGorillaDialogue

  A connected dialogue.

  read FDialogue
  write SetDialogue
  
• public Overlays : TObjectList<Gorilla.UI.Dialogue.Overlay.TGorillaDialogueOverlay>

  Returns the list of currently used overlay components.

  read FOverlays
  
• public Timers : TObjectList<FMX.Types.TTimer>

  Returns the list of currently activated timers for event callbacks.

  read FTimers
  
• published Viewport : TComponent

  A connected Gorilla Viewport.

  read FViewport
  write SetViewport
  
• published AudioManager : TObject

  A connected audio manager component.

  read FAudioManager
  write SetAudioManager