Billboard

All Settings[]

All default values have been Bolded.

All Options

Option	Value	Description
Text	"Sample Text", {Custom Text}	A string of text you enter, that you want to display on the billboard.
Background Color	Clear, Select a Color	The color behind the text, when Show Border is Off. For UEFN the default text color is the following: RGBA(0.0, 0.0, 0.0, 0.0)
Text Justification	Left, Center, Right, Invariant Left, Invariant Right	How the text is aligned, whether Left, Center, or Right
Text Size	12, 8 - 24	This sets the text of the billboard from 8 - 24.
Text Color	Alto Gray, Select a Color	Determines which color the text should be when displayed. For UEFN the default text color is the following: RGBA(0.520996, 0.520996, 0.520996, 1.0)
Text Font	Roboto, Burbank, NotoSans	The font used.
Outline	None, Light, Thick	This set the thickness of a black outline around the text on the billboard.
Shadow	None, Lower Right, Lower Left, Upper Left, Upper Right	This sets a shadow to the text in the direction you choose.
Show Border	On, Off	Controls whether the border is visible and the device has collision.
Display Mode	One Sided, Two Sided	Determines if the text is displayed as One Sided or Two Sided.
View Distance	0.0 - 9999.9, Infinite (10000.0)	How far away the text is visible in-game in tiles.
Enabled During Phase	None, All, Pre-Game Only, Gameplay Only, Create Only	Sets when the billboard is active. Pre-game Only is only used with Published Islands.
Resolution Multiplier	1.0, 0.5 - 5.0	Allows for higher fidelity visuals on the billboard. This will increase the memory cost.

Functions and Events[]

Functions

Option	Description
Set Text Hidden When Receiving From	Sets the billboard's text Hidden when receiving a message on this channel.
Set Text Visible When Receiving From	Sets the billboard's text Visible when receiving a message on this channel.
Update Display when Receiving Text Data When Receiving From	Sets the billboard to display text that has been updated from another source.

No settings to display

billboard_device class[]

using { /Fortnite.com/Devices }

Inheritance Hierarchy

Option	Description
creative_object	Base class for creative devices and props.
creative_device_base	Base class for creative_device.

This class has no data members

Functions

Option	Parameters	Description
ShowText		Shows the billboard text.
HideText		Hides the billboard text.
UpdateDisplay		Updates the device display to show the current Text
SetShowBorder	Show:logic	Sets the visibility of the device border mesh. This also determines whether the device collision is enabled.
GetShowBorder<transacts>		Returns true if the device border is enabled (This returns a logic value).
SetText	Text:message	Sets the device Text.
SetTextSize	Size:int	Sets the Text Size of the device Text. Clamped to range [8, 24].
GetTextSize<transacts>		Returns the Text Size of the device agent.

Example[]

Converting String Text to a Message[]

In this example we will convert our non-localized string to a localized message to be displayed on our Billboard when the game starts.

First we need to determine our billboard:

   @editable WikiBillboard: billboard_device = billboard_device{} # Allows us to select a billboard device in the viewpoint that we want our Verse to modify.
                

Build the code and select your Billboard.

Then we will create a small conversion function;

   STM<localizes>(S:string):message="{S}" # Converts String / Text to Message format.
                

Lastly, we need to tell our device what to say then update the device;

   OnBegin<override>()<suspends>:void=
                       WikiBillboard.SetText(STM("Example text from the wiki!"))
                       WikiBillboard.UpdateDisplay()
                

Complete Code:

   using { /Fortnite.com/Devices }
                   using { /Verse.org/Simulation }
                   Wiki_Example_Device := class(creative_device):
                

       @editable WikiBillboard: billboard_device = billboard_device{} # Allows us to select a billboard device in the viewpoint that we want our Verse to modify.
                

       STM<localizes>(S:string):message="{S}" # Converts String / Text to Message format.
                

       OnBegin<override>()<suspends>:void=
                           WikiBillboard.SetText(STM("Example text from the wiki!"))
                           WikiBillboard.UpdateDisplay()