unreal.SwitchboardNewConfigUserOptions

class unreal.SwitchboardNewConfigUserOptions(config_name: str = '', dcra: DisplayClusterRootActorReference = [], num_editor_devices: int = 0, use_localhost: bool = False, auto_connect: bool = False)

Bases: StructBase

Structure used to collect New Config options from the user

C++ Source:

  • Plugin: Switchboard

  • Module: SwitchboardEditor

  • File: SwitchboardTypes.h

Editor Properties: (see get_editor_property/set_editor_property)

  • auto_connect (bool): [Read-Write] Indicates that Switchboard should auto-connect to the listeners of each created device

  • config_name (str): [Read-Write] Optional name of the new config. If left empty, a name will be autogenerated.

  • dcra (DisplayClusterRootActorReference): [Read-Write] Indicates which nDisplay actor to use

  • num_editor_devices (int32): [Read-Write] Number of Editor devices that it should create

  • use_localhost (bool): [Read-Write] Indicates that Switchboard should override IP addresses with localhost

property auto_connect: bool

[Read-Write] Indicates that Switchboard should auto-connect to the listeners of each created device

Type:

(bool)

property config_name: str

[Read-Write] Optional name of the new config. If left empty, a name will be autogenerated.

Type:

(str)

property dcra: DisplayClusterRootActorReference

[Read-Write] Indicates which nDisplay actor to use

Type:

(DisplayClusterRootActorReference)

property num_editor_devices: int

[Read-Write] Number of Editor devices that it should create

Type:

(int32)

property use_localhost: bool

[Read-Write] Indicates that Switchboard should override IP addresses with localhost

Type:

(bool)