# Unreal Engine

## 概要

Diarkis Unreal Engine Plugin (以下 UE プラグイン)は [Diarkis クライアント SDK](/getting-started/diarkis-client-sdk.md) を Unreal Engine から使用するためのプラグインです。<br>

## Diarkis の基本

Diarkis はサーバとクライアントが連携して動作するシステムです。\
Diarkis を使用すると何ができるか、どのような機能があるかについては [Diarkis の概要](/overview.md) を参照してください。\
UE プラグインは Diarkis クライアントの実装を行うためのプラグインとなっており、クライアント SDK 相当の機能を UE から使用することができます。\
クライアント SDK についての詳細は [Diarkis クライアント SDK](/getting-started/diarkis-client-sdk.md) を参照してください。

## Unreal Engine Plugin パッケージの構成について

UE プラグインパッケージは「Diarkis プラグイン」と「プラグインの機能を使用したサンプルコード」で構成されています。\
\
「Diarkis プラグイン」部分はクライアント SDK の [Diarkis Module](/diarkis-client/diarkis-module.md) 相当の機能を提供しており、このプラグインを通して Diarkis のクライアント側の各機能にアクセスすることができます。「Diarkis プラグイン」はパッケージ内の`Plugins/Diarkis` 以下に配置されています。\
\
「プラグインの機能を使用したサンプルコード」では、プラグイン機能へ UE からアクセスする方法や Blueprint からの呼び出し等の方法をサンプルコードで紹介しています。 UE プラグインパッケージの「Diarkis プラグイン」以外の部分全てが「プラグインの機能を使用したサンプルコード」となっており Diarkis プラグインを利用する形で各種サンプルコードが実装されています。\
\
また、「プラグインの機能を使用したサンプルコード」も２つのレイヤーに分かれており、プラグインの機能を利用してより高度な機能を実装したり UE との連携のための機能を実装した「DiarkisExtension」部分と「DiarkisExtension」を使用してサンプルアプリを実装した「DiarkisPluginSample」部分があります。\
「DiarkisExtension」は `Source\DiarkisExtension` にソースコードが格納されています。\
\
「DiarkisExtension」では様々な機能が実装されていますが、これらはあくまでサンプルコードとなりますので、将来的に互換性が無い仕様変更が発生したり、不具合が存在する可能性があります。 プロジェクトでのご利用を検討される場合はこの点をご留意ください。

## UE プラグインの詳細説明

* [UE プラグインの基礎](/diarkis-client/game-engine-integration/ue/ue-plugin-basics.md)
* [イベント処理について](/diarkis-client/game-engine-integration/ue/tips-for-event-processing.md)
* [各サンプルの紹介](/diarkis-client/samples/unreal-engine/diarkis-plugin-sample.md#sanpuru)
* [Diarkis Extension に含まれる機能一覧](/diarkis-client/samples/unreal-engine/diarkis-plugin-sample.md#nitsuite)


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://help.diarkis.io/diarkis-client/game-engine-integration/ue.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
