Dynamic Values

Using Global Dynamic Values

Dynamic values need Game Creator 2 Dialogue and the Mailbox Dialogue integration. Run Game Creator > Mailbox > Detect and Install Integration if Dialogue was added later.

Use a Dynamic String for a title or sender and a Dynamic Text Area for the body. Place values such as {Player} in the text and define them in the Dialogue Settings window.

Changing a normal String or Text Area to a Dynamic field clears its existing text. Back up the letter content before changing its field type.

Visual Scripting

The entries below are copied from the package definitions. Use the child pages to browse them by type.

Instructions

Clear Mailbox (InstructionClearMailbox)

• Title: Clear Mailbox
• Description: Removes all letters from the Mailbox
• Category: Mailbox/Management/Clear Mailbox
• Parameters:
• Mailbox - The Game Object with the mailbox component
• Keywords: Clear, Empty, Remove, All, Letters, Mailbox
• Source: Mailbox/Runtime/Instructions/InstructionClearMailbox.cs

Delete Letter (InstructionDeleteLetter)

• Title: Delete Letter
• Description: Deletes a Letter from the Mailbox
• Category: Mailbox/Management/Delete Letter
• Parameters:
• Letter - The letter to be deleted
• Mailbox - The Game Object with the mailbox component
• Keywords: Delete, Remove, Letter, Mailbox
• Source: Mailbox/Runtime/Instructions/InstructionDeleteLetter.cs

Claim Item in Letter (InstructionLettersClaimItem)

• Title: Claim Item in Letter
• Description: Claims an item at a specific index in a Letter, adds it to a Bag with the set amount, and sets its properties
• Category: Mailbox/Claim Item in Letter
• Parameters:
• Letter - The letter containing the item to claim
• Mailbox - The Game Object with the mailbox component.
• Item Index - The index of the item to claim (0-based)
• Bag - The Bag where the item will be added
• Keywords: Claim, Item, Letter, Mailbox, Inventory
• Source: Mailbox/Runtime/Instructions/InstructionLettersClaimItem.cs

Mark Letter as Hidden (InstructionLettersMarkAsHidden)

• Title: Mark Letter as Hidden
• Description: Marks a Letter as hidden in the Mailbox
• Category: Mailbox/Management/Mark Letter as Hidden
• Parameters:
• Letter - The letter to be marked as hidden
• Mailbox - The Game Object with the mailbox component.
• Keywords: Mailbox, Hide, Letter, Hidden
• Source: Mailbox/Runtime/Instructions/InstructionLettersMarkAsHidden.cs

Mark Letter as Read (InstructionLettersMarkAsRead)

• Title: Mark Letter as Read
• Description: Marks a Letter as read in the Mailbox
• Category: Mailbox/Management/Mark Letter as Read
• Parameters:
• Letter - The letter to be marked as read
• Mailbox - The Game Object with the mailbox component.
• Keywords: Mailbox, Read, Letter
• Source: Mailbox/Runtime/Instructions/InstructionLettersMarkAsRead.cs

Set Letter (InstructionLettersSetLetter)

• Title: Set Letter
• Description: Saves a Letter on a Variable
• Category: Mailbox/Management/Set Letter
• Parameters:
• Set - The Variable that saves the Letter
• Letter - The letter to set
• Keywords: Save, Keep, Letter, Mailbox
• Source: Mailbox/Runtime/Instructions/InstructionLettersSetLetter.cs

Send Letters to Mailbox (InstructionSendAutomaticLettersToPlayer)

• Title: Send Letters to Mailbox
• Description: Sends all letters to the mailbox that meet the set conditions inside the letters
• Category: Mailbox/Sending/Send Letters
• Parameters:
• Mailbox - The Game Object with the mailbox component.
• Keywords: Mailbox, Send, Automatic, Letter, Post
• Source: Mailbox/Runtime/Instructions/InstructionSendAutomaticLettersToPlayer.cs

Send Letter to Mailbox (InstructionSendLetterToMailbox)

• Title: Send Letter to Mailbox
• Description: Manually send a letter to a mailbox
• Category: Mailbox/Sending/Send Letter Manually
• Parameters:
• Mailbox - The Game Object with the mailbox component.
• Letter - The Letter to send to the mailbox
• Keywords: Mailbox, Send, Letter, Post
• Source: Mailbox/Runtime/Instructions/InstructionSendLetterToMailbox.cs

Send Random Letter to Mailbox (InstructionSendRandomLetterToPlayer)

• Title: Send Random Letter to Mailbox
• Description: Attempts to send one random letter to the mailbox based on chance.
• Category: Mailbox/Sending/Send Random Letter
• Parameters:
• Mailbox - The Game Object with the mailbox component.
• Force Send - If true, ensures a letter is sent, ignoring its probability.
• Keywords: Mailbox, Send, Random, Letter, Post
• Source: Mailbox/Runtime/Instructions/InstructionSendRandomLettersToPlayer.cs

Conditions

Check for Random Letters in Mailbox (ConditionCheckRandomLettersInMailbox)

• Title: Check for Random Letters in Mailbox
• Description: Returns true if there are any random letters left that the mailbox hasn't received yet.
• Category: Mailbox/Letter/Check Random Letters
• Parameters:
• Mailbox - The Game Object with the mailbox component
• Keywords: Mailbox, Check, Random, Letter
• Source: Mailbox/Runtime/Conditions/ConditionCheckRandomLettersInMailbox.cs

Check for Unclaimed Items in Letter (ConditionCheckUnclaimedItemsInLetter)

• Title: Check for Unclaimed Items in Letter
• Description: Returns true if there are any unclaimed items in a specific letter.
• Category: Mailbox/Item/Check Unclaimed Items in Letter
• Parameters:
• Mailbox - The Game Object with the mailbox component
• Letter - The specific Letter to check for unclaimed items
• Keywords: Mailbox, Letter, Unclaimed, Item, Gift
• Source: Mailbox/Runtime/Conditions/ConditionCheckUnclaimedItemsInLetter.cs

Check for Unclaimed Items in Mailbox (ConditionCheckUnclaimedItemsInMailbox)

• Title: Check for Unclaimed Items in Mailbox
• Description: Returns true if there are any unclaimed items in any letter in the mailbox.
• Category: Mailbox/Item/Check Unclaimed Items in Mailbox
• Parameters:
• Mailbox - The Game Object with the mailbox component
• Keywords: Mailbox, Unclaimed, Item, Letter, Mail, Gift
• Source: Mailbox/Runtime/Conditions/ConditionCheckUnclaimedItemsInMailbox.cs

Check for Unread letter in Mailbox (ConditionCheckUnreadMailInMailbox)

• Title: Check for Unread letter in Mailbox
• Description: Returns true if there are any unread letters in the mailbox.
• Category: Mailbox/Letter/Check Unread Letter
• Parameters:
• Mailbox - The Game Object with the mailbox component
• Keywords: Mailbox, Unread, Letter
• Source: Mailbox/Runtime/Conditions/ConditionCheckUnreadMailInMailbox.cs

Is Equal to Letter (ConditionLetterEqual)

• Title: Is Equal to Letter
• Description: Returns true if the letter is equal to another one
• Category: Mailbox/Letter/Is Equal to Letter
• Parameters:
• Letter - The letter source
• Compare To - The letter to compare with
• Keywords: Letter, Compare, Mailbox
• Source: Mailbox/Runtime/Conditions/ConditionLetterEqual.cs

Does Letter Contain Items (ConditionLettersHasItems)

• Title: Does Letter Contain Items
• Description: Returns true if a given Letter within the Mailbox contains any items
• Category: Mailbox/Item/Does Letter Contain Items
• Parameters:
• Letter - The letter to check for items
• Mailbox - The Game Object with the mailbox component
• Keywords: Letter, Mailbox, Item, Contains
• Source: Mailbox/Runtime/Conditions/ConditionLettersHasItems.cs

Is Item Claimed in Letter (ConditionLettersIsItemClaimed)

• Title: Is Item Claimed in Letter
• Description: Returns true if an item at a specific index in a Letter within the Mailbox has been claimed
• Category: Mailbox/Item/Is Item Claimed in Letter
• Parameters:
• Letter - The letter containing the item to check
• Mailbox - The Game Object with the mailbox component
• Item Index - The index of the item to check
• Keywords: Claim, Item, Letter, Mailbox
• Source: Mailbox/Runtime/Conditions/ConditionLettersIsItemClaimed.cs

Is Letter Read (ConditionMailboxHasReadLetter)

• Title: Is Letter Read
• Description: Returns true if the specified letter has been read in the mailbox
• Category: Mailbox/Letter/Is Letter Read
• Parameters:
• Letter - The letter to check if it has been read
• Mailbox - The Game Object with the mailbox component
• Keywords: Mailbox, Read, Letter
• Source: Mailbox/Runtime/Conditions/ConditionMailboxHasReadLetter.cs

Has Received Letter (ConditionMailboxHasReceivedLetter)

• Title: Has Received Letter
• Description: Returns true if the specified letter exists in the mailbox
• Category: Mailbox/Letter/Has Received Letter
• Parameters:
• Letter - The letter to check if it exists in the mailbox
• Mailbox - The Game Object with the mailbox component
• Keywords: Mailbox, Received, Letter, Exists
• Source: Mailbox/Runtime/Conditions/ConditionMailboxHasReceivedLetter.cs

Triggers

On Letter Deleted (EventOnLetterDeleted)

• Title: On Letter Deleted
• Description: Executed when a letter is deleted from the mailbox.
• Category: Mailbox/On Letter Deleted
• Parameters:
• Mailbox - The Game Object with the mailbox component
• Keywords: Mailbox, Letter, Delete, Remove
• Source: Mailbox/Runtime/Events/EventOnLetterDeleted.cs

On Letter Hidden (EventOnLetterHidden)

• Title: On Letter Hidden
• Description: Executed when a letter is hidden in the mailbox.
• Category: Mailbox/On Letter Hidden
• Parameters:
• Mailbox - The Game Object with the mailbox component
• Keywords: Mailbox, Letter, Hide, Invisible
• Source: Mailbox/Runtime/Events/EventOnLetterHidden.cs

On Letter Opened (EventOnLetterOpened)

• Title: On Letter Opened
• Description: Executed when a letter is opened in the mailbox.
• Category: Mailbox/On Letter Opened
• Parameters:
• Mailbox - The Game Object with the mailbox component
• Keywords: Mailbox, Letter, Open
• Source: Mailbox/Runtime/Events/EventOnLetterOpened.cs

On Letter Received (EventOnLetterReceived)

• Title: On Letter Received
• Description: Executed when a letter is received by the mailbox.
• Category: Mailbox/On Letter Received
• Parameters:
• Mailbox - The Game Object with the mailbox component
• Keywords: Mailbox, Letter, Receive
• Source: Mailbox/Runtime/Events/EventOnLetterReceived.cs

Properties

Get properties

Letter Colors (GetColorsLetter)

• Title: Letter Colors
• Description: Gets various colors from the Letter theme
• Category: Mailbox/Letter Colors
• Type: Color
• Parameters: None specified
• Keywords: None specified
• Source: Mailbox/Runtime/Properties/Get/GetColorsLetter.cs

Total Letters Count (GetDecimalTotalLetters)

• Title: Total Letters Count
• Description: Returns the total number of letters in a mailbox as a decimal, excluding hidden letters
• Category: Mailbox/Total Letters Count
• Type: Decimal
• Parameters: None specified
• Keywords: None specified
• Source: Mailbox/Runtime/Properties/Get/GetDecimalTotalLetters.cs

Unread Letters Count (GetDecimalUnreadLetters)

• Title: Unread Letters Count
• Description: Returns the number of unread letters in a mailbox as a decimal
• Category: Mailbox/Unread Letters Count
• Type: Decimal
• Parameters: None specified
• Keywords: None specified
• Source: Mailbox/Runtime/Properties/Get/GetDecimalUnreadLetters.cs

Game Object Child Order (GetGameObjectChildOrder)

• Title: Game Object Child Order
• Description: Gets the index of the GameObject within its parent's children.
• Category: Mailbox/Transforms/Game Object Child Order
• Type: Decimal
• Parameters: None specified
• Keywords: None specified
• Source: Mailbox/Runtime/Properties/Get/GetGameObjectChildOrder.cs

Letter from GameObject (GetLetterFromGameObject)

• Title: Letter from GameObject
• Description: Gets a Letter from a GameObject with a LetterItemUI or LetterUI component
• Category: Mailbox/Letter from GameObject
• Type: Letter
• Parameters: None specified
• Keywords: None specified
• Source: Mailbox/Runtime/Properties/Get/GetLetterFromGameObject.cs

Global Letter Variable (GetLetterGlobal)

• Title: Global Letter Variable
• Description: Returns the Letter value of a Global Letter Variable
• Category: Variables/Global Letter Variable
• Type: Letter
• Parameters: None specified
• Keywords: None specified
• Source: Mailbox/Runtime/Properties/Get/GetLetterGlobalVariable.cs

Letter (GetLetterInstance)

• Title: Letter
• Description: A reference to a Letter asset
• Category: Letter
• Type: Letter
• Parameters: None specified
• Keywords: None specified
• Source: Mailbox/Runtime/Properties/Get/GetLetterInstance.cs

Local Letter Variable (GetLetterLocal)

• Title: Local Letter Variable
• Description: Returns the Letter value of a Local Letter Variable
• Category: Variables/Local Letter Variable
• Type: Letter
• Parameters: None specified
• Keywords: None specified
• Source: Mailbox/Runtime/Properties/Get/GetLetterLocalVariable.cs

Current Open Letter (GetLetterMailboxCurrent)

• Title: Current Open Letter
• Description: Returns the currently open letter from the Mailbox
• Category: Current Open Letter
• Type: Letter
• Parameters: None specified
• Keywords: None specified
• Source: Mailbox/Runtime/Properties/Get/GetLetterMailboxCurrent.cs

None (GetLetterNone)

• Title: None
• Description: An empty reference to an Letter
• Category: None
• Type: Letter
• Parameters: None specified
• Keywords: None specified
• Source: Mailbox/Runtime/Properties/Get/GetLetterNone.cs

Letter Item Sprite by Index (GetSpriteLetterFirstItem)

• Title: Letter Item Sprite by Index
• Description: Returns the Sprite of an Item at the specified index in a Letter's item list
• Category: Mailbox/Item List Item Sprite
• Type: Sprite
• Parameters: None specified
• Keywords: None specified
• Source: Mailbox/Runtime/Properties/Get/GetSpriteLetterFirstItem.cs

Read Icon (GetSpriteReadIcon)

• Title: Read Icon
• Description: Gets the Read Icon from the Letter asset
• Category: Mailbox/Read Icon
• Type: Sprite
• Parameters: None specified
• Keywords: None specified
• Source: Mailbox/Runtime/Properties/Get/GetSpriteReadIcon.cs

Sender Icon (GetSpriteSenderIcon)

• Title: Sender Icon
• Description: Gets the Sender Icon from the Letter asset
• Category: Mailbox/Sender Icon
• Type: Sprite
• Parameters: None specified
• Keywords: None specified
• Source: Mailbox/Runtime/Properties/Get/GetSpriteSenderIcon.cs

Unread Icon (GetSpriteUnreadIcon)

• Title: Unread Icon
• Description: Gets the Unread Icon from the Letter ScriptableObject
• Category: Mailbox/Unread Icon
• Type: Sprite
• Parameters: None specified
• Keywords: None specified
• Source: Mailbox/Runtime/Properties/Get/GetSpriteUnreadIcon.cs

Dynamic String (GetStringDynamicString)

• Title: Dynamic String
• Description: A string of characters that supports global dynamic value replacement
• Category: Mailbox/Text/Dynamic String
• Type: String
• Parameters: None specified
• Keywords: String, Value, Dynamic, Global
• Source: Mailbox/Runtime/Properties/Get/GetStringDynamicString.cs

Dynamic Text Area (GetStringDynamicTextArea)

• Title: Dynamic Text Area
• Description: A string of characters with line breaks that supports global dynamic value replacement
• Category: Mailbox/Text/Dynamic Text Area
• Type: String
• Parameters: None specified
• Keywords: String, Value, Dynamic, Global
• Source: Mailbox/Runtime/Properties/Get/GetStringDynamicTextArea.cs

Letter Body (GetStringLetterDescription)

• Title: Letter Body
• Description: Returns the body of the Letter
• Category: Mailbox/Letter Body
• Type: String
• Parameters: None specified
• Keywords: None specified
• Source: Mailbox/Runtime/Properties/Get/GetStringLetterDescription.cs

Letter ID (GetStringLetterID)

• Title: Letter ID
• Description: Returns the ID of the Letter
• Category: Mailbox/Letter ID
• Type: String
• Parameters: None specified
• Keywords: None specified
• Source: Mailbox/Runtime/Properties/Get/GetStringLetterID.cs

Letter Received Date (GetStringLetterReceivedDate)

• Title: Letter Received Date
• Description: Returns the date when the Letter was received in the Mailbox
• Category: Mailbox/Letter Received Date
• Type: String
• Parameters: None specified
• Keywords: None specified
• Source: Mailbox/Runtime/Properties/Get/GetStringLetterReceivedDate.cs

Letter Sender (GetStringLetterSender)

• Title: Letter Sender
• Description: Returns the sender's name of the Letter
• Category: Mailbox/Letter Sender
• Type: String
• Parameters: None specified
• Keywords: None specified
• Source: Mailbox/Runtime/Properties/Get/GetStringLetterSender.cs

Letter Title (GetStringLetterTitle)

• Title: Letter Title
• Description: Returns the title of the Letter
• Category: Mailbox/Letter Title
• Type: String
• Parameters: None specified
• Keywords: None specified
• Source: Mailbox/Runtime/Properties/Get/GetStringLetterTitle.cs

System Time (GetStringSystemTime)

• Title: System Time
• Description: Returns the current system time formatted based on selected options
• Category: Mailbox/System Time
• Type: String
• Parameters: None specified
• Keywords: None specified
• Source: Mailbox/Runtime/Properties/Get/GetStringSystemTime.cs

PropertyGetLetter (PropertyGetLetter)

• Title: Not specified
• Description: Not specified
• Category: Not specified
• Type: Letter
• Parameters: None specified
• Keywords: None specified
• Source: Mailbox/Runtime/Properties/Get/PropertyGetLetter.cs

Letter (PropertyTypeGetLetter)

• Title: Letter
• Description: Not specified
• Category: Not specified
• Type: Letter
• Parameters: None specified
• Keywords: None specified
• Source: Mailbox/Runtime/Properties/Get/PropertyTypeGetLetter.cs

Set properties

PropertySetLetter (PropertySetLetter)

• Title: Not specified
• Description: Not specified
• Category: Not specified
• Type: Letter
• Parameters: None specified
• Keywords: None specified
• Source: Mailbox/Runtime/Properties/Set/PropertySetLetter.cs

PropertyTypeSetLetter (PropertyTypeSetLetter)

• Title: Not specified
• Description: Not specified
• Category: Not specified
• Type: Letter
• Parameters: None specified
• Keywords: None specified
• Source: Mailbox/Runtime/Properties/Set/PropertyTypeSetLetter.cs

Global Name Variable (SetLetterGlobalName)

• Title: Global Name Variable
• Description: Sets the Letter value on a Global Name Variable
• Category: Global Name Variable
• Type: Letter
• Parameters: None specified
• Keywords: None specified
• Source: Mailbox/Runtime/Properties/Set/SetLetterGlobalName.cs

Local Name Variable (SetLetterLocalName)

• Title: Local Name Variable
• Description: Sets the Letter value on a Local Name Variable
• Category: Local Name Variable
• Type: Letter
• Parameters: None specified
• Keywords: None specified
• Source: Mailbox/Runtime/Properties/Set/SetLetterLocalName.cs

SetLetterNone (SetLetterNone)

• Title: Not specified
• Description: Not specified
• Category: Not specified
• Type: Letter
• Parameters: None specified
• Keywords: None specified
• Source: Mailbox/Runtime/Properties/Set/SetLetterNone.cs