C# Class RootMotion.FinalIK.InteractionSystem

Inheritance: UnityEngine.MonoBehaviour
Afficher le fichier Open project: Alx666/ProjectPhoenix Class Usage Examples

Méthodes publiques

Свойство Type Description
OnInteractionEvent InteractionEventDelegate
OnInteractionPause InteractionDelegate
OnInteractionPickUp InteractionDelegate
OnInteractionResume InteractionDelegate
OnInteractionStart InteractionDelegate
OnInteractionStop InteractionDelegate
raycastHit UnityEngine.RaycastHit

Méthodes publiques

Méthode 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

Méthodes protégées

Méthode Description
Start ( ) : void

Private Methods

Méthode 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 méthode

Returns the InteractionTrigger that is in range and closest to the character.
public GetClosestTriggerIndex ( ) : int
Résultat int

GetInteractionObject() public méthode

Gets the current interaction object of an effector.
public GetInteractionObject ( FullBodyBipedEffector effectorType ) : RootMotion.FinalIK.InteractionObject
effectorType FullBodyBipedEffector
Résultat RootMotion.FinalIK.InteractionObject

GetMinActiveProgress() public méthode

Gets the minimum progress of any active interaction
public GetMinActiveProgress ( ) : float
Résultat float

GetProgress() public méthode

Gets the progress of any interaction with the specified effector.
public GetProgress ( FullBodyBipedEffector effectorType ) : float
effectorType FullBodyBipedEffector
Résultat float

GetTriggerRange() public méthode

Return the current most appropriate range of an InteractionTrigger listed in triggersInRange.
public GetTriggerRange ( int index ) : InteractionTrigger.Range
index int
Résultat InteractionTrigger.Range

IsInInteraction() public méthode

Determines whether this effector is interaction and not paused
public IsInInteraction ( FullBodyBipedEffector effectorType ) : bool
effectorType FullBodyBipedEffector
Résultat bool

IsInSync() public méthode

Returns true if either all effectors in interaction are paused or none is.
public IsInSync ( ) : bool
Résultat bool

IsPaused() public méthode

Returns true if any of the effectors is paused
public IsPaused ( ) : bool
Résultat bool

IsPaused() public méthode

Determines whether this effector is paused
public IsPaused ( FullBodyBipedEffector effectorType ) : bool
effectorType FullBodyBipedEffector
Résultat bool

LateUpdate() public méthode

public LateUpdate ( ) : void
Résultat void

OnDestroy() public méthode

public OnDestroy ( ) : void
Résultat void

OnDrawGizmosSelected() public méthode

public OnDrawGizmosSelected ( ) : void
Résultat void

OnTriggerEnter() public méthode

public OnTriggerEnter ( Collider c ) : void
c UnityEngine.Collider
Résultat void

OnTriggerExit() public méthode

public OnTriggerExit ( Collider c ) : void
c UnityEngine.Collider
Résultat void

PauseAll() public méthode

Pauses all the interaction effectors.
public PauseAll ( ) : void
Résultat void

PauseInteraction() public méthode

Pauses the interaction of an effector.
public PauseInteraction ( FullBodyBipedEffector effectorType ) : bool
effectorType FullBodyBipedEffector
Résultat bool

ResumeAll() public méthode

Resumes all the paused interaction effectors.
public ResumeAll ( ) : void
Résultat void

ResumeInteraction() public méthode

Resumes the paused interaction of an effector.
public ResumeInteraction ( FullBodyBipedEffector effectorType ) : bool
effectorType FullBodyBipedEffector
Résultat bool

Start() protected méthode

protected Start ( ) : void
Résultat void

StartInteraction() public méthode

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
Résultat bool

StopAll() public méthode

Stops all interactions.
public StopAll ( ) : void
Résultat void

StopInteraction() public méthode

Stops the interaction of an effector.
public StopInteraction ( FullBodyBipedEffector effectorType ) : bool
effectorType FullBodyBipedEffector
Résultat bool

TriggerEffectorsReady() public méthode

Returns true if all effectors of a trigger are either not in interaction or paused
public TriggerEffectorsReady ( int index ) : bool
index int
Résultat bool

TriggerInteraction() public méthode

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
Résultat bool

Update() public méthode

public Update ( ) : void
Résultat void

Property Details

OnInteractionEvent public_oe property

Called when an interaction event occurs.
public InteractionEventDelegate OnInteractionEvent
Résultat InteractionEventDelegate

OnInteractionPause public_oe property

Called when an Interaction has been paused
public InteractionDelegate OnInteractionPause
Résultat InteractionDelegate

OnInteractionPickUp public_oe property

Called when an InteractionObject has been picked up.
public InteractionDelegate OnInteractionPickUp
Résultat InteractionDelegate

OnInteractionResume public_oe property

Called when a paused Interaction has been resumed
public InteractionDelegate OnInteractionResume
Résultat InteractionDelegate

OnInteractionStart public_oe property

Called when an InteractionEvent has been started
public InteractionDelegate OnInteractionStart
Résultat InteractionDelegate

OnInteractionStop public_oe property

Called when an Interaction has been stopped
public InteractionDelegate OnInteractionStop
Résultat InteractionDelegate

raycastHit public_oe property

Gets the RaycastHit from trigger seeking.
public RaycastHit,UnityEngine raycastHit
Résultat UnityEngine.RaycastHit