Skip to main content

FB1MobileMessage

Overview

  • 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.

Metadata

FieldValue
Kindstruct
EnvironmentB1 - Presentation
Categorystructs

Properties (26)

NameTypeDescription
CustomResponseFB1MobileMessageCustomResponseCustom response data associated with this message when it originates from a custom message table row.
DeathReasonTextIdstringString table key of the death cause injected into the obituary body when the text is formatted. Empty omits the cause.
DelayTimenumberReal-time delay in seconds before this message is displayed in the conversation UI.
MessageIdstringUnique runtime ID for this message instance within the conversation thread.
MessageTextstringLocalized display text of the message body.
OpenScriptIdsstring[]Scripts executed when the player opens and reads this message.
PoolIdstringID of the message pool from which this message was selected.
PositiveAnswerDeadlineTicksintegerAbsolute in-game tick deadline for accepting a positive answer; -1 means no deadline.
ReceivedScriptIdsstring[]Scripts executed when this message is received by the target.
RelationShipPointnumberAmount by which the relationship stat changes when the player responds.
RelationShipStatIdstringID of the relationship stat modified when the player responds to this message.
ResponseTimeoutintegerTime in in-game minutes before the response window expires; -1 means no timeout.
SendResponseFB1MobileMessageSendDataResponse data selected for this message in a player-initiated send flow.
TimeStampFDateTimeReal-world timestamp recording when this message was created or received.
WaitScriptIdsstring[]IDs of the scripts that must complete before this message's wait state resolves.
bCanStartNewChatbooleanWhether starting a new chat conversation is allowed after this message; only valid when the other party is not a system.
bIsIgnoredbooleanWhether the other character ignored this message instead of responding.
bIsNeedConvertMessagebooleanWhether the message text requires runtime conversion to insert dynamic content.
bIsPlainTextbooleanWhether this message was created from a plain text string rather than a string table entry.
bIsReadbooleanWhether the player has opened and read this message.
bIsSendbooleanWhether this message was sent by the player (true) or received from another character (false).
bIsWaitbooleanWhether this message is waiting for a script to resolve before being displayed.
bNeedResponsebooleanWhether this message is awaiting a response from the player.
bNeedResponseReplybooleanWhether this message requires a follow-up reply after the player's response.
bSetResponseTimerbooleanWhether the response timer has been set for this message.
bUseSendTablebooleanWhether this message was created from a send-message table (player-initiated).