Skip to main content

MutationPacket

Module: Inworld.AI. Namespace: Inworld.Packet. Inherited from InworldPacket

This packet is used for sending interruption commands.

VariablesDescription
mutationThe MutationEvent of the packet.
FunctionDescriptionParameters
LoadSceneA static method to generate the json of LoadSceneRequest by the scene's full name.sceneFullName: the full string of the InworldScene to load.
LoadCharactersA static method to generate the json of LoadCharactersRequest by the list of the character's full name.characterFullName: the list of the InworldCharacters's full name to load.

MutationEventDeserializer

Module: Inworld.AI. Namespace: Inworld.Packet. Inherited from JsonConverter

PropertiesDescription
CanWriteOverwrote to always return false, as we'll use its default serializer.
FunctionDescriptionParameters
WriteJsonNot used. Just overwrote the default one.writer: the JsonWriter.
value: the object.
serializer: the JsonSerializer.
ReadJsonThe deserializing method to allocate into child classes.reader: the JsonReader.
value: the object.
serializer: the JsonSerializer.
CanConvertCheck if the json can be converted into this class.objectType: the Type to convert.

MutationEvent

Module: Inworld.AI. Namespace: Inworld.Packet.

It's an abstract class, that used to be sent by server, handled by its child classes. There isn't any variables or methods.

LoadCharactersRequest

Module: Inworld.AI. Namespace: Inworld.Packet.

VariablesDescription
nameA list of the CharacterNames to load.

LoadCharactersEvent

Module: Inworld.AI. Namespace: Inworld.Packet. Inherited from MutationEvent

VariablesDescription
loadCharactersThe LoadCharactersRequest to send.

LoadSceneRequest

Module: Inworld.AI. Namespace: Inworld.Packet.

VariablesDescription
nameThe full name of the InworldScene to load.

LoadSceneEvent

Module: Inworld.AI. Namespace: Inworld.Packet. Inherited from MutationEvent

VariablesDescription
loadSceneThe LoadSceneRequest to send.

CancelResponse

Module: Inworld.AI. Namespace: Inworld.Packet.

VariablesDescription
interactionIdThe InteractionID to cancel.
utteranceIdThe list of the UtteranceID to cancel.

CancelResponseEvent

Module: Inworld.AI. Namespace: Inworld.Packet. Inherited from MutationEvent

VariablesDescription
cancelResponsesThe CancelResponse to send.

ApplyResponse

Module: Inworld.AI. Namespace: Inworld.Packet.

VariablesDescription
packetIdThe PacketId to apply.

ApplyResponseEvent

Module: Inworld.AI. Namespace: Inworld.Packet. Inherited from MutationEvent

VariablesDescription
ApplyResponseThe ApplyResponse to send.

RegenerateResponse

Module: Inworld.AI. Namespace: Inworld.Packet.

VariablesDescription
interactionIdThe InteractionID to regenerate.

RegenerateResponseEvent

Module: Inworld.AI. Namespace: Inworld.Packet. Inherited from MutationEvent

VariablesDescription
regenerateResponseThe ApplyResponse to send.