RelationPacket
Module: Inworld.AI. Namespace: Inworld.Packet. Inherited from InworldPacket
This packet is used for character relationship updates.
Variables | Description |
---|---|
debugInfo | The RelationEvent of the packet. |
Properties | Description |
---|---|
Relation | Get the detailed relation update. |
Related Classes
RelationEvent
Module: Inworld.AI. Namespace: Inworld.Packet.
This class represents a "RelationEvent," which encapsulates the relationship data received within the packet.
Variables | Description |
---|---|
relation | The RelationData received in this event. |
RelationData
Module: Inworld.AI. Namespace: Inworld.Packet.
"RelationData" comprises crucial information that character interactions rely on, reflecting the current and incoming state of character relationships.
Variables | Description |
---|---|
relationState | The current RelationState. |
relationUpdate | The incoming RelationState. |
RelationState
Module: Inworld.AI. Namespace: Inworld.Packet.
The "RelationState" class breaks down relationship information into various attributes, each contributing to the overall dynamics of character interactions.
Variables | Description |
---|---|
trust | Reflects the level of trust between player and the character. |
respect | Indicates the degree of respect shown by the character. |
familiar | Represents the level of familiarity shared by the character. |
flirtatious | Captures the extent of flirtatious interactions of the character. |
attraction | Measures the level of mutual attraction of the character. |
Functions | Description | Parameters |
---|---|---|
IsEqualTo | Return if this RelationState is equal to the required RelationState. | url: the incoming RelationState. |
ToString | RelationState as a string representation. | |
UpdateByTrigger | Update the current RelationState by the TriggerParameter | input: the returned TriggerParameter |
GetUpdate | Return a string summarizing the relationship updates based on the incoming RelationState. | url: the incoming RelationState. |