Control
Control
Get Control values
GET /api/control
Get Control values of currently loaded elements in the level
Request Body
{
"SomeLayerId": null,
"SomeTextId":
{
"text": "Text"
}
}
| Parameter | Type | Description |
|---|---|---|
| Control Layer | String | Control Layers |
| Text | String | The name of the property/properties to be controlled |
Set Properties (Exposed Properties)
POST /api/control?preview=false&trigger=true
| Optional Query Parameter | Type | Description |
|---|---|---|
| preview | boolean | whether to "preview" or "not preview" the engine |
| trigger | boolean | whether to "trigger" or "not trigger" the engine |
This API set the Properties of any any control plugin. It works for properties exposed with ControlProperties or properties of Object with ControlBlueprint.
Request Body
{
"LayerId": {
"01": {
"text": "hello"
}
"02": {
"MyVar": 12
}
}
}
Response
None
Model
GET /api/control/model
List of controls with properties that can be controlled as well as their metadatas
Request Body
{
"id": "SomeLayerId",
"title": "SomeControlLayer",
"path": "/Game/test/UEDPIE_0_NewMap.NewMap:PersistentLevel.StaticMeshActor_1.PlaneLayer",
"group": "None",
"type": "Layer",
"actor": "Plane",
"fields": [
{
"id": "SomeTextureId",
"title": "SomeControlTexture",
"type": "Image",
"path": "/Game/test/UEDPIE_0_NewMap.NewMap:PersistentLevel.StaticMeshActor_1.PlaneTexture",
"controller": "Texture",
"value": null,
"actor": "Plane",
"meta":
{
}
}
]
},
{
"id": "SomeTextId",
"title": "Text3DControlText",
"type": "Text",
"path": "/Game/test/UEDPIE_0_NewMap.NewMap:PersistentLevel.Text3DActor_1.ControlText",
"controller": "Text",
"value":
{
"text": "Text"
},
"actor": "Text3DActor",
"meta":
{
"upperCase": false,
"maxCharacters": -1,
"singleLine": true,
"kerning": false,
"lineSpacing": false,
"alignment": false
}
}
| Parameter | Type | Description |
|---|---|---|
| id | String | The ID of the Control/Control Layer |
| title | String | The title/name of the Control/Control Layer |
| type | String | The Type of the Control/Control Layer |
| path | String | Path/location of the Control/Control Layer |
| controller | String | The Type of the Control/Control Layer |
| value | String | The Values of the Control/Control Layer |
| actor | String | The Actor of the Control/Control Layer |
| meta | String | The Meta of the Control/Control Layer |
Payload
GET /api/control/payload
List of Payload returned by the API. Payload is the combination of Get Control Values and Models
Request Body
{
"id": "SomeLayerId",
"title": "SomeControlLayer",
"path": "/Game/test/UEDPIE_0_NewMap.NewMap:PersistentLevel.StaticMeshActor_1.PlaneLayer",
"group": "None",
"type": "Layer",
"actor": "Plane",
"fields": [
{
"id": "SomeTextureId",
"title": "SomeControlTexture",
"type": "Image",
"path": "/Game/test/UEDPIE_0_NewMap.NewMap:PersistentLevel.StaticMeshActor_1.PlaneTexture",
"controller": "Texture",
"value": null,
"actor": "Plane",
"meta":
{
}
}
]
},
{
"id": "SomeTextId",
"title": "Text3DControlText",
"type": "Text",
"path": "/Game/test/UEDPIE_0_NewMap.NewMap:PersistentLevel.Text3DActor_1.ControlText",
"controller": "Text",
"value":
{
"text": "Text"
},
"actor": "Text3DActor",
"meta":
{
"upperCase": false,
"maxCharacters": -1,
"singleLine": true,
"kerning": false,
"lineSpacing": false,
"alignment": false
}
}
| Parameter | Type | Description |
|---|---|---|
| id | String | The ID of the Control/Control Layer |
| title | String | The title/name of the Control/Control Layer |
| type | String | The Type of the Control/Control Layer |
| path | String | Path/location of the Control/Control Layer |
| controller | String | The Type of the Control/Control Layer |
| value | String | The Type of the Control/Control Layer |
| actor | String | The Type of the Control Layer |
| meta | String | The Type of the Control/Control Layer |
Objects
Scene
GET /api/control/scene
List of Actors and Folders
Request Body
[
{
"type": "AWorldSettings",
"path": "/Temp/UEDPIE_0_Untitled_2.Untitled:PersistentLevel.WorldSettings",
"label": "WorldSettings",
"attached": []
}
]
| Parameter | Type | Description |
|---|---|---|
| type | String | The type of actor |
| path | String | Path/location of the actor |
| label | String | The label of the actor |
| attached | Array[Actors] | Array of attached actors |
List Components of Actor
POST /api/control/actor/components
List the components of actors
Request Body
{
"path": "/Temp/UEDPIE_0_Untitled_1.Untitled_1:PersistentLevel.Landscape_UAID_A85E45CFE404FBD100_1221515703"
}
| Parameter | Type | Description |
|---|---|---|
| path | String | Path/location of the actor |
Response
[
{
"name": "RootComponent0",
"path": "/Temp/UEDPIE_0_Untitled_1.Untitled_1:PersistentLevel.Landscape_UAID_A85E45CFE404FBD100_1221515703.RootComponent0",
"attached": []
}
]
| Parameter | Type | Description |
|---|---|---|
| name | String | The name of actor |
| path | String | Path/location of the actor |
| attached | Array[Actors] | Array of attached actors |
Get Value and Meta
POST /api/control/object/get
Get values and meta of object properties
Request Body
{
"path": "/Game/Levels/UEDPIE_0_ErizosTraining.ErizosTraining:PersistentLevel.BP_ControlBP_C_1.ControlText"
}
Response
{
"value": {
"MaxCharacters": -1,
"UpperCase": false,
"SingleLine": true,
"bExposeKerning": false,
"bExposeLineSpacing": false,
"bExposeAlignment": false,
"ControlID": "controlText",
"Title": "Control Text",
"Layer": "ControlLayer",
"ComponentTags": [],
"AssetUserData": [],
"bAutoActivate": false,
"bCanEverAffectNavigation": false,
"bIsEditorOnly": false
},
"meta": {
"fields": [
{
"id": "MaxCharacters",
"type": "Integer",
"meta": {
"default": -1,
"minimum": -1,
"category": "Control"
}
},
{
"id": "UpperCase",
"type": "Boolean",
"meta": {
"default": false,
"category": "Control"
}
},
{
"id": "SingleLine",
"type": "Boolean",
"meta": {
"default": true,
"category": "Control"
}
},
{
"id": "bExposeKerning",
"type": "Boolean",
"meta": {
"default": false,
"category": "Control"
}
},
{
"id": "bExposeLineSpacing",
"type": "Boolean",
"meta": {
"default": false,
"category": "Control"
}
},
{
"id": "bExposeAlignment",
"type": "Boolean",
"meta": {
"default": false,
"category": "Control"
}
},
{
"id": "ControlID",
"type": "String",
"meta": {
"default": "None",
"category": "Control"
}
},
{
"id": "Title",
"type": "String",
"meta": {
"default": "",
"category": "Control"
}
},
{
"id": "Layer",
"type": "String",
"meta": {
"default": "None",
"category": "Control"
}
},
{
"id": "ComponentTags",
"type": "Array",
"meta": {
"inner": {
"id": "ComponentTags",
"type": "String",
"meta": {
"default": "None",
"category": ""
}
},
"default": [],
"category": "Tags"
}
},
{
"id": "AssetUserData",
"type": "Array",
"meta": {
"inner": {
"id": "AssetUserData",
"type": "String",
"meta": {
"assetType": "AssetUserData",
"default": "",
"category": "AssetUserData"
}
},
"default": [],
"category": "AssetUserData"
}
},
{
"id": "bAutoActivate",
"type": "Boolean",
"meta": {
"default": false,
"category": "Activation"
}
},
{
"id": "bCanEverAffectNavigation",
"type": "Boolean",
"meta": {
"default": false,
"category": "Collision"
}
},
{
"id": "bIsEditorOnly",
"type": "Boolean",
"meta": {
"default": false,
"category": "Cooking"
}
}
]
}
}
Set Values of Objects
POST /api/control/object/set
Set properties of object, it returns the same as /api/control/object/get, with the new updated values.
Request Body
{
"path": "/Game/Levels/UEDPIE_0_ErizosTraining.ErizosTraining:PersistentLevel.BP_ControlBP_C_1.ControlText",
"properties":
{
"UpperCase": true
}
}
Response
{
"value": {
"MaxCharacters": -1,
"UpperCase": true,
"SingleLine": true,
"bExposeKerning": false,
"bExposeLineSpacing": false,
"bExposeAlignment": false,
"ControlID": "controlText",
"Title": "Control Text",
"Layer": "ControlLayer",
"ComponentTags": [],
"AssetUserData": [],
"bAutoActivate": false,
"bCanEverAffectNavigation": false,
"bIsEditorOnly": false
},
"meta": {
"fields": [
{
"id": "MaxCharacters",
"type": "Integer",
"meta": {
"default": -1,
"minimum": -1,
"category": "Control"
}
},
{
"id": "UpperCase",
"type": "Boolean",
"meta": {
"default": false,
"category": "Control"
}
},
{
"id": "SingleLine",
"type": "Boolean",
"meta": {
"default": true,
"category": "Control"
}
},
{
"id": "bExposeKerning",
"type": "Boolean",
"meta": {
"default": false,
"category": "Control"
}
},
{
"id": "bExposeLineSpacing",
"type": "Boolean",
"meta": {
"default": false,
"category": "Control"
}
},
{
"id": "bExposeAlignment",
"type": "Boolean",
"meta": {
"default": false,
"category": "Control"
}
},
{
"id": "ControlID",
"type": "String",
"meta": {
"default": "None",
"category": "Control"
}
},
{
"id": "Title",
"type": "String",
"meta": {
"default": "",
"category": "Control"
}
},
{
"id": "Layer",
"type": "String",
"meta": {
"default": "None",
"category": "Control"
}
},
{
"id": "ComponentTags",
"type": "Array",
"meta": {
"inner": {
"id": "ComponentTags",
"type": "String",
"meta": {
"default": "None",
"category": ""
}
},
"default": [],
"category": "Tags"
}
},
{
"id": "AssetUserData",
"type": "Array",
"meta": {
"inner": {
"id": "AssetUserData",
"type": "String",
"meta": {
"assetType": "AssetUserData",
"default": "",
"category": "AssetUserData"
}
},
"default": [],
"category": "AssetUserData"
}
},
{
"id": "bAutoActivate",
"type": "Boolean",
"meta": {
"default": false,
"category": "Activation"
}
},
{
"id": "bCanEverAffectNavigation",
"type": "Boolean",
"meta": {
"default": false,
"category": "Collision"
}
},
{
"id": "bIsEditorOnly",
"type": "Boolean",
"meta": {
"default": false,
"category": "Cooking"
}
}
]
}
}