Updated on November 3, 2022

Messaging

Author: admin 97 views

Functional messaging app which supports getting and sending messages at runtime.

Workflow

Messaging app depends on its manager and scriptable objects. In order to add a new chat, you have to create a new chat asset from Assets > Create > DreamOS > New Messaging Chat. You can now select Canvas > Managers > Messaging and add hit add a new chat, and then assign the asset you’ve created. Each item has its own unique title and person data. All of the messages in the chat asset will be generated at runtime.

Properties

Property Type Function

debugStoryTeller
bool

Allows storyteller items to be initialized by their ID when enabled.

useNotifications
bool

Creates a notification when a new message is received.

saveSentMessages
bool

Allows custom messages to be saved. Requires MessageStoring component.

currentLayout
int

Returns the current chat layout index.

selectedLayout
GameObject

Returns the current chat layout game object.

Scripting

				
					using Michsky.DreamOS; // namespace

public MessagingManager messagingApp;

void YourFunction()
{
   // Force chat data to be updated
   messagingApp.InitializeChat();
  
   // Instantiate standard messages - you can leave parent as null and set a layoutIndex instead
   messagingApp.CreateMessage(Transform parent, int layoutIndex, "Message content");
   messagingApp.CreateIndividualMessage(Transform parent, int layoutIndex, "Message content");
  
   // Instantiate date indicator - you can leave parent as null and set a layoutIndex instead
   messagingApp.CreateDate(Transform parent, int layoutIndex, "Message content");
  
   // Instantiate image message - you can leave parent as null and set a layoutIndex instead
   messagingApp.CreateImageMessage(Transform parent, int layoutIndex, Sprite sprite, "Title", "Description");
   messagingApp.CreateIndividualImageMessage(Transform parent, int layoutIndex, Sprite sprite, "Title", "Description");
  
   // Instantiate audio message - you can leave parent as null and set a layoutIndex instead
   messagingApp.CreateAudioMessage(Transform parent, int layoutIndex, AudioClip audio);
   messagingApp.CreateIndividualAudioMessage(Transform parent, int layoutIndex, AudioClip audio);
  
   // Create storyteller
   messagingApp.CreateStoryTeller("Message/Chat ID", "StoryTeller Item ID");
  
   // Disable specific dynamic message reply
   messagingApp.DisableDynamicMessageReply("Message ID");
}

Storyteller Events

If you want to invoke specific events on reply selection, you can add ‘Storyteller Reply Event’ component to any of your objects.

Content