Wobbly Life Mod SDK
 
Loading...
Searching...
No Matches
ModWobblyLife.ModGrabInteract Class Reference

Used to see if a gameobject is grabbable or not and when a player has grabbed or released it Apply to any gameobject and when a player grabs it events will be called. More...

Inheritance diagram for ModWobblyLife.ModGrabInteract:
ModWobblyLife.IModGrabInteract ModWobblyLife.IModGrabbable

Public Member Functions

delegate void ModGrabInteractCallback (ModPlayerCharacter character, ModRagdollHandJoint handJoint)
 Delegate for player hand interaction.
 
delegate bool ModGrabInteractIsGrabbable ()
 Delegate return bool.
 
void OnPlayerArmGrab (ModPlayerCharacter character, ModRagdollHandJoint handJoint)
 Called when a player hand grabs this object.
 
void OnPlayerArmRelease (ModPlayerCharacter character, ModRagdollHandJoint handJoint)
 Called when a player hand releases this object.
 
bool IsGrabbable ()
 Whether this object is grabbable or not.
 
void OnPlayerArmGrab (ModPlayerCharacter character, ModRagdollHandJoint handJoint)
 Called when player grabs this object Called on Server.
 
void OnPlayerArmRelease (ModPlayerCharacter character, ModRagdollHandJoint handJoint)
 Called when player releases this object Called on Server.
 
bool IsGrabbable ()
 Whether this object is grabbable or not.
 

Events

ModGrabInteractCallback onPlayerArmGrab
 An event for when a player hand grabs this object.
 
ModGrabInteractCallback onPlayerArmRelease
 An event for when a player hand releases this object.
 
ModGrabInteractIsGrabbable isGrabbable
 An func to see if this object is grabbable or not.
 

Detailed Description

Used to see if a gameobject is grabbable or not and when a player has grabbed or released it Apply to any gameobject and when a player grabs it events will be called.

Member Function Documentation

◆ IsGrabbable()

bool ModWobblyLife.ModGrabInteract.IsGrabbable ( )

Whether this object is grabbable or not.

Returns

Implements ModWobblyLife.IModGrabbable.

◆ ModGrabInteractCallback()

delegate void ModWobblyLife.ModGrabInteract.ModGrabInteractCallback ( ModPlayerCharacter  character,
ModRagdollHandJoint  handJoint 
)

Delegate for player hand interaction.

Parameters
character
handJoint

◆ ModGrabInteractIsGrabbable()

delegate bool ModWobblyLife.ModGrabInteract.ModGrabInteractIsGrabbable ( )

Delegate return bool.

Returns

◆ OnPlayerArmGrab()

void ModWobblyLife.ModGrabInteract.OnPlayerArmGrab ( ModPlayerCharacter  character,
ModRagdollHandJoint  handJoint 
)

Called when a player hand grabs this object.

Parameters
character
handJoint

Implements ModWobblyLife.IModGrabInteract.

◆ OnPlayerArmRelease()

void ModWobblyLife.ModGrabInteract.OnPlayerArmRelease ( ModPlayerCharacter  character,
ModRagdollHandJoint  handJoint 
)

Called when a player hand releases this object.

Parameters
character
handJoint

Implements ModWobblyLife.IModGrabInteract.

Event Documentation

◆ isGrabbable

ModGrabInteractIsGrabbable ModWobblyLife.ModGrabInteract.isGrabbable

An func to see if this object is grabbable or not.

◆ onPlayerArmGrab

ModGrabInteractCallback ModWobblyLife.ModGrabInteract.onPlayerArmGrab

An event for when a player hand grabs this object.

◆ onPlayerArmRelease

ModGrabInteractCallback ModWobblyLife.ModGrabInteract.onPlayerArmRelease

An event for when a player hand releases this object.