Skip to main content

Execute_RemoveRelationshipName

Description

Removes the specified relationship name between Self and Target. If S2 is RemoveAll, the relationship name is removed from all relationships of Self (in both directions). If S2 is empty, the removal applies bidirectionally between Self and Target.

Parameters

ParameterDescription
BaseObjectCharacter whose relationship name is removed (Self or Target)
S1Relationship ID to remove (defined in Relationship.json)
S2Set to RemoveAll to remove this relationship name from all of BaseObject's relationships

Examples

DescriptionBaseObjectCommandS1S2
Remove engagement relationship between Self and TargetSelfRemoveRelationshipNameengagement
Remove all engagement relationships Self hasSelfRemoveRelationshipNameengagementRemoveAll
Remove best friend relationship between Self and TargetSelfRemoveRelationshipNameBestFriend
Remove all ex-spouse relationships Target hasTargetRemoveRelationshipNameExSpouseRemoveAll