Overview
The Beacon is a Device in Fortnite: Creative and Unreal Editor for Fortnite.
All Settings
All Settings[]
Contextual Filtering[]
This device is affected by Contextual Filtering; This feature hides or displays options depending on the values selected for certain related options.
All default values have been Bolded.
| Option | Value | Description |
|---|---|---|
| Beacon To Show | Particle, Badge, Both | Whether to show the Beacon, Show a HUD Element, or both. |
| Badge UI Style | Default, Backless | Choose a style for the badge UI. |
| Beacon Particle Style | Arrow, Light Beam, Flare | Defines what visual effect will be shown to players. |
| Friendly Team | Any, Hostiles, Neutral, Team 1 - 100 | Defines which team(if any) sees the Beacon as Friendly. If set to Neutral, all teams will see this as Neutral. If Hostile, everyone is Hostile. |
| Friendly Class | No Class, Any, Class 1 - 16 | Determines which Class sees the Beacon as Friendly. |
| Invert Class Selection | On, Off | Inverts the list of classes friendly to this device. |
| Team Visibility | Any, Hostiles, Friendlies, Neutral, Team 1 - 100 | Displays an optional letter above the Arrow style Beacon Particle. |
| Beacon Identifier | None, A, B, C, D, E, F, G, H | Determines which Team can see the Badge Icon and Beacon Particle. |
| Beacon Color | Direct Color, Team Color, Team Relationship Color | Determines whether the Beacon should have a set color or be reactive to it's team color or team relation. |
| Custom Beacon Color | White, Select a Color | Defines the Direct Color of this Beacon. |
| Enable on Phase | None, Always, Pre-Game Only, Gameplay Only | Determines the game phases during which the device will be enabled. Pre-Game includes all phases prior to the Game starting (the waiting for players lobby on Featured Islands and the Game Start Countdown) |
| Badge Uses Beacon Color | On, Off | If set, the badge will inherit color from the Beacon rather than use Team Relationship. |
| Icon Identifier | None, Select an Icon | Assigns an Icon to the HUD Icon to make it identifiable. Only relevant for Badge Style icons. |
| Hide HUD Icon At | 20m, 2m - 500m | Determines the distance at which the HUD icon will stop being visible. Only relevant for Badge Style icons. |
| Display Distance Text | On, Off | When showing as a HUD Element, display the distance between the beacon and the player. This will display instead of any other text. |
| Friendly Icon Text | Blank, {Custom Text} | Specifies text to be displayed on the HUD icon for friendly players. Only relevant for Badge Style icons. |
| Neutral Icon Text | Blank, {Custom Text} | Specifies text to be displayed on the HUD icon for neutral players. Only relevant for Badge Style icons. |
| Hostile Icon Text | Blank, {Custom Text} | Specifies text to be displayed on the HUD icon for hostile players. Only relevant for Badge Style icons. |
| Text Font Size | Subtle, Bold | Defines the font for any custom text displayed by this beacon. |
| HUD Text Size | 1.0x - 2.0x | Determines the size of text displayed on the HUD icon. Only relevant for Badge Style icons. |
| Requires Line Of Sight | On, Off | Determines whether direct line of sight is required to see the HUD icon. Only relevant for Badge Style icons. |
| Clamp to Screen | On, Off | When showing as a HUD Element, clamp the rending position to be within the screen. |
| Show Offscreen Arrow | On, Off | When showing as a HUD Element, when the actual rending position is offscreen show an arrow pointing in the offscreen direction. |
Functions and Events
Functions and Events[]
| Option | Description |
|---|---|
| Enable When Receiving From | Shows this particle. |
| Disable When Receiving From | Hides this particle. |
| Add Player to Show List When Receiving From | Add the instigating player to a list of players that the Beacon will be shown to. This list of players is maintained separately from the Team Visibility set of players. |
| Remove Player from Show List When Receiving From | Removes the instigating player from the show list. The player will still see the Beacon if they meet the Visibility check. |
| Remove All Players from Show List When Receiving From | Removes all players from the show list. Players will still see the Beacon if they meet the Team Visibility check. |
Events
No settings to display
This device can be found in Content Browser in the following path: /All/Fortnite/Devices/UI
beacon_device class
beacon_device class[]
using { /Fortnite.com/Devices }
| Option | Description |
|---|---|
creative_object
|
Base class for creative devices and props. |
creative_device_base
|
Base class for creative_device.
|
Data
This class has no data members
| Option | Parameters | Description |
|---|---|---|
Enable:void
|
Enables this device. | |
Disable:void
|
Disables this device. | |
AddToShowList:void
|
Agent:agent
|
Adds the specified agent to a list of agents that the Beacon will be shown to. This list of agents is maintained separately from the Team Visibility set of agents.
|
RemoveFromShowList:void
|
Agent:agent
|
Removes the specified agent from the show list. The agent will still see the Beacon if they meet the Team Visibility check.
|
RemoveAllFromShowList:void
|
Removes all agents from the show list. Agent's will still see the Beacon if they meet the Team Visibility check.
|