【UE×Python】アクティブなエディタレベルを取得する方法について徹底解説

Python

「unreal」(Unreal Engine Python API)は、Unreal EngineのPythonライブラリです。このAPIを使用することで、Unreal Engineをより簡単にカスタマイズすることができます。Pythonは、様々なプログラミング言語で使用される汎用的なスクリプト言語であり、「unreal」はPythonを使用して構築されています。本記事では、「unreal」を用いたアクティブなエディタレベルを取得する方法を紹介します。

# get_editor_world関数によるアクティブなエディタレベルの取得
unreal.UnrealEditorSubsystem().get_editor_world()

下記の様な内容で悩んでいる/困っている場合に使える方法を参考までにご共有させて頂きます。

・Unreal Engine上で、どの様にPythonを使うの?
・Unreal Engine上のPythonで、どの様にアクティブなエディタレベルを取得するの?

また、「unreal」を使用する上で基礎的な情報は下記の記事で紹介しております。
他の「unreal」のクラスや関数について気になる方はこちらの記事をご覧ください。

get_editor_world関数によるアクティブなエディタレベルの取得

unreal.UnrealEditorSubsystem().get_editor_world関数の基本構文

unreal.EditorActorSubsystem().get_editor_world() 
→ World

unreal.UnrealEditorSubsystem().get_editor_world関数の使い方

import unreal

activeEditorWorld = unreal.UnrealEditorSubsystem().get_editor_world()

### Attribute of "activeEditorWorld"
for attribute in dir(activeEditorWorld): print(attribute)

### Help of "activeEditorWorld"
help(activeEditorWorld)

### Information of "activeEditorWorld"
print(activeEditorWorld.get_class())
print(activeEditorWorld.get_fname())
print(activeEditorWorld.get_path_name())
LogPython: __class__
LogPython: __delattr__
LogPython: __dir__
...
LogPython: set_editor_properties
LogPython: set_editor_property
LogPython: static_class
LogPython: Help on World object:
class World(Object)
 |  The World is the top level object representing a map or a sandbox in which Actors and Components will exist and be rendered.
...
 |  Static methods inherited from _ObjectBase:
 |  
 |  __new__(*args, **kwargs) from builtins.type
 |      Create and return a new object.  See help(type) for accurate signature.
LogPython: <Object '/Script/Engine.World' (0x00000590DCDB4800) Class 'Class'>
LogPython: LV_Basic
LogPython: /Game/LV_Basic.LV_Basic

メモ

エディタレベル(編集時のレベル):
unreal.UnrealEditorSubsystem().get_editor_world()
ゲームレベル(プレイ時のレベル):
unreal.UnrealEditorSubsystem().get_game_world()

まとめ

「unreal」(Unreal Engine Python API)は、Pythonを使ったUnreal Engineの開発に非常に役立ちます。この記事では、アクティブなエディタレベルを取得する方法を紹介しました。ぜひ活用してみてください。

関連検索ワード

How to get active editor level in editor mode?

関連キーワード

unreal, python, get, editor, level, レベル, 取得