FB1SiteEventRoleInfo

Overview

Defines a participant role within a site event, including assignment constraints and lifecycle scripts.

Metadata

Field	Value
Kind	`struct`
Environment	B1 - Presentation
Category	`structs`

Properties (21)

Name	Type	Description
`ActivityInfo`	`FB1SiteEventRoleActivityInfo`	The activity info defining recommended/banned activities and dress code for this role.
`ArrivedInteractionBagId`	`string`	The interaction bag ID played when a member assigned to this role arrives at the event site.
`ArrivedScriptInfos`	`FB1SiteEventScriptInfo[]`	Scripts executed when this role's member arrives at the event site.
`CancelScriptInfos`	`FB1SiteEventScriptInfo[]`	Scripts executed when the event is cancelled for this role's member.
`CreateScriptInfos`	`FB1SiteEventScriptInfo[]`	Scripts executed when this role's member is created for the event.
`FinishScriptInfos`	`FB1SiteEventScriptInfo[]`	Scripts executed when the event finishes for this role's member.
`IsFixedRole`	`boolean`	Whether this role is permanently fixed and cannot be changed after assignment.
`IsHostRole`	`boolean`	Whether this role belongs to the event host.
`IsPossessCharacterRole`	`boolean`	Whether this role is assigned to the currently possessed (player-controlled) character.
`ListKey`	`string`	A list key used to group or look up this role in UI or data processing.
`MaxRoleNum`	`integer`	The maximum number of members allowed for this role.
`MinRoleNum`	`integer`	The minimum number of members required for this role.
`NameTextId`	`string`	The localized display name text ID for this role.
`PickNum`	`integer`	The number of additional members without a host relationship to invite for this role (0 means none).
`PickType`	`EB1MemberPickType`	The method by which members are selected for this role.
`RequiredRole`	`boolean`	Whether at least one member must fill this role for the event to proceed.
`RoleConditionId`	`string`	The condition ID that must be satisfied for a character to be eligible for this role.
`RoleDescTextId`	`string`	The localized description text ID for this role.
`RoleId`	`string`	The unique identifier for this role within the site event.
`StartScriptInfos`	`FB1SiteEventScriptInfo[]`	Scripts executed when the event starts for this role's member.
`bShowRoleName`	`boolean`	Whether the role name is displayed in the UI for this role.