Execute_CustomMobileMessage

Description

Sends a custom mobile message to the recipient determined by MobileMessageParties data. If no MobileMessageParties data is available, BaseObject is treated as sender and the other entity as receiver.

Parameters

Parameter	Description
BaseObject	Reference entity; sender and receiver are determined by MobileMessageParties
S1	CustomMobileMessageId (linked to id in CustomMobileMessage.json)
S2	UseDeathReason to inject the death cause into the body, otherwise None

S2=UseDeathReason only has an effect on a script run from the death distribution task, which is what carries the cause; anywhere else the cause is empty and the body prints without it. The message body must contain a {DeathReason} placeholder for the cause to appear.

Examples

Description	BaseObject	Command	S1	S2
Send a donation thank-you text message	Self	CustomMobileMessage	Atm_Donation_Result	None
Send a birthday greeting message	Self	CustomMobileMessage	Birthday_Greeting	None
Send a welcome message from a friend	Target	CustomMobileMessage	Welcome_Message_01	None
Send the obituary with the death cause	Target	CustomMobileMessage	Dead_Message	UseDeathReason