Condition_IsFamilyHead
Description
Checks whether the BaseObject is the head of their household. The household head is determined as the oldest member of the household.
When S1 is ExcludeBusyElsewhere, members who BOTH have an active schedule (B2TimelineComponent::GetScheduleAtNow() != nullptr) AND are located at a different site from the BaseObject are excluded from the candidate pool. Members who are at the same site as the BaseObject — including the BaseObject itself — remain candidates regardless of schedule. The head is then the oldest among the remaining members. If every other member is busy elsewhere, only the BaseObject remains and is treated as the head.
If no valid head can be determined (e.g., household lookup fails, no member has a valid BioComponent, or every member is filtered out), the condition returns false regardless of CompareType — i.e., neither Equal nor NotEqual is satisfied.
Parameters
| Parameter | Description |
|---|---|
| BaseObject | Character whose household head status will be checked (Self or Target) |
| CompareType | Supported compare types: Equal, NotEqual |
| S1 | Optional. ExcludeBusyElsewhere to exclude members scheduled at a different site |
Examples
| Description | BaseObject | Command | CompareType | S1 |
|---|---|---|---|---|
| If Self is the head of the household | Self | IsFamilyHead | Equal | |
| If Self is not the head of the household | Self | IsFamilyHead | NotEqual | |
| If Target is the head of the household | Target | IsFamilyHead | Equal | |
| If Target is not the head of the household | Target | IsFamilyHead | NotEqual | |
| If Self is the head among members at the same site or with no current schedule | Self | IsFamilyHead | Equal | ExcludeBusyElsewhere |
| If Self is not the head among members at the same site or with no current schedule | Self | IsFamilyHead | NotEqual | ExcludeBusyElsewhere |