FB2MobileMessageComponent

Overview

Component that manages mobile messages.

Metadata

Field	Value
Kind	`component`
Environment	B2 - Simulation
Category	`components`
Extends	`FB2Component`
Require	`require('Components.B2MobileMessageComponent')`

Properties (11)

Name	Type	Description
`ContactMap`	`FB1MobileContactMap`	Key: target entity id; Value: whether owner has blocked target.
`CurrentTimeTaskIds`	`FB1TimeTaskId[]`
`GlobalSentOnceMessageList`	`FB1SentOnceMessageList`
`MessageCooltime`	`FB1MobileMessageCooltimeMap`	key : owner id
`MessageList`	`FB1MobileMessageListMap`	key : owner id
`MessageListBySystem`	`FB1MobileMessageListBySystemMap`	key : owner id
`PendingResponseReply`	`FB1ResponseReplyRequest[]`
`SendMessageHour`	`integer`
`SendMessageMinute`	`integer`
`bSendMessage`	`boolean`
`bSetMessageTime`	`boolean`

Functions (59)

Function	Parameters	Returns	Description
`AddContact`	InTargetId: `FB1EntityId`	`boolean`	Adds Contact.
`CanReceiveMobilMessage`	InReceiver: `FB1EntityId`	`boolean`	Returns whether it can Receive Mobil Message.
`CanSendMessage`	InSender: `FB1EntityId`	`boolean`	Returns whether it can Send Message.
`ClearResponseTimerRef`	InPartnerId: `FB1EntityId`, InTimerId: `FB1TimeTaskId`	`-`	Clears Response Timer Ref.
`ClearTimeTask`	`-`	`-`	Clears Time Task.
`FindMessage`	InSender: `FB1EntityId`, InReceiver: `FB1EntityId`, InRelationshipData: `FB1RelationshipData`, bSendBySelf: `boolean`, OutIndex: `integer`, OutPoolId: `string`	`boolean`	Finds and returns Message.
`FindSenderAndMessage`	OutIndex: `integer`, OutPoolId: `string`	`FB1EntityId`	Finds and returns Sender And Message.
`ForceSendMessageBySelf`	InReceiverId: `FB1EntityId`, InPoolId: `string`	`-`
`GetCityMovePolicyMap`	InCityMoveDataPolicyType: `EB1CityMoveDataPolicyType`	`table<string, EB1CityMoveDataPolicy>`	Returns City Move Policy Map.
`GetContactMap`	`-`	`FB1MobileContactMap`	Returns Contact Map.
`GetCustomMobileMessagePoolCooltime`	InCustomMobileMessagePoolId: `string`	`integer`	Returns Custom Mobile Message Pool Cooltime.
`GetDefaultCityMoveDataPolicy`	`-`	`EB1CityMoveDataPolicy`	Returns Default City Move Data Policy.
`GetMessageCooltime`	`-`	`FB1MobileMessageCooltimeMap`	Returns Message Cooltime.
`GetMessageList`	`-`	`FB1MobileMessageListMap`	Returns Message List.
`GetMessageListBySystem`	`-`	`FB1MobileMessageListBySystemMap`	Returns Message List By System.
`GetNewMessageCount`	`-`	`integer`	Returns New Message Count.
`HandleAppointment`	InPartner: `FB1EntityId`, InAppointmentData: `FB1AppointmentData`	`-`
`HandleCustomPolicyCityMoveData`	InCityMovedData: `nil`, InCityMoveDataPolicyType: `EB1CityMoveDataPolicyType`	`-`
`HandleWaitMessage`	InDeltaTime: `number`	`-`
`HasContact`	InTargetId: `FB1EntityId`	`boolean`	Returns whether it has Contact.
`HasContactOrMessageHistory`	InTargetId: `FB1EntityId`	`boolean`	Returns whether it has Contact Or Message History.
`IgnoreLastReceivedMessage`	InSenderId: `FB1EntityId`, bSkipUpdateDataCache: `boolean`	`-`
`IsBlockingContact`	InTargetId: `FB1EntityId`	`boolean`	Returns whether Blocking Contact.
`IsWaitingReply`	InEntityId: `FB1EntityId`	`boolean`	Returns whether Waiting Reply.
`OnChangeGrowthStep`	InPrevGrowthStep: `EB1GrowthStep`, InCurrGrowthStep: `EB1GrowthStep`	`-`	Callback invoked on Change Growth Step.
`OnDayOfWeekChanged`	Before: `FDateTime`, After: `FDateTime`	`-`	Callback invoked on Day Of Week Changed.
`OnMessageIgnored`	InIgnoringEntityId: `FB1EntityId`	`-`	Callback invoked on Message Ignored.
`OnMessageReceived`	InSender: `FB1EntityId`, InSenderSystem: `string`, InReceiver: `FB1EntityId`, InMessage: `FB1MobileMessage`	`-`	Callback invoked on Message Received.
`OnMinuteChanged`	Before: `FDateTime`, After: `FDateTime`	`-`	Callback invoked on Minute Changed.
`OnRequestedMessage`	InSender: `FB1EntityId`, InReceiver: `FB1EntityId`, InIndex: `integer`, InPoolId: `string`	`-`	Callback invoked on Requested Message.
`Payload_IgnoreMessage`	InTargetEntityId: `FB1EntityId`	`-`
`Payload_RequestMessage`	InSenderId: `FB1EntityId`, InReceiverId: `FB1EntityId`, InIndex: `integer`, InPoolId: `string`	`-`
`Payload_SendMessage`	InPayloadTarget: `FB1EntityId`, InSenderId: `FB1EntityId`, InReceiverId: `FB1EntityId`, InMessage: `FB1MobileMessage`	`-`
`Payload_SendOverrideTimeline`	InTargetId: `FB1EntityId`, InTimeline: `FB1Timeline`, InDayOfWeek: `EB1DayOfWeek`	`-`
`RemoveContact`	InTargetId: `FB1EntityId`	`boolean`	Removes Contact.
`RemoveTimeTaskId`	InTimeTaskId: `FB1TimeTaskId`	`-`	Removes Time Task Id.
`SendCustomMessageContainsFormatText`	InReceiver: `FB1EntityId`, InCustomMobileMessageId: `string`, InFormatText: `string[]`	`-`	For CustomMobileMessages that include FormatText such as {0}; used only when the System is the sender.
`SendCustomMessagePlainText`	InSender: `FB1EntityId`, InReceiver: `FB1EntityId`, InMessageHandle: `string`, InMobileMessageCustomResponse: `FB1MobileMessageCustomResponse`, InSenderSystemId: `string`, bNeedPhoneNumber: `boolean`	`-`	Sends Custom Message Plain Text.
`SendMessage`	InSender: `FB1EntityId`, InReceiver: `FB1EntityId`, InIndex: `integer`, InPoolId: `string`, bUseAutoResponse: `boolean`	`-`	Sends Message.
`SendMessageBySelf`	InReceiver: `FB1EntityId`, InIndex: `integer`, InPoolId: `string`, InType: `EB1MobileMessageSendType`, InData: `FB1AppointmentData`	`-`	Sends Message By Self.
`SendMessageResponse`	InSender: `FB1EntityId`, InReceiver: `FB1EntityId`, InReceiverSystemId: `string`, InType: `EB1MobileMessageResponseType`	`-`	Sends Message Response.
`SendMessageResponseByTimer`	InSender: `FB1EntityId`, InReceiver: `FB1EntityId`	`-`	Sends a message proactively (sender-initiated).
`SendMessageResponseInternal`	InSender: `FB1EntityId`, InReceiver: `FB1EntityId`, InReceiverSystemId: `string`, InType: `EB1MobileMessageResponseType`	`-`	Sends Message Response Internal.
`SendMessageResponseInternal_Custom`	InSender: `FB1EntityId`, InReceiver: `FB1EntityId`, InReceiverSystemId: `string`, InType: `EB1MobileMessageResponseType`	`-`	Sends Message Response Internal_Custom.
`SendMessageResponseInternal_InvitationExpired`	InSender: `FB1EntityId`, InReceiver: `FB1EntityId`, InReceiverSystemId: `string`	`-`	Sends Message Response Internal_Invitation Expired.
`SendMessageResponseInternal_Pool`	InSender: `FB1EntityId`, InReceiver: `FB1EntityId`, InReceiverSystemId: `string`, InType: `EB1MobileMessageResponseType`, InMessagePoolId: `string`	`-`	Sends Message Response Internal_Pool.
`SendMessageResponseInternal_SendPool`	InSender: `FB1EntityId`, InReceiver: `FB1EntityId`, InMessagePoolId: `string`, InType: `EB1MobileMessageResponseType`	`-`	Sends Message Response Internal_Send Pool.
`SendMessageResponseReply`	InReplyData: `FB1ResponseReplyRequest`	`-`	Self-Written Message
`SendMessageResponseReplyInternal`	InReplyData: `FB1ResponseReplyRequest`	`-`	Sends Message Response Reply Internal.
`SendMessageResponseReplyInternal_Custom`	InReplyData: `FB1ResponseReplyRequest`	`-`	Sends Message Response Reply Internal_Custom.
`SendMessageResponseReplyInternal_InvitationExpired`	InReplyData: `FB1ResponseReplyRequest`	`-`	Sends Message Response Reply Internal_Invitation Expired.
`SendMessageResponseReplyInternal_Pool`	InReplyData: `FB1ResponseReplyRequest`, InMessagePoolId: `string`	`-`	Sends Message Response Reply Internal_Pool.
`SendMessageResponseReplyInternal_SendPool`	InReplyData: `FB1ResponseReplyRequest`, InMessagePoolId: `string`, InAnswerIndex: `integer`	`-`	Sends Message Response Reply Internal_Send Pool.
`SendResponseTimeoutMessage`	InSender: `FB1EntityId`, InReceiver: `FB1EntityId`, InTimeoutMessageId: `string`	`-`	Sends Response Timeout Message.
`Send_S_OnWaitingMessageRevealed`	InMessageOwner: `FB1EntityId`, InPartner: `FB1EntityId`, InSenderSystem: `string`, bIsWait: `boolean`	`-`
`SetCheatResponseType`	InType: `EB1MobileMessageResponseType?`	`-`	Sets Cheat Response Type.
`SetContactBlocked`	InTargetId: `FB1EntityId`, bBlock: `boolean`	`boolean`	Sets Contact Blocked.
`ShouldUseScheduler`	`-`	`boolean`	Returns whether it should Use Scheduler.
`TimelineSimulateOnlyTick`	`-`	`-`

Override points (44)

Implement these in Lua as FB2MobileMessageComponent.Override_Name = function(...) end.

Function	Parameters	Returns	Description
`Override_AddContact`	InTargetId: `FB1EntityId`	`boolean`	Adds Contact.
`Override_CanReceiveMobilMessage`	InReceiver: `FB1EntityId`	`boolean`	Returns whether it can Receive Mobil Message.
`Override_CanSendMessage`	InSender: `FB1EntityId`	`boolean`	Returns whether it can Send Message.
`Override_ClearResponseTimerRef`	InPartnerId: `FB1EntityId`, InTimerId: `FB1TimeTaskId`	`-`	Clears Response Timer Ref.
`Override_ClearTimeTask`	`-`	`-`	Clears Time Task.
`Override_ForceSendMessageBySelf`	InReceiverId: `FB1EntityId`, InPoolId: `string`	`-`
`Override_HandleAppointment`	InPartnerId: `FB1EntityId`, InAppointmentData: `FB1AppointmentData`	`-`
`Override_HandleCustomPolicyCityMoveData`	InCityMovedData: `nil`, InCityMoveDataPolicyType: `EB1CityMoveDataPolicyType`	`-`
`Override_HandleWaitMessage`	InDeltaTime: `number`	`-`
`Override_HasContact`	InTargetId: `FB1EntityId`	`boolean`	Returns whether it has Contact.
`Override_HasContactOrMessageHistory`	InTargetId: `FB1EntityId`	`boolean`	Returns whether it has Contact Or Message History.
`Override_IgnoreLastReceivedMessage`	InSenderId: `FB1EntityId`, bSkipUpdateDataCache: `boolean`	`-`
`Override_OnChangeGrowthStep`	InPrevGrowthStep: `EB1GrowthStep`, InCurrGrowthStep: `EB1GrowthStep`	`-`	Callback invoked on Change Growth Step.
`Override_OnDayOfWeekChanged`	Before: `FDateTime`, After: `FDateTime`	`-`	Callback invoked on Day Of Week Changed.
`Override_OnMessageIgnored`	InIgnoringEntityId: `FB1EntityId`	`-`	Callback invoked on Message Ignored.
`Override_OnMessageReceived`	InSender: `FB1EntityId`, InSenderSystem: `string`, InReceiver: `FB1EntityId`, InMessage: `FB1MobileMessage`	`-`	Callback invoked on Message Received.
`Override_OnMinuteChanged`	Before: `FDateTime`, After: `FDateTime`	`-`	Callback invoked on Minute Changed.
`Override_OnRequestedMessage`	InSender: `FB1EntityId`, InReceiver: `FB1EntityId`, InIndex: `integer`, InPoolId: `string`	`-`	Callback invoked on Requested Message.
`Override_Payload_IgnoreMessage`	InIgnoredEntityId: `FB1EntityId`	`-`
`Override_Payload_RequestMessage`	InSenderId: `FB1EntityId`, InReceiverId: `FB1EntityId`, InIndex: `integer`, InPoolId: `string`	`-`
`Override_Payload_SendMessage`	InPayloadTarget: `FB1EntityId`, InSenderId: `FB1EntityId`, InReceiverId: `FB1EntityId`, InMessage: `FB1MobileMessage`	`-`
`Override_Payload_SendOverrideTimeline`	InTargetId: `FB1EntityId`, InTimeline: `FB1Timeline`, InDayOfWeek: `EB1DayOfWeek`	`-`
`Override_RemoveContact`	InTargetId: `FB1EntityId`	`boolean`	Removes Contact.
`Override_RemoveTimeTaskId`	InTimeTaskId: `FB1TimeTaskId`	`-`	Removes Time Task Id.
`Override_SendCustomMessageContainsFormatText`	InReceiver: `FB1EntityId`, InCustomMobileMessageId: `string`, InFormatText: `string[]`	`-`	For CustomMobileMessages that include FormatText such as {0}; used only when the System is the sender.
`Override_SendCustomMessagePlainText`	InSender: `FB1EntityId`, InReceiver: `FB1EntityId`, InMessageHandle: `string`, InMobileMessageCustomResponse: `FB1MobileMessageCustomResponse`, InSenderSystemId: `string`, bNeedPhoneNumber: `boolean`	`-`	Sends Custom Message Plain Text.
`Override_SendMessage`	InSender: `FB1EntityId`, InReceiver: `FB1EntityId`, InIndex: `integer`, InPoolId: `string`, bUseAutoResponse: `boolean`	`-`	Sends Message.
`Override_SendMessageBySelf`	InReceiverId: `FB1EntityId`, InIndex: `integer`, InPoolId: `string`, InType: `EB1MobileMessageSendType`, InAppointmentData: `FB1AppointmentData`	`-`	Sends Message By Self.
`Override_SendMessageResponse`	InSender: `FB1EntityId`, InReceiver: `FB1EntityId`, InReceiverSystemId: `string`, InType: `EB1MobileMessageResponseType`	`-`	Sends Message Response.
`Override_SendMessageResponseByTimer`	InSenderId: `FB1EntityId`, InReceiverId: `FB1EntityId`	`-`	Sends a message proactively (sender-initiated).
`Override_SendMessageResponseInternal`	InSender: `FB1EntityId`, InReceiver: `FB1EntityId`, InReceiverSystemId: `string`, InType: `EB1MobileMessageResponseType`	`-`	Sends Message Response Internal.
`Override_SendMessageResponseInternal_Custom`	InSender: `FB1EntityId`, InReceiver: `FB1EntityId`, InReceiverSystemId: `string`, InType: `EB1MobileMessageResponseType`	`-`	Sends Message Response Internal_Custom.
`Override_SendMessageResponseInternal_InvitationExpired`	InSender: `FB1EntityId`, InReceiver: `FB1EntityId`, InReceiverSystemId: `string`	`-`	Sends Message Response Internal_Invitation Expired.
`Override_SendMessageResponseInternal_Pool`	InSender: `FB1EntityId`, InReceiver: `FB1EntityId`, InReceiverSystemId: `string`, InType: `EB1MobileMessageResponseType`, InMessagePoolId: `string`	`-`	Sends Message Response Internal_Pool.
`Override_SendMessageResponseInternal_SendPool`	InSender: `FB1EntityId`, InReceiver: `FB1EntityId`, InMessagePoolId: `string`, InType: `EB1MobileMessageResponseType`	`-`	Sends Message Response Internal_Send Pool.
`Override_SendMessageResponseReply`	InReplyData: `FB1ResponseReplyRequest`	`-`	Self-Written Message
`Override_SendMessageResponseReplyInternal`	InReplyData: `FB1ResponseReplyRequest`	`-`	Sends Message Response Reply Internal.
`Override_SendMessageResponseReplyInternal_Custom`	InReplyData: `FB1ResponseReplyRequest`	`-`	Sends Message Response Reply Internal_Custom.
`Override_SendMessageResponseReplyInternal_InvitationExpired`	InReplyData: `FB1ResponseReplyRequest`	`-`	Sends Message Response Reply Internal_Invitation Expired.
`Override_SendMessageResponseReplyInternal_Pool`	InReplyData: `FB1ResponseReplyRequest`, InMessagePoolId: `string`	`-`	Sends Message Response Reply Internal_Pool.
`Override_SendMessageResponseReplyInternal_SendPool`	InReplyData: `FB1ResponseReplyRequest`, InMessagePoolId: `string`, InAnswerIndex: `integer`	`-`	Sends Message Response Reply Internal_Send Pool.
`Override_SendResponseTimeoutMessage`	InSender: `FB1EntityId`, InReceiver: `FB1EntityId`, InTimeoutMessageId: `string`	`-`	Sends Response Timeout Message.
`Override_Send_S_OnWaitingMessageRevealed`	InMessageOwner: `FB1EntityId`, InPartner: `FB1EntityId`, InSenderSystem: `string`, bIsWait: `boolean`	`-`
`Override_TimelineSimulateOnlyTick`	`-`	`-`