Document toolboxDocument toolbox

2023.1.1294.2 Receiver



Overview

The Beam Receiver is a component that can detect an optical (laser) beam emitted by a Beam Emitter.

A Beam Emitter projecting its beam onto a Beam Receiver (left) and a Beam Reflector (right).


Where to find

The Beam Receiver Physical component can be found under Standard Components > Beam Sensor > Receiver > Add Physical Component.

It can be accessed from the GameObject menu as well as from the Hierarchy Context menu.

A new GameObject will be created if you do not have a GameObject selected. Otherwise, the Beam Receiver will be added to the selected GameObject.


Feature layout - Physical Component

Live Data

 

State

Shows whether the Beam Receiver is currently active and thus whether it will detect a beam.

Output Signal

Shows whether the Beam Receiver currently detects a beam or not.

Properties

 

On Signal High

A UnityEvent that is fired as soon as the Output Signal of the Beam Receiver is set to “High”.

On Signal Low

A UnityEvent that is fired as soon as the Output Signal of the Beam Receiver is set to “Low”.

Control Panel

 

Generate Control Panel for BeamEmitter

Click this button to generate a ControlPanelInterface for the Beam Receiver.

Feature layout - Control Panel

Title

The Title of the Control Panel.

Click to ping the target component in the hierarchy.

Double click to edit.

Beam Receiver Properties

 

State

Shows whether the Beam Emitter is currently active and thus whether it will emit a beam.

Output Signal

Shows whether the Beam Receiver currently detects a beam or not.

Enable/Disable

Enables/Disables the Beam Receiver.

Target Component

 

Target Gameobject

The gameobject which has a standardcomponent you want the Control Panel for.

Target Component

The Component which for which a Control Panel is generated.


How to use

  1. Assign a Beam Receiver physical component to a GameObject, or create a new one directly from the menu.

  2. Create the desired signal events under the Properties tab.

  3. In order to detect a beam, a Beam Emitter must also be created.

  4. Direct the beam from the Beam Emitter at the Beam Receiver.

  5. Objects with a Collider will interrupt the beam, changing the signal value of the Beam Receiver.

Prespective Documentation