Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RelationshipGroup

Class to create and manage a relationship group. Useful to manage behavior between Peds.

Hierarchy

  • RelationshipGroup

Index

Constructors

constructor

  • Create a relationship group. Optionally pass a group hash.

    Parameters

    • name: string

      Name of the relationship group.

    • Optional groupHash: number

      Optional custom group hash (default: 0).

    Returns RelationshipGroup

Accessors

Hash

  • get Hash(): number
  • Gets the hash of the relationship group.

    Returns number

    The hash of this object.

Methods

clearRelationshipBetweenGroups

  • Clear the relationship between this relationship group and another.

    Parameters

    • targetGroup: RelationshipGroup

      The other relationship group.

    • relationship: Relationship

      The desired relationship to clear.

    • Default value biDirectionally: boolean = false

      Whether the target group should also clear the relationship.

    Returns void

getRelationshipBetweenGroups

remove

  • remove(): void
  • Remove this relationship group from the game. This will not delete this object.

    Returns void

setRelationshipBetweenGroups

  • Set the relationship group between this relationship group and another one.

    Parameters

    • targetGroup: RelationshipGroup

      The other relationship group.

    • relationship: Relationship

      The desired relationship.

    • Default value biDirectionally: boolean = false

      If target group should have same relationship towards this.

    Returns void

Generated using TypeDoc