Skip to main content

relationships.get_value_between

Overview

  • Returns relationship stat values from owner toward target. Unlike relationships.get_value, the owner is explicitly specified instead of defaulting to possessed.

Metadata

FieldValue
DisplayGet Relationship Between
Categoryrelationships
AccessPublic
ScopeB2Authority
Tags
Aliases

Parameters

NameTypeRequiredDefaultDescription
owner_identityIdyesOwner character entity ID
target_identityIdyesTarget character entity ID
relationship_idnamenoRelationship stat ID (optional, omit for all)

Returns

  • Freeform result (shape is not fixed).

{ owner_id: int, target_id: int, stats: { <relationship_id>: { value: float, level: int, relationship_id: string } } } — stats is an object keyed dynamically by relationship stat id; empty object if no relationship data.

Usage

await inzoi.cli.execute('relationships.get_value_between', {
owner_id: 0,
target_id: 0,
relationship_id: '', // optional
});