GetHighestRelationshipRank - Actor

From the CreationKit Wiki
Jump to navigation Jump to search

Member of: Actor Script (Papyrus)

Gets the highest relationship rank this actor has.

Syntax[edit | edit source]

int Function GetHighestRelationshipRank() native

Parameters[edit | edit source]

None.

Return Value[edit | edit source]

The highest relationship rank this actor has.

The following values are returned:

  • 4: Lover
  • 3: Ally
  • 2: Confidant
  • 1: Friend
  • 0: Acquaintance
  • -1: Rival
  • -2: Foe
  • -3: Enemy
  • -4: Archnemesis

Examples[edit | edit source]

; Get Alice's highest relationship rank
int bestRelationship = Alice.GetHighestRelationshipRank()

See Also[edit | edit source]

Notes[edit | edit source]

This function does not take into account changes made during run time. Values from design time show correctly.

 actor akRef = Someone
                                                                ; Debug.MessageBox results
 string A = akRef.GetHighestRelationshipRank() + "\n"           ; 0
 string B = PlayerRef.GetHighestRelationshipRank() + "\n"       ; 3
 string C = akRef.GetRelationshipRank(PlayerRef) + "\n"         ; 0
 string D = PlayerRef.GetRelationshipRank(akRef)  + "\n"        ; 0
 
 akRef.SetRelationshipRank(PlayerRef, 4)
 PlayerRef.SetRelationshipRank(akRef, 4)
 
 string E = akRef.GetHighestRelationshipRank() + "\n"           ; 0 <- should be 4
 string F = PlayerRef.GetHighestRelationshipRank() + "\n"       ; 3 <- should be 4
 string G = akRef.GetRelationshipRank(PlayerRef) + "\n"         ; 4
 string H = PlayerRef.GetRelationshipRank(akRef)   + "\n"       ; 4
 
 Debug.MessageBox(A+B+C+D+"*\n"+E+F+G+H)