Component:RelaySettings

Component image 

Relay Settings component as seen in the Scene Inspector

For better info, see Settings.

Fields

Fields

Name	Type	Description
persistent	Bool	Determines whether or not this item will be saved to the server.
UpdateOrder	Int	Controls the order in which this component is updated.
Enabled	Bool	Controls whether or not this component is enabled. Some components stop their functionality when this field is disabled, but some don't.
AlwaysUseRelay	Bool	Relays are typically used as a fallback when a direct connection to the host cannot be established. By enabling this option, you will force the connection to always happen through a relay. This can be useful in cases of connection issues to particular hosts. It is NOT recommended to have this option permanently on.
UseClosestAvailableRelay	Bool	When this option is enabled, the closest available relay will be automatically selected. If you want to connect through a specific relay (e.g. in case of long distance connections to avoid packet queuing) you can disable this option and configure the preferred relays below.
RelayPriorities	list of RelayPriorityEntry	A list of relays to use in order when trying to connect to a host.
RelayPrioritiesEnabled	Bool	Whether or not to use the relay priorities list.

Sync Delegates

Triggers

Method Name	Method type and Arguments.	Is the method hidden?	Description
GetEntry:SubsettingGetter	SubsettingGetter	X	Can be used to retrieve an entry from the list of RelayPriorities.

Usage

See Settings.

Examples

See Settings.

See Also

• Settings