Skip to content

Commit 8ef56f3

Browse files
author
rdeioris
authored
Update Plugin_API.md
1 parent 22d63cb commit 8ef56f3

File tree

1 file changed

+32
-0
lines changed

1 file changed

+32
-0
lines changed

docs/Plugin_API.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,3 +18,35 @@ plugins_list = unreal_engine.get_enabled_plugins()
1818
# name is the string name of the plugin (like 'UnrealEnginePython' or 'Paper2D')
1919
plugin = unreal_engine.find_plugin(name)
2020
```
21+
22+
The unreal_engine.IPlugin class represents a plugin
23+
24+
25+
IPlugin methods
26+
-
27+
28+
```py
29+
import unreal_engine
30+
31+
paper2d = ue.find_plugin('Paper2D')
32+
33+
# the name of the plugin
34+
name = paper2d.get_name()
35+
36+
base_dir = paper2d.get_base_dir()
37+
38+
content_dir = paper2d.get_content_dir()
39+
40+
descriptor_file_name = paper2d.get_descriptor_file_name()
41+
42+
mounted_asset_path = paper2d.get_mounted_asset_path()
43+
44+
can_contain_content = paper2d.can_contain_content()
45+
46+
is_enabled = paper2d.is_enabled()
47+
```
48+
49+
Managing the descriptor
50+
-
51+
52+
You can load/write a json string from/to the plugin descriptor

0 commit comments

Comments
 (0)