v3.6.1 Documentation
Fungus.EventHandler Class Reference

A Block may have an associated Event Handler which starts executing commands when a specific event occurs. More...

Inheritance diagram for Fungus.EventHandler:
Fungus.AnimatorState Fungus.ApplicationState Fungus.ButtonClicked Fungus.DragCancelled Fungus.DragCompleted Fungus.DragEntered Fungus.DragExited Fungus.DragStarted Fungus.EndEdit Fungus.FlowchartEnabled Fungus.GameStarted Fungus.KeyPressed Fungus.MessageReceived Fungus.Mouse Fungus.ObjectClicked Fungus.Render Fungus.SavePointLoaded Fungus.TagFilteredEventHandler Fungus.ToggleChanged Fungus.TransformChanged Fungus.UpdateTick

Public Member Functions

virtual bool ExecuteBlock ()
 The Event Handler should call this method when the event is detected to start executing the Block. More...
 
virtual string GetSummary ()
 Returns custom summary text for the event handler. More...
 

Protected Attributes

Block parentBlock
 

Properties

virtual Block ParentBlock [get, set]
 The parent Block which owns this Event Handler. More...
 

Detailed Description

A Block may have an associated Event Handler which starts executing commands when a specific event occurs.

To create a custom Event Handler, simply subclass EventHandler and call the ExecuteBlock() method when the event occurs. Add an EventHandlerInfo attibute and your new EventHandler class will automatically appear in the 'Execute On Event' dropdown menu when a block is selected.

Definition at line 38 of file EventHandler.cs.

Member Function Documentation

◆ ExecuteBlock()

virtual bool Fungus.EventHandler.ExecuteBlock ( )
virtual

The Event Handler should call this method when the event is detected to start executing the Block.

Definition at line 54 of file EventHandler.cs.

◆ GetSummary()

virtual string Fungus.EventHandler.GetSummary ( )
virtual

Member Data Documentation

◆ parentBlock

Block Fungus.EventHandler.parentBlock
protected

Definition at line 42 of file EventHandler.cs.

Property Documentation

◆ ParentBlock

virtual Block Fungus.EventHandler.ParentBlock
getset

The parent Block which owns this Event Handler.

Definition at line 49 of file EventHandler.cs.


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