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

Used to create interaction behaviors for the NPCs. More...

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 RescindInstruction (Context interactor, Context npcContext)
 Rescinds the interaction instruction given to an npc.
 
- Public Member Functions inherited from InstructionNode
Context GetContext ()
 Gets the context of this instruction node.
 
float GetTime ()
 Gets the current local game time.
 

Additional Inherited Members

- Properties inherited from InstructionNode
Endless.Gameplay.Scripting.InstructionNode ManagedNode [get]
 

Detailed Description

Used to create interaction behaviors for the NPCs.

Member Function Documentation

◆ RescindInstruction()

void RescindInstruction ( Context interactor,
Context npcContext )

Rescinds the interaction instruction given to an npc.

Parameters
interactorThe interactor involved in the interaction
npcContextThe npc to rescind the instruction for.

◆ 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/