Endstar LUA API Documentation
Loading...
Searching...
No Matches
GroupInteraction Class Reference

Public Member Functions

void SetIsHeldInteraction (Context instigator, bool isHeldInteraction)
 Sets the interaction held behavior for the npc interaction.
 
void SetInteractionAnimation (Context instigator, InteractionAnimation interactionAnimation)
 Sets the interaction animation for the interaction.
 
void SetInteractionDuration (Context instigator, float duration)
 Sets the hold duration of a held interaction.
 
void StopInteraction (Context interactor, Context npcContext)
 Forces an interacting npc to stop interacting.
 
void InteractionCompleted (Context interactor)
 Tells the interaction node that the player completed the interaction completely.
 
void InteractionCanceled (Context interactor)
 Tells the interaction node that the player canceled the interaction before fully completing it.
 
- Public Member Functions inherited from GroupInstruction
Context GetContext ()
 Gets the context of this instruction node.
 
float GetTime ()
 Gets the current local game time.
 
void GiveGroupInstruction (Context instigator, int group)
 Give this instruction to all npcs in the group.
 
void RescindGroupInstruction (Context instigator, int group)
 Rescinds this instruction from all npcs in the group.
 

Additional Inherited Members

- Properties inherited from GroupInstruction
IGroupInstructionNode GroupNode [get]
 

Member Function Documentation

◆ InteractionCanceled()

void InteractionCanceled ( Context interactor)

Tells the interaction node that the player canceled the interaction before fully completing it.

Parameters
interactorThe context of the interactor

◆ InteractionCompleted()

void InteractionCompleted ( Context interactor)

Tells the interaction node that the player completed the interaction completely.

Parameters
interactorThe context of the interactor

◆ SetInteractionAnimation()

void SetInteractionAnimation ( Context instigator,
InteractionAnimation interactionAnimation )

Sets the interaction animation for the interaction.

Parameters
instigatorThe source context triggering this change
interactionAnimationThe interaction animation to set

◆ SetInteractionDuration()

void SetInteractionDuration ( Context instigator,
float duration )

Sets the hold duration of a held interaction.

Parameters
instigatorThe source context triggering this change
durationThe duration of the held interaction.

◆ SetIsHeldInteraction()

void SetIsHeldInteraction ( Context instigator,
bool isHeldInteraction )

Sets the interaction held behavior for the npc interaction.

Parameters
instigatorThe source context triggering this change
isHeldInteractionThe value of the new held interaction bool

◆ StopInteraction()

void StopInteraction ( Context interactor,
Context npcContext )

Forces an interacting npc to stop interacting.

Parameters
interactorThe interactor involved in the interaction
npcContextThe npc to stop interacting/