Topics
	Editor Components

Classes
class	SCR_SiteSlotEntity
class	SCR_EditorBaseEntity
class	SCR_EditorImageGeneratorEntity
class	SCR_EditorModeEntity
class	SCR_EditorPingEntity
class	SCR_EditorSettingsEntity

Enumerations
enum	EEditableEntityInteraction { NONE , LAYER , SLOT , PASSENGER }
	Type of suggested interaction when hovering edited entity on top of another entity. More...
enum	EEditableEntityInteractionFlag { ALIVE = 1 << 0 , DELEGATE = 1 << 1 , LAYER_EDITING = 1 << 2 , NON_PLAYABLE = 1 << 3 , PLACING = 1 << 4 }
	Details of entity interaction. More...
enum	EEditorCanClose { SCRIPT = 1 }
	Layers allowing editor to be closed. All of them have to be activated. More...
enum	EEditorCanOpen { SCRIPT = 1 , ALIVE = 2 , MODES = 4 }
	Layers allowing editor to be opened. All of them have to be activated (certain exceptions may apply when the editor is in unlimited mode). More...
enum	EEditorCommandActionFlags { WAYPOINT = 1 , OBJECTIVE = 2 , IS_QUEUE = 4 , ATTACH = 8 }
	Simplified action conditions. More...
enum	EEditorEvent { NONE , INIT , REQUEST_OPEN , REQUEST_CLOSE , DELETE , OPEN , OPEN_ALL , PRE_ACTIVATE , DEACTIVATE , DEACTIVATE_ASYNC , ACTIVATE , ACTIVATE_ASYNC , POST_DEACTIVATE , POST_ACTIVATE , CLOSE , UPDATE_MODE , EXIT_OPERATION }
	Editor event processed in components. More...
enum	EEditorEventOperation { NONE , INIT , REQUEST_OPEN , OPEN , REQUEST_CLOSE , CLOSE , MODE_CHANGE , MODE_CREATE , MODE_DELETE , DELETE }
	Type of event-processing operation. More...
enum	EEditorMode { EDIT = 1 , STRATEGY = 1 << 1 , SPECTATE = 1 << 2 , PHOTO = 1 << 3 , ADMIN = 1 << 4 , BUILDING = 1 << 5 , PHOTO_SAVE = 1 << 6 }
	Editor mode that defines overall functionality. More...
enum	EEditorState { NONE , SELECTING , MULTI_SELECTING , PLACING , TRANSFORMING }
	Unique editor state. More...
enum	EEditorTransformSnap { NONE , TERRAIN , GEOMETRY }
	Vertical snapping rules. More...
enum	EEditorTransformVertical { SEA = 1 << 0 , TERRAIN = 1 << 1 , GEOMETRY = 1 << 2 }
	Vertical transformation mode. More...

Functions
SCR_EditorManagerEntityClass SCR_EditorBaseEntityClass	Attribute ("true", UIWidgets.Auto, "Are default modes created automatically?", category:"Editor Manager")] private bool m_bIsAutoModes

Variables
SCR_EditorImagePositionEntityClass	ANIM_TIME_STEP = 30.0

Detailed Description

Editor entities manage functionality of the editor.

Structure

For the editor to function propertly, it must be configured in the following structure. All entities must be saved into a prefabs and linked in attributes mentioned below.

Execution Order

Functions in relevant classes are called in the following order.

Enumeration Type Documentation

◆ EEditableEntityInteraction

enum EEditableEntityInteraction

Type of suggested interaction when hovering edited entity on top of another entity.

Enumerator
NONE	Simple transform.
LAYER	Open layer.
SLOT	Attach to slot.
PASSENGER	Place as passenger of vehicle. Used by context action SCR_ChooseAndSpawnOccupantsContextAction not placing opperation.

Definition at line 5 of file EEditableEntityInteraction.c.

◆ EEditableEntityInteractionFlag

enum EEditableEntityInteractionFlag

Details of entity interaction.

Enumerator
ALIVE	Entity and target are not destroyed, or cannot be destroyed.
DELEGATE	Hovering over delegate, i.e., icon, not mesh.
LAYER_EDITING	Layer editing is enabled.
NON_PLAYABLE	Entity is not a player.
PLACING	Current operation is placing.

Definition at line 5 of file EEditableEntityInteractionFlag.c.

◆ EEditorCanClose

enum EEditorCanClose

Layers allowing editor to be closed. All of them have to be activated.

Enumerator
SCRIPT	Set by script.

Definition at line 5 of file EEditorCanClose.c.

◆ EEditorCanOpen

enum EEditorCanOpen

Layers allowing editor to be opened. All of them have to be activated (certain exceptions may apply when the editor is in unlimited mode).

Enumerator
SCRIPT	Set by script.
ALIVE	When alive.
MODES	At least one editor mode available.

Definition at line 5 of file EEditorCanOpen.c.

◆ EEditorCommandActionFlags

enum EEditorCommandActionFlags

Simplified action conditions.

Enumerator
WAYPOINT	Can place waypoint.
OBJECTIVE	Can place objective.
IS_QUEUE
ATTACH

Definition at line 5 of file EEditorCommandActionFlags.c.

◆ EEditorEvent

enum EEditorEvent

Editor event processed in components.

Enumerator
NONE
INIT
REQUEST_OPEN
REQUEST_CLOSE
DELETE	Further load on the instance is aborted and is deleted immediately.
OPEN
OPEN_ALL
PRE_ACTIVATE
DEACTIVATE
DEACTIVATE_ASYNC
ACTIVATE
ACTIVATE_ASYNC
POST_DEACTIVATE
POST_ACTIVATE
CLOSE
UPDATE_MODE
EXIT_OPERATION

Definition at line 5 of file EEditorEvent.c.

◆ EEditorEventOperation

enum EEditorEventOperation

Type of event-processing operation.

Enumerator
NONE
INIT
REQUEST_OPEN
OPEN
REQUEST_CLOSE
CLOSE
MODE_CHANGE
MODE_CREATE
MODE_DELETE
DELETE

Definition at line 5 of file EEditorEventOperation.c.

◆ EEditorMode

enum EEditorMode

Editor mode that defines overall functionality.

Enumerator
EDIT	Editing and placing entities, configuring attributes.
STRATEGY	Commanding AI and players.
SPECTATE	Observing players.
PHOTO	Photo mode.
ADMIN	Server administration.
BUILDING	Building mode.
PHOTO_SAVE

Definition at line 5 of file EEditorMode.c.

◆ EEditorState

enum EEditorState

Unique editor state.

Enumerator
NONE	No interaction allowed.
SELECTING	Able to select entities.
MULTI_SELECTING	Drawing multi-selection frame.
PLACING	Placing a new entity.
TRANSFORMING	Moving or rotating an entity.

Definition at line 5 of file EEditorState.c.

◆ EEditorTransformSnap

enum EEditorTransformSnap

Vertical snapping rules.

Enumerator
NONE	Don't snap.
TERRAIN	Snap to terrain.
GEOMETRY	Snap to geometry.

Definition at line 5 of file EEditorTransformSnap.c.

◆ EEditorTransformVertical

enum EEditorTransformVertical

Vertical transformation mode.

Enumerator
SEA	Above sea level.
TERRAIN	Above terrain level.
GEOMETRY	Above geometry level.

Definition at line 5 of file EEditorTransformVertical.c.

Function Documentation

◆ Attribute()

SCR_EditorManagerEntityClass SCR_EditorBaseEntityClass Attribute	(	"true"	,
		UIWidgets.	Auto,
		"Are default modes created automatically?"	,
		category:"Editor Manager"	)

The entity which enables all editor functionality for the player.

It's created by SCR_EditorManagerCore when a player connects.
Every player receives one.
In multiplayer, the entity is local to the player.
This is required to allow communication with server (see Replication for more details).
Requires RplComonent to function.
This entity handles only barebone editor functionality, like access rules, or opening and closing.
Everything else, like camera or menu handling, must be on specialized editor modes (SCR_EditorModeEntity) and components (SCR_BaseEditorComponent)!
Editor can have a limitied state, influenced by its modes and checked by IsLimited() function:
Editor is limited if all its modes are.
If at least one mode is unlimited, the editor is unlimited as well.
The state influences behavior of certain components, e.g., photo mode camera movement may be restricted if the editor is limited.
As a rule of thumb, unlimited state means that player can cheat with the editor.
Default editor manager prefab is defined in SCR_EditorManagerCore (config is Configs/Core folder).

Variable Documentation

◆ ANIM_TIME_STEP

SCR_EditorImagePositionEntityClass ANIM_TIME_STEP = 30.0

Topics

Classes

Enumerations

Functions

Variables