Unity3d用のネイティブiOSプラグインの作成。 文書化されていない機能

Unity3dには、ネイティブプラグインをアプリケーションに接続する機能があります。 Unity3dの公式Webサイトには、iOSのネイティブコードと対話するためのドキュメントがあります 。 このドキュメントは、自分で作成したプラグインから関数を呼び出す方法と、コールバックを作成する方法の説明に限定されています。 ドキュメントには、説明されている関数が準拠する必要のあるルールと、パラメーターを渡す方法について少し説明されています。 ドキュメントを含む記事の最後に、Bonjourと呼ばれる例をダウンロードできるリンクがあります。



残念ながら、ドキュメントには、ユーザーがプッシュ通知をサブスクライブしたイベントまたはアプリケーションがバックグラウンドに切り替えたイベント（AppDidEnterBackgound）をインターセプトする必要がある場合の対処方法が記載されていませんが、一部のプラグインではこのイベントへのアクセスが必要な場合があります書きたい。



まず、ドキュメントでは、C＃またはjsコードからネイティブに、またはその逆にパラメーターを渡すことができると説明しています。 ただし、これらのルールは明示的に説明されていないため、詳細に説明することは理にかなっています。 以下に示すパラメーターを渡すためのルールは、既存のプラグインFb Unity SDKおよびGoogleAnalyticsを調べるときに取得されました。



ネイティブコードとC＃の間で受け渡しできるパラメーターの種類（およびその逆）：

string = const char* // Unity   char* = string //   Unity bool //(  ) int //(  ) float //(  )
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

ネイティブコードで作業する場合、const char *は、この方法でより便利なiOS NSStringに簡単に変換できます。

 NSString* CreateNSString (const char* string) { if (string) return [NSString stringWithUTF8String: string]; else return [NSString stringWithUTF8String: ""]; }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

ネイティブメソッドから返される文字列値は、UTF – 8でエンコードされ、エンコードされ、ヒープに割り当てられている必要があります。 モノソートの呼び出しは、文字列に対しては無料です。 返されたC行のMonoコンパイラーは.NET文字列を作成し、戻り値に対してfreeを呼び出すため、ヒープでの割り当てが必要です。



問題を回避するために、ヒープに文字列のコピーを作成するメソッドを呼び出すことができます（Bonjourの例から）。

 char* MakeStringCopy (const char* string) { if (string == NULL) return NULL; char* res = (char*)malloc(strlen(string) + 1); strcpy(res, string); return res; }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

アプリケーションまたはそのビューの状態の変更に関連する機能はUnityに記載されていません。Unity3dの公式Fb SDKが統合された情報を受信するためにプロジェクトが構築されました。 このプロジェクトでは、Unity3dバージョン5.1.2f1およびFb Unity SKDバージョン6.2（ ここにあります ）、iOS SDK 8.4を使用しました。 プロジェクトはiOSで構築され、IL2CPPはPlayer SettingsのScripting Backendとして選択されました。



なぜこの情報が必要なのでしょうか？ ネイティブ機能を使用し、アプリケーションの状態の変化（ App Life Cycle-Apple Developer ）、メインViewアプリケーションとレンダラーの状態の変化に関するメッセージをリッスンするネイティブiOSプラグインを開発するには たとえば、ソーシャルネットワークのネイティブプラグインまたはネイティブiOSプラグインをサポートしているさまざまなアナリストのプラグインを統合するためにこの機能が必要になる場合がありますが、Unity3d用のプラグインのバージョンはありません。



この場合、2つの出力があります。

• Xcodeプロジェクトを生成します。 アプリケーションデリゲートのソースコードを見つけて変更し、プラグインを統合します。 このアプローチの欠点は、アプリケーションのバージョンが最終版から遠く離れており、将来変更が行われる場合、Xcodeプロジェクトを再生成し、プラグインを最初から統合する必要があることです。 このアプローチは一度だけ使用しました。 出版社は独自のインストールおよび購入トラッカーを統合することを主張し、プロジェクトはそれぞれUnibillプラグインを使用しました。支払い追跡はこのプラグインによって台無しにされ、Unibillソースのネイティブ部分から出版社から支払い追跡を引き起こすコードを呼び出しました。 このソリューションが使用されたのは、パブリッシャーがネイティブプラグインに基づいてUnityプラグインを作成する時間を与えず、統合自体に30分かかったためです。
• iOSプロジェクトに実装されているネイティブUnity3d機能を使用します。 欠点は、この機能が文書化されていないことです。 ただし、UnityのGoogle AnalyticsおよびFb SKDプラグインで使用されます。

現在のプロジェクトでFB SDKが使用され、十分な時間があったため、Unityが生成するXcodeプロジェクトの内部で何が起こっているのかを把握することが決定されました。



UnityのFBプラグインには、iOSのネイティブコードを含むFbUnityInterface.mmおよび.hにとって最も重要な2つのファイルが含まれています。



コードの次のセクションは、.mmファイルで顕著です。

 -(void)didBecomeActive: (NSNotification *)notification { [FBAppCall handleDidBecomeActiveWithSession:self.session]; } -(void)willTerminate:(NSNotification *)notification { [self.session close]; } -(void)didFinishLaunching:(NSNotification *)notification {
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

FBは、標準のアプリケーションデリゲートメソッドへの呼び出しをインターセプトするようです。 ヘッダーファイルには、次のシンクがあります。

 #if UNITY_VERSION >= 430 #import "AppDelegateListener.h" @interface FbUnityInterface : NSObject <AppDelegateListener>
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

AppDelegateListener.hは、プロジェクトのClasses / PluginBase / Xcodeディレクトリにあります。 デリゲートイベントをインターセプトするために、Unityは4つのプロトコルを記述します。 Objective-Cプロトコルの概念、ドキュメントの 英語版とロシア語版に精通していない人向け。



主なプロトコルはLifeCycleListenerです。 残りの3つのプロトコルのうち2つによって拡張されるのは彼です。 イベントを聞くことができます：

 - (void)didFinishLaunching:(NSNotification*)notification; - (void)didBecomeActive:(NSNotification*)notification; - (void)willResignActive:(NSNotification*)notification; - (void)didEnterBackground:(NSNotification*)notification; - (void)willEnterForeground:(NSNotification*)notification; - (void)willTerminate:(NSNotification*)notification;
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

また、2つのメソッドを宣言します。

 void UnityRegisterLifeCycleListener(id<LifeCycleListener> obj); void UnityUnregisterLifeCycleListener(id<LifeCycleListener> obj);
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

最初のメソッドはオブジェクトに署名してリストされたイベントを受け取り、2番目のメソッドはサブスクライブを解除します。 以下は、AppDelegateListenerプロトコルの外観です。

 @protocol AppDelegateListener<LifeCycleListener>
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

プッシュ通知、ULRアプリケーションのオープンなどに関するメッセージへのアクセスを提供しますAppDelegateListenerを実装するクラスにアクセス可能なすべてのメッセージは、AppDelegateListener.mmで表示できます。



RenderPluginDelegateプロトコルは、Unityレンダリングイベントへのアクセスを提供し、LifeCycleListenerを拡張します。 ソースには適切なコメントが含まれており、すべてのメソッドに関する情報はそこから取得できます。

 @protocol RenderPluginDelegate<LifeCycleListener, NSObject>
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

最後の行はUnityViewControllerLIstenerプロトコルです。 これにより、アプリケーションのメインビューのメインイベントにアクセスできます。 このプロトコルはLifeCycleListenerに依存しません。 イベントリスト：

 - (void)viewDidDisappear: - (void)viewWillDisappear: - (void)viewDidAppear: - (void)viewWillAppear: - (void)interfaceWillChangeOrientation: - (void)interfaceDidChangeOrientation:
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

Fb SDKのソースコードから、これらの機能がUnity 4.3dでのみバージョン4.3以降に登場したことがわかります。

 #if HAS_UNITY_VERSION_DEF #include "UnityTrampolineConfigure.h" #endif #if UNITY_VERSION >= 430 #import "AppDelegateListener.h" @interface FbUnityInterface : NSObject <AppDelegateListener> #else
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

HAS_UNITY_VERSION_DEF定数は、プロジェクトのビルドに使用されたUnity3dのバージョンに関する情報がプロジェクトに含まれているという情報を格納し、RegisterMonoModules.hヘッダーファイルで宣言されています。

 void RegisterMonoModules(); #define HAS_UNITY_VERSION_DEF 1
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

これは、RigisterMonoModules.hのすべてのコンテンツです。 HAS_UNITY_VERSION_DEFがプロジェクトで宣言されている場合、Unity3dバージョン値のUNITY_VERSION定数を参照できます。 したがって、4.3より前のUnity3dバージョンを使用する場合、上記の4つのプロトコルの存在に依存するべきではありません。



一部のネイティブプラグインでは、ネイティブアプリケーションの.plistファイルにキーが存在する必要があります。 実際、plistはxmlと同等であると想定できます。 Fb SDKには、ソースコードFbPlistParserおよびPlistDicが含まれています。これらを使用して、プラグインに必要なキーを追加できます。 たとえば、Xcodeプロジェクトでplistファイルを検索し、値を持つ必要なキーをXcodeプロジェクトで追加するために、 PostProcessBuildAttributeを持つスクリプトをプロジェクトに追加できます。



この情報が有用であり、ネイティブプラグインとの闘いに役立つことを願っています。