v3.6.1 Documentation
Fungus.ObjectClicked Class Reference

The block will execute when the user clicks or taps on the clickable object. More...

Inheritance diagram for Fungus.ObjectClicked:
Fungus.EventHandler

Classes

class  ObjectClickedEvent
 

Public Member Functions

virtual void OnObjectClicked (Clickable2D clickableObject)
 Called by the Clickable2D object when it is clicked. More...
 
override string GetSummary ()
 Returns custom summary text for the event handler. More...
 
- Public Member Functions inherited from Fungus.EventHandler
virtual bool ExecuteBlock ()
 The Event Handler should call this method when the event is detected to start executing the Block. More...
 

Protected Member Functions

virtual void OnEnable ()
 
virtual void OnDisable ()
 
virtual IEnumerator DoExecuteBlock (int numFrames)
 Executing a block on the same frame that the object is clicked can cause input problems (e.g. More...
 

Protected Attributes

Clickable2D clickableObject
 
int waitFrames = 1
 
EventDispatcher eventDispatcher
 
- Protected Attributes inherited from Fungus.EventHandler
Block parentBlock
 

Additional Inherited Members

- Properties inherited from Fungus.EventHandler
virtual Block ParentBlock [get, set]
 The parent Block which owns this Event Handler. More...
 

Detailed Description

The block will execute when the user clicks or taps on the clickable object.

Definition at line 16 of file ObjectClicked.cs.

Member Function Documentation

◆ DoExecuteBlock()

virtual IEnumerator Fungus.ObjectClicked.DoExecuteBlock ( int  numFrames)
protectedvirtual

Executing a block on the same frame that the object is clicked can cause input problems (e.g.

auto completing Say Dialog text). A single frame delay fixes the problem.

Definition at line 59 of file ObjectClicked.cs.

◆ GetSummary()

override string Fungus.ObjectClicked.GetSummary ( )
virtual

Returns custom summary text for the event handler.

Reimplemented from Fungus.EventHandler.

Definition at line 90 of file ObjectClicked.cs.

◆ OnDisable()

virtual void Fungus.ObjectClicked.OnDisable ( )
protectedvirtual

Definition at line 42 of file ObjectClicked.cs.

◆ OnEnable()

virtual void Fungus.ObjectClicked.OnEnable ( )
protectedvirtual

Definition at line 35 of file ObjectClicked.cs.

◆ OnObjectClicked()

virtual void Fungus.ObjectClicked.OnObjectClicked ( Clickable2D  clickableObject)
virtual

Called by the Clickable2D object when it is clicked.

Definition at line 82 of file ObjectClicked.cs.

Member Data Documentation

◆ clickableObject

Clickable2D Fungus.ObjectClicked.clickableObject
protected

Definition at line 28 of file ObjectClicked.cs.

◆ eventDispatcher

EventDispatcher Fungus.ObjectClicked.eventDispatcher
protected

Definition at line 33 of file ObjectClicked.cs.

◆ waitFrames

int Fungus.ObjectClicked.waitFrames = 1
protected

Definition at line 31 of file ObjectClicked.cs.


The documentation for this class was generated from the following file: