C# Class RootMotion.FinalIK.InteractionSystem

Inheritance: UnityEngine.MonoBehaviour

Show file Open project: Alx666/ProjectPhoenix Class Usage Examples

Public Properties

Property	Type	Description
OnInteractionEvent	InteractionEventDelegate
OnInteractionPause	InteractionDelegate
OnInteractionPickUp	InteractionDelegate
OnInteractionResume	InteractionDelegate
OnInteractionStart	InteractionDelegate
OnInteractionStop	InteractionDelegate
raycastHit	UnityEngine.RaycastHit

Public Methods

Method	Description
GetClosestTriggerIndex ( ) : int	Returns the InteractionTrigger that is in range and closest to the character.
GetInteractionObject ( FullBodyBipedEffector effectorType ) : RootMotion.FinalIK.InteractionObject	Gets the current interaction object of an effector.
GetMinActiveProgress ( ) : float	Gets the minimum progress of any active interaction
GetProgress ( FullBodyBipedEffector effectorType ) : float	Gets the progress of any interaction with the specified effector.
GetTriggerRange ( int index ) : InteractionTrigger.Range	Return the current most appropriate range of an InteractionTrigger listed in triggersInRange.
IsInInteraction ( FullBodyBipedEffector effectorType ) : bool	Determines whether this effector is interaction and not paused
IsInSync ( ) : bool	Returns true if either all effectors in interaction are paused or none is.
IsPaused ( ) : bool	Returns true if any of the effectors is paused
IsPaused ( FullBodyBipedEffector effectorType ) : bool	Determines whether this effector is paused
LateUpdate ( ) : void
OnDestroy ( ) : void
OnDrawGizmosSelected ( ) : void
OnTriggerEnter ( Collider c ) : void
OnTriggerExit ( Collider c ) : void
PauseAll ( ) : void	Pauses all the interaction effectors.
PauseInteraction ( FullBodyBipedEffector effectorType ) : bool	Pauses the interaction of an effector.
ResumeAll ( ) : void	Resumes all the paused interaction effectors.
ResumeInteraction ( FullBodyBipedEffector effectorType ) : bool	Resumes the paused interaction of an effector.
StartInteraction ( FullBodyBipedEffector effectorType, RootMotion.FinalIK.InteractionObject interactionObject, bool interrupt ) : bool	Starts the interaction between an effector and an interaction object.
StopAll ( ) : void	Stops all interactions.
StopInteraction ( FullBodyBipedEffector effectorType ) : bool	Stops the interaction of an effector.
TriggerEffectorsReady ( int index ) : bool	Returns true if all effectors of a trigger are either not in interaction or paused
TriggerInteraction ( int index, bool interrupt ) : bool	Triggers all interactions of an InteractionTrigger. Returns false if unsuccessful (maybe out of range).
Update ( ) : void

Protected Methods

Method	Description
Start ( ) : void

Private Methods

Method	Description
ContactIsInRange ( int index, int &bestRangeIndex ) : bool
IsValid ( bool log ) : bool
LookAtInteraction ( FullBodyBipedEffector effector, RootMotion.FinalIK.InteractionObject interactionObject ) : void
OnPostFBBIK ( ) : void
OnPreFBBIK ( ) : void
OpenScriptReference ( ) : void
OpenUserManual ( ) : void
Raycasting ( ) : void
TriggerIndexIsValid ( int index ) : bool
UpdateTriggerEventBroadcasting ( ) : void

Method Details

GetClosestTriggerIndex() public method

Returns the InteractionTrigger that is in range and closest to the character.

public GetClosestTriggerIndex ( ) : int
return	int

GetInteractionObject() public method

Gets the current interaction object of an effector.

public GetInteractionObject ( FullBodyBipedEffector effectorType ) : RootMotion.FinalIK.InteractionObject
effectorType	FullBodyBipedEffector
return	RootMotion.FinalIK.InteractionObject

GetMinActiveProgress() public method

Gets the minimum progress of any active interaction

public GetMinActiveProgress ( ) : float
return	float

GetProgress() public method

Gets the progress of any interaction with the specified effector.

public GetProgress ( FullBodyBipedEffector effectorType ) : float
effectorType	FullBodyBipedEffector
return	float

GetTriggerRange() public method

Return the current most appropriate range of an InteractionTrigger listed in triggersInRange.

public GetTriggerRange ( int index ) : InteractionTrigger.Range
index	int
return	InteractionTrigger.Range

IsInInteraction() public method

Determines whether this effector is interaction and not paused

public IsInInteraction ( FullBodyBipedEffector effectorType ) : bool
effectorType	FullBodyBipedEffector
return	bool

IsInSync() public method

Returns true if either all effectors in interaction are paused or none is.

public IsInSync ( ) : bool
return	bool

IsPaused() public method

Returns true if any of the effectors is paused

public IsPaused ( ) : bool
return	bool

IsPaused() public method

Determines whether this effector is paused

public IsPaused ( FullBodyBipedEffector effectorType ) : bool
effectorType	FullBodyBipedEffector
return	bool

LateUpdate() public method

public LateUpdate ( ) : void
return	void

OnDestroy() public method

public OnDestroy ( ) : void
return	void

OnDrawGizmosSelected() public method

public OnDrawGizmosSelected ( ) : void
return	void

OnTriggerEnter() public method

public OnTriggerEnter ( Collider c ) : void
c	UnityEngine.Collider
return	void

OnTriggerExit() public method

public OnTriggerExit ( Collider c ) : void
c	UnityEngine.Collider
return	void

PauseAll() public method

Pauses all the interaction effectors.

public PauseAll ( ) : void
return	void

PauseInteraction() public method

Pauses the interaction of an effector.

public PauseInteraction ( FullBodyBipedEffector effectorType ) : bool
effectorType	FullBodyBipedEffector
return	bool

ResumeAll() public method

Resumes all the paused interaction effectors.

public ResumeAll ( ) : void
return	void

ResumeInteraction() public method

Resumes the paused interaction of an effector.

public ResumeInteraction ( FullBodyBipedEffector effectorType ) : bool
effectorType	FullBodyBipedEffector
return	bool

Start() protected method

protected Start ( ) : void
return	void

StartInteraction() public method

Starts the interaction between an effector and an interaction object.

public StartInteraction ( FullBodyBipedEffector effectorType, RootMotion.FinalIK.InteractionObject interactionObject, bool interrupt ) : bool
effectorType	FullBodyBipedEffector
interactionObject	RootMotion.FinalIK.InteractionObject
interrupt	bool
return	bool

StopAll() public method

Stops all interactions.

public StopAll ( ) : void
return	void

StopInteraction() public method

Stops the interaction of an effector.

public StopInteraction ( FullBodyBipedEffector effectorType ) : bool
effectorType	FullBodyBipedEffector
return	bool

TriggerEffectorsReady() public method

Returns true if all effectors of a trigger are either not in interaction or paused

public TriggerEffectorsReady ( int index ) : bool
index	int
return	bool

TriggerInteraction() public method

Triggers all interactions of an InteractionTrigger. Returns false if unsuccessful (maybe out of range).

public TriggerInteraction ( int index, bool interrupt ) : bool
index	int
interrupt	bool
return	bool

Update() public method

public Update ( ) : void
return	void

Property Details

OnInteractionEvent public property

Called when an interaction event occurs.

public InteractionEventDelegate OnInteractionEvent
return	InteractionEventDelegate

OnInteractionPause public property

Called when an Interaction has been paused

public InteractionDelegate OnInteractionPause
return	InteractionDelegate

OnInteractionPickUp public property

Called when an InteractionObject has been picked up.

public InteractionDelegate OnInteractionPickUp
return	InteractionDelegate

OnInteractionResume public property

Called when a paused Interaction has been resumed

public InteractionDelegate OnInteractionResume
return	InteractionDelegate

OnInteractionStart public property

Called when an InteractionEvent has been started

public InteractionDelegate OnInteractionStart
return	InteractionDelegate

OnInteractionStop public property

Called when an Interaction has been stopped

public InteractionDelegate OnInteractionStop
return	InteractionDelegate

raycastHit public property

Gets the RaycastHit from trigger seeking.

public RaycastHit,UnityEngine raycastHit
return	UnityEngine.RaycastHit