v3.6.1 Documentation
Fungus.DragCompleted Class Reference

The block will execute when the player drags an object and successfully drops it on a target object. More...

Inheritance diagram for Fungus.DragCompleted:
Fungus.EventHandler

Classes

class  DragCompletedEvent
 

Public Member Functions

virtual bool IsOverTarget ()
 Returns true if the draggable object is over the drag target object. More...
 
virtual void OnDragEntered (Draggable2D draggableObject, Collider2D targetObject)
 Called by the Draggable2D object when the it enters the drag target. More...
 
virtual void OnDragExited (Draggable2D draggableObject, Collider2D targetObject)
 Called by the Draggable2D object when the it exits the drag target. More...
 
virtual void OnDragCompleted (Draggable2D draggableObject)
 Called by the Draggable2D object when the the drag ends over the drag target. 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 ()
 

Protected Attributes

Draggable2D draggableObject
 
Collider2D targetObject
 
bool overTarget = false
 
EventDispatcher eventDispatcher
 
- Protected Attributes inherited from Fungus.EventHandler
Block parentBlock
 

Properties

virtual Draggable2D DraggableObject [get]
 Gets the draggable object. More...
 
- 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 player drags an object and successfully drops it on a target object.

Definition at line 15 of file DragCompleted.cs.

Member Function Documentation

◆ GetSummary()

override string Fungus.DragCompleted.GetSummary ( )
virtual

Returns custom summary text for the event handler.

Reimplemented from Fungus.EventHandler.

Definition at line 138 of file DragCompleted.cs.

◆ IsOverTarget()

virtual bool Fungus.DragCompleted.IsOverTarget ( )
virtual

Returns true if the draggable object is over the drag target object.

Definition at line 90 of file DragCompleted.cs.

◆ OnDisable()

virtual void Fungus.DragCompleted.OnDisable ( )
protectedvirtual

Definition at line 51 of file DragCompleted.cs.

◆ OnDragCompleted()

virtual void Fungus.DragCompleted.OnDragCompleted ( Draggable2D  draggableObject)
virtual

Called by the Draggable2D object when the the drag ends over the drag target.

Definition at line 124 of file DragCompleted.cs.

◆ OnDragEntered()

virtual void Fungus.DragCompleted.OnDragEntered ( Draggable2D  draggableObject,
Collider2D  targetObject 
)
virtual

Called by the Draggable2D object when the it enters the drag target.

Definition at line 98 of file DragCompleted.cs.

◆ OnDragExited()

virtual void Fungus.DragCompleted.OnDragExited ( Draggable2D  draggableObject,
Collider2D  targetObject 
)
virtual

Called by the Draggable2D object when the it exits the drag target.

Definition at line 111 of file DragCompleted.cs.

◆ OnEnable()

virtual void Fungus.DragCompleted.OnEnable ( )
protectedvirtual

Definition at line 37 of file DragCompleted.cs.

Member Data Documentation

◆ draggableObject

Draggable2D Fungus.DragCompleted.draggableObject
protected

Definition at line 26 of file DragCompleted.cs.

◆ eventDispatcher

EventDispatcher Fungus.DragCompleted.eventDispatcher
protected

Definition at line 35 of file DragCompleted.cs.

◆ overTarget

bool Fungus.DragCompleted.overTarget = false
protected

Definition at line 33 of file DragCompleted.cs.

◆ targetObject

Collider2D Fungus.DragCompleted.targetObject
protected

Definition at line 29 of file DragCompleted.cs.

Property Documentation

◆ DraggableObject

virtual Draggable2D Fungus.DragCompleted.DraggableObject
get

Gets the draggable object.

Definition at line 85 of file DragCompleted.cs.


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