Skip to main content

B1MobileMessage

  • Runtime representation of a single mobile message entry in a conversation thread.
    * Stores the message text, read/send state, response data, scripts, and custom response information.
PropertyTypeDescriptionMetadata
MessageIdFStringUnique runtime ID for this message instance within the conversation thread.
DeathReasonTextIdFStringString table key of the death cause injected into the obituary body when the text is formatted. Empty omits the cause.
MessageTextFTextLocalized display text of the message body.
bIsSendboolWhether this message was sent by the player (true) or received from another character (false).
bNeedResponseboolWhether this message is awaiting a response from the player.
bNeedResponseReplyboolWhether this message requires a follow-up reply after the player's response.
bIsReadboolWhether the player has opened and read this message.
bIsPlainTextboolWhether this message was created from a plain text string rather than a string table entry.
bIsWaitboolWhether this message is waiting for a script to resolve before being displayed.
WaitScriptIdsTArrayIDs of the scripts that must complete before this message's wait state resolves.
DelayTimefloatReal-time delay in seconds before this message is displayed in the conversation UI.
RelationShipStatIdFNameID of the relationship stat modified when the player responds to this message.
RelationShipPointfloatAmount by which the relationship stat changes when the player responds.
TimeStampFDateTimeReal-world timestamp recording when this message was created or received.
ResponseTimeoutint32Time in in-game minutes before the response window expires; -1 means no timeout.
PositiveAnswerDeadlineTicksint64Absolute in-game tick deadline for accepting a positive answer; -1 means no deadline.
ReceivedScriptIdsTArrayScripts executed when this message is received by the target.
OpenScriptIdsTArrayScripts executed when the player opens and reads this message.
PoolIdFNameID of the message pool from which this message was selected.
bUseSendTableboolWhether this message was created from a send message table (player-initiated).
bCanStartNewChatboolWhether starting a new chat conversation is allowed after this message; only valid when the other party is not a system.
bSetResponseTimerboolWhether the response timer has been set for this message.
bIsIgnoredboolWhether the other character ignored this message instead of responding.
SendResponseFB1MobileMessageSendDataResponse data selected for this message in a player-initiated send flow.
CustomResponseFB1MobileMessageCustomResponseCustom response data associated with this message when it originates from a custom message table row.
bIsNeedConvertMessageboolWhether the message text requires runtime conversion to insert dynamic content.