Overridable functions

The Grapple Object contains some events that can be implemented to facilitate the creation of your own Grapple Sequences.

More information on these functions and events events can be found in the ''Grapple Sequence Tutorial’ Object. This Graph also contains copies of the relevant nodes.

The following events and functions can be implemented on the Grapple Object to add your own functionality.

Function/Event	Description
On Initiate	Called when the Grapple Sequence has been Initiated (i.e. when it has started, regardless of whether any Participants are present). The time the Grapple Sequence was initiated is used to synchronize animation and to calculate when the Grapple Sequence should end.
On Terminate (Before)	Called right before the Grapple Sequence is terminated (i.e. when it has ended, regardless of whether any Participants are present). This can be useful if you still need some references that were present during the Grapple Sequence.
On Terminate (After)	Called when the Grapple Sequence has been terminated (i.e. when it has ended, regardess of whether any Participants are present). When a Grapple Sequence is Terminated, all Participants are ejected.
On Termination Authorized	Called by the Grapple Component when Termination is authorized. This is done using function Authorize Termination (Input).
On Construct	Called by the Grapple Component when the Grapple Object is constructed. A Grapple Object is constructed whenever it is needed by the Grapple Component. This can be the case when initiating a Grapple Sequence, when performing a Grapple Attempt or when Executing a Grapple Object. If variable Grapple Object is Persistent is set to true, the Grapple Object is only constructed once.
On Apply	Called after the effects from the Grapple Sequence have been applied. This function can be implemented as an event and is a good place to implement functionality that needs to run whenever a Participant is entering the Grapple Sequence. This function can be overridden in combination with On Revert if you want to create a temporary state that is only activated during the Grapple Sequence.
On Revert	Called right before the effects from the Grapple Sequence are reverted. This function can be implemented as an event and is a good place to implement functionality that needs to run whenever a Participant is leaving the Grapple Sequence. This function can be overridden in combination with On Apply if you want to create a temporary state that is only activated during the Grapple Sequence.
On Perform Grapple Attempt	Called when a Grapple Component executes a Grapple Attempt based on this Object.

The following events and functions can be overridden on the Grapple Object to replace the built-in functionality with your own functionality. If you wish to maintain the built-in functionality, make sure to add a call to the parent function in the Graph as well.

Function/Event	Description
Apply Grapple Sequence Effects	Applies the influence from the Grapple Sequence. It is recommended to keep a call to the parent function, as it provides some base functionality. In case you are looking for a more designer-friendly way of adding functionality based on the needs of a specific Grapple Sequence, consider overriding function On Apply instead.
Revert Grapple Sequence Effects	Reverts the influence from the Grapple Sequence. It is recommended to keep a call to the parent function, as it provides some base functionality. In case you are looking for a more designer-friendly way of adding functionality based on the needs of a specific Grapple Sequence, consider overriding function On Revert instead.
On Execute	Called by the Grapple Component when the Grapple Object is Executed. This method can be used instead of the ‘Grapple Attempt’ node on the Grapple Component, in case the user wishes give additional instructions related to this Grapple Object, rather than just performing a Grapple Attempt. By default, the ‘On Executed’ function simply performs a Grapple Attempt based on the Grapple Object.
On Grapple Attempt Success	Called by the Grapple Component when it has successfully performed a Grapple Attempt based on this Object. By default, this function clears all Pending Grapple Attempts and initiates a Grapple Sequence with all found Participants, in addition to the Master Grapple component which is inserted as participant 0.
On Grapple Attempt Failed	Called by the Grapple Component when a Grapple Attempt fails based on this Object. It should be noted that Clients will only be notified when a Grapple Attempt fails on the server, if variable Notify if Attempt Fails on Server is set to true.

User Commands / Queued Events / Grapple Attempt

Function/Event	Description
On User Command Received	Please consult the dedicated section on User Commands for more information.
On Initialize Queued Events	Please consult the dedicated section on Queued Events for more information.
Test Selection Conditions on Candidate	Please consult the dedicated section on Grapple Attempts for more information.
Apply Selection Criteria	Please consult the dedicated section on Grapple Attempts for more information.