Class TMessaging

Unit

CastleMessaging

Declaration

type TMessaging = class(TObject)

Description

Message system to communicate between native code (Pascal) and Java on Android. Use through auto-created Messaging singleton. On other platforms than Android, right now it simply does nothing — messsages are not send anywhere.

To make this work:

• Include the necessary integration code in your Android project. Simply declare your Android project type as "integrated". https://github.com/castle-engine/castle-engine/wiki/Android-Project-Components-Integrated-with-Castle-Game-Engine .

• In your main Android library lpr file, you need to export the JNI function Java_net_sourceforge_castleengine_MainActivity_jniMessage defined in this unit.

  It's simplest to just define the game_units attribute in CastleEngineManifest.xml, and the build tool automatically generate a proper Android library code.

This is used automatically by various engine classes like TGooglePlayGames, TAds, TAnalytics, TInAppPurchases.

Hierarchy

• TObject
• TMessaging

Overview

Methods

	constructor Create;
	destructor Destroy; override;
	procedure Send(const Strings: array of string);
	class function BoolToStr(const Value: boolean): string;
	class function TimeToStr(const Value: TFloatTime): string;

Properties

	property OnReceive: TMessageReceivedEventList read FOnReceive;
	property Log: boolean read FLog write FLog default false;

Description

Methods

	constructor Create;

	destructor Destroy; override;

	procedure Send(const Strings: array of string);
Send a message to our Java integration code.

	class function BoolToStr(const Value: boolean): string;
Convert boolean to 'true' or 'false' string, which will be understood correctly by the Java components receiving the messages.

	class function TimeToStr(const Value: TFloatTime): string;
Convert float time (in seconds) to integer miliseconds, which are understood correctly by the Java components receiving the messages.

Properties

	property OnReceive: TMessageReceivedEventList read FOnReceive;
Callbacks called when new message from Java is received.

	property Log: boolean read FLog write FLog default false;
Log each message send/received from/to Java. Note that this is sometimes quite verbose, and it also allows cheaters to easier debug what happens in your game (e.g. how to fake getting some achievement), so in general don't leave it "on" in production.