Object Interaction Resource - Unequip

Overview of Unequip, an Object Interaction Resource

For information on what Object Interactions are, click here.

The Unequip object interaction emits an event once the user removes an equipped object from a target. The target must be an object that is specified in an Equip Target resource.

An example of how the Unequip object interaction could be used is when the user must unequip their PPE once they are done with it. After unequipping the objects, the scenario progresses.


Required Fields:

Field Name Description
World Object The item that you want the learner to unequip.
Target The target of the item you want the learner to unequip.

Optional Fields:

Field Name Description
Require All Targets If more than one World Object is designated, this would require all.  Otherwise referred to as Target Object.
Prompts Add an effect or text to draw attention to the item you'd like the learner to.
Prompt Anchor Object Interaction prompts without an anchor will end up on the object you are targeting because they’re meant as annotation or extra information about the object in question. If you want to accompany an Object Interaction with additional information for the learner, you could add a Notification or Screen Message to the frame as well.
Event Determine an event or Custom Event to fire along with any other events that would normally fire.  This field is generally used to distinguish between different options for branching.
Require All Inputs If more than one Input is designated, this would require all.
Persistent Will stay open and continue listening for Input and will continue to fire scripted events.  If this is chosen, the close event cannot be used as it doesn't close.
Interacted Objects If multiple World Objects are identified, you can add a variable here that contains a record of the World Objects the learner has interacted with and the variable then affects only those in that list.


ActivateOpenClose (if not persistent), Complete and Custom.

Example in the Headset:

In the Workshop, I've asked the learner to Equip the safety hat.  Now I want the learner to unequip it.  

  • In a scene objects frame, add the World Object (hat), the Target (head), and in this example, I've added the prompt anchor - where I want the text prompt to appear (optional).
  • Add the Unequip Resource to the frame:
    • Choose the World Object and Target.
    • Add a prompt (optional).  In this example, I've specifically anchored the prompt anchor to the benchtop.  Otherwise, the text would be above the object.  As the object is a hat on the learner's head, they would not see the prompt if I left this blank.


  • I've additionally added a notification once the unequip is complete:

In the headset, this is what it would look like.  Please note the learner will be asked to equip the hat first: