Condition_IsCohabitable
Description
Checks if Self can cohabit with Target based on relationship stats and common prerequisites. Common conditions: Self must have a home, Self and Target must not already share a household, neither of them may live in another city (a zoi summoned from a remote city included), and both must be at least Youth age. If those pass, iterates through CohabitPriorityRelationshipStatIds and returns true only if the highest-priority qualifying stat matches S1.
Note
Returns false regardless of CompareType when common prerequisites are not met. Requires HouseholdDataAsset for cohabitation priority and condition thresholds.
Parameters
| Parameter | Description |
|---|---|
| BaseObject | Self is the initiating character; Target is the candidate for cohabitation |
| CompareType | Supported compare types: Equal, None, NotEqual |
| S1 | Relationship stat name expected as the highest-priority cohabit qualifying reason |
Examples
| Description | BaseObject | Command | CompareType |
|---|---|---|---|
| If Target is cohabitable due to romance | Self | IsCohabitable | Equal |
| If Target is cohabitable due to friendship | Self | IsCohabitable | Equal |
| If Target is not cohabitable | Self | IsCohabitable | NotEqual |
| Check cohabitability from Target's perspective | Target | IsCohabitable | Equal |
Back to Command FinderSearch and filter all 491 Script Condition documents