a library to speed up the development of Fivem scripts and frameworks
fivem-ts - Documentation v0.7.5 • Docs
fivem-ts - Documentation v0.7.5 / Client / RelationshipGroup
Class to create and manage a relationship group. Useful to manage behavior between Peds.
new RelationshipGroup(
name,groupHash?):RelationshipGroup
Create a relationship group. Optionally pass a group hash.
• name: string
Name of the relationship group.
• groupHash?: number
Optional custom group hash (default: 0).
client/RelationshipGroup.ts:18
getHash():number
Gets the hash of the relationship group.
number
The hash of this object.
client/RelationshipGroup.ts:28
clearRelationshipBetweenGroups(
targetGroup,relationship,biDirectionally):void
Clear the relationship between this relationship group and another.
• targetGroup: RelationshipGroup
The other relationship group.
• relationship: Relationship
The desired relationship to clear.
• biDirectionally: boolean = false
Whether the target group should also clear the relationship.
void
client/RelationshipGroup.ts:68
getRelationshipBetweenGroups(
targetGroup):Relationship
Get the relationship between two relationship groups.
• targetGroup: RelationshipGroup
The other relationship group.
The relationship
client/RelationshipGroup.ts:38
remove():
void
Remove this relationship group from the game. This will not delete this object.
void
client/RelationshipGroup.ts:83
setRelationshipBetweenGroups(
targetGroup,relationship,biDirectionally):void
Set the relationship group between this relationship group and another one.
• targetGroup: RelationshipGroup
The other relationship group.
• relationship: Relationship
The desired relationship.
• biDirectionally: boolean = false
If target group should have same relationship towards this.
void