Passer.EventHandler Class Reference

Description

Easy universal way to attach script functions to events and statuses.

Event handlers are used in many Passer components like ControllerInput, CollisionEventHandler, TriggetEventHandler, HeadTarget and Handle to call functions based on events.

Editing

An event handler can be edited by pressing on the button. For every event It is possible to attach multiple event Handlers. When an event Handler has been defined, a new empty button will appear below which you can use to add an additional event Handler.

When an event Handler has been selected, a number of fields become visible:

Event Type

The labels of this drop down field can be differen depending on the event, but in general they work as follows:

• /ref Never: the Target Method is never called.
• /ref On Start: the Target Method is called when the event starts.
• /ref On End: the Target Method is called when the event ends.
• /ref While Active: the Target Method is called while the event is active.
• /ref While Inactive: the Target Method is called while the event is not active.
• /ref On Change: the Target Method is called when the event starts of ends.
• /ref Always: the Target Method is called independe from the event state.

Target

The target GameObject in the scene on which the Method is called.

Method

The method to call on the GameObject. For each component on the GameObject an entry will be listed in the drop down. When selecting a component, the desired function can be chosen from the list of available functions.

Method Parameter

This can be set to a constant value or to From Event. In the second option, the parameter value will come from the event itself. Like the status of the button pressed the GameObject which has entered the trigger collider or the GameObject to which the user is looking.

Options

Depending on the parameter type additional settings can be set in the Options section.

• Inverse: the parameter value will be inverted before it is sent to the Method
• Multiplication: the parameter value will be multiplied by the given value before it is sent to the Method
• Trigger Level: determines at which values the Event Start and End happen. In the example above, the event will end when the value drops below 0.2 and will start again when the value raises above 0.8.

Inheritance diagram for Passer.EventHandler:

Public Types
enum	Type {   Never , OnStart , OnEnd , WhileActive ,   WhileInactive , OnChange , Continuous }
	The different types of events when the function is called. More...
enum	OverrideMode { Prepend , Append , Replace }

Public Member Functions
virtual void	Update ()

Public Attributes
Type	eventType = Type.Continuous
	The event type for the function call.
bool	eventNetworking = false
	For future use :-)
FunctionCall	functionCall
	The function to call.
bool	boolInverse = false
	Negate the boolean state before calling event trigger.
OverrideMode	overrideMode

Protected Member Functions
void	UpdateAnimationParameter ()
virtual void	UpdateVoid ()
virtual void	UpdateBool ()
virtual void	UpdateInt ()
virtual void	UpdateFloat ()
virtual void	UpdateString ()
virtual void	UpdateVector3 ()
virtual void	UpdateGameObject ()
virtual void	UpdateRigidbody ()
virtual void	UpdateString (string s)
virtual void	UpdateStringBool (string s)
virtual void	UpdateStringFloat (string s)
virtual void	UpdateStringInt (string s)
bool	CheckCondition (bool active, bool changed, bool valueChanged)

Protected Attributes
bool	initialized
bool	_boolValue
bool	boolChanged = true
int	_intValue
bool	intChanged
float	_floatValue
bool	floatChanged

Properties
virtual bool	boolValue [get, set]
bool	isDead [get]
	True when the eventHandler is dead and can be removed.

Member Enumeration Documentation

Type

enum Passer.EventHandler.Type

The different types of events when the function is called.

Enumerator
Never	The function is never called.
OnStart	The function is called when the event starts.
OnEnd	The function is called when the event ends.
WhileActive	The function is called every frame while the event is active.
WhileInactive	The function is called every frame while the event is not active.
OnChange	The function is called every time the event changes.
Continuous	The functions is called every frame.

OverrideMode

enum Passer.EventHandler.OverrideMode

Enumerator
Prepend	Prepend this handler before existing handlers.
Append	Append this handler after existing handlers.
Replace	Replace the topmost handler with this handler.

Property Documentation

isDead

bool Passer.EventHandler.isDead

get

True when the eventHandler is dead and can be removed.

A function is dead when it does nothing. This is when the functionCall is not defined or when the target of the functionCall is empty

---

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

• d:/Unity/Humanoid4/Humanoid4_Pro/Assets/humanoidcontrol4_pro/Runtime/Tools/Events/Event.cs