Skip to main content

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

ParameterDescription
BaseObjectSelf is the initiating character; Target is the candidate for cohabitation
CompareTypeSupported compare types: Equal, None, NotEqual
S1Relationship stat name expected as the highest-priority cohabit qualifying reason

Examples

DescriptionBaseObjectCommandCompareType
If Target is cohabitable due to romanceSelfIsCohabitableEqual
If Target is cohabitable due to friendshipSelfIsCohabitableEqual
If Target is not cohabitableSelfIsCohabitableNotEqual
Check cohabitability from Target's perspectiveTargetIsCohabitableEqual