Links between Grapple Components and Grapple Objects
A Grapple Object is dependent on Grapple Components for most of its functionality. The relations between a Grapple Object and a Grapple Component can be described as follows.
Master Grapple Component / Controlled Grapple Object
A Grapple Sequence is Controlled by a Master Grapple Component. This means that Input Functions used on this Grapple Component that affect a Grapple Sequence, will take effect on the Controlled Grapple Object. A Grapple Component becomes the Master of any Grapple Sequence that it Initiates and can only have one controlled Grapple Sequence. If a new one is Initiated, the previous one is Terminated.
- To access the Master Grapple Component on a Grapple Object, use function Get Master Grapple Component.
- To access the controlled Grapple Object on a Grapple Component, is function Get Controlled Grapple Object. While it is possible to access the Controlled Grapple Object in this way, it is suggested to use Input Functions instead.
Participant / Applied Grapple Object
A Grapple Sequence can have one or more Participants. These are the Grapple Components that are influenced by the Grapple Object, and have effects applied to them based on the Grapple Sequence.
- To access all Participants on a Grapple Object, use function Get Participants.
- To access a specific Participant based on its Participant Index, use function Get Participant by Index.
- To access the applied Grapple Object from a Grapple Component, use function Get applied Grapple Object.
- To get the current Participant Index of a Grapple Component on its applied Grapple Object, use function
Get Participant Index.
The process of becoming a Participant in a Grapple Sequence and applying grapple Data is referred to as Entering the Grapple Sequence. The process of reverting Grapple Data and being removed as a Participant, is referred to as Exiting the Grapple Sequence.