Eden Editor Event Handlers – Arma 3

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
mNo edit summary
Line 36: Line 36:
| <!-- Description -->
| <!-- Description -->
| <!-- Arguments -->
| <!-- Arguments -->
[<class>,<from>]
* class: [[Config]] - connection config class
* from: [[Array]] of Eden entities
|-
|-
| <!-- Title -->
| <!-- Title -->
Line 41: Line 44:
| <!-- Description -->
| <!-- Description -->
| <!-- Arguments -->
| <!-- Arguments -->
[<class>,<from>,<to>]
* class: Config - connection config class
* from: Array of 3DEN entities
* to: 3DEN Entity (when connecting was successful) or nil (when connecting was terminated)
This handler is called every time connecting mode ends, even when user cancelled it
|-
|-
| <!-- Title -->
| <!-- Title -->
Line 46: Line 54:
| <!-- Description -->
| <!-- Description -->
| <!-- Arguments -->
| <!-- Arguments -->
''None''
|-
|-
| <!-- Title -->
| <!-- Title -->
Line 51: Line 60:
| <!-- Description -->
| <!-- Description -->
| <!-- Arguments -->
| <!-- Arguments -->
''None''
|-
|-
| <!-- Title -->
| <!-- Title -->
Line 56: Line 66:
| <!-- Description -->
| <!-- Description -->
| <!-- Arguments -->
| <!-- Arguments -->
''None''
|-
|-
| <!-- Title -->
| <!-- Title -->
Line 61: Line 72:
| <!-- Description -->
| <!-- Description -->
| <!-- Arguments -->
| <!-- Arguments -->
[gridType, gridValue]
* gridType: [[String]] - can be "translation", "rotation" or "scaling"
* gridValue: [[Number]]
|-
|-
| <!-- Title -->
| <!-- Title -->
Line 66: Line 80:
| <!-- Description -->
| <!-- Description -->
| <!-- Arguments -->
| <!-- Arguments -->
''None''
|-
|-
| <!-- Title -->
| <!-- Title -->
Line 71: Line 86:
| <!-- Description -->
| <!-- Description -->
| <!-- Arguments -->
| <!-- Arguments -->
''None''
|-
|-
| <!-- Title -->
| <!-- Title -->
==== OnMessage ====
==== OnMessage ====
| <!-- Description -->
| <!-- Description -->
Message IDs:
*0 - Mission saved
*1 - Mission autosaved
*2 - Trying to move a character into full vehicle
*3 - Moved character into enemy vehicle
*4 - Trying to run mission without any player
*5 - Mission exported to SP
*6 - Mission exported to MP
*7 - Attempting to delete a default layer
| <!-- Arguments -->
| <!-- Arguments -->
[messageID]
* messageID: [[Number]]
|-
|-
| <!-- Title -->
| <!-- Title -->
Line 81: Line 108:
| <!-- Description -->
| <!-- Description -->
| <!-- Arguments -->
| <!-- Arguments -->
''None''
|-
|-
| <!-- Title -->
| <!-- Title -->
Line 86: Line 114:
| <!-- Description -->
| <!-- Description -->
| <!-- Arguments -->
| <!-- Arguments -->
''None''
|-
|-
| <!-- Title -->
| <!-- Title -->
Line 91: Line 120:
| <!-- Description -->
| <!-- Description -->
| <!-- Arguments -->
| <!-- Arguments -->
[objects, groups, waypoints, markers]
* objects: Array
* groups: Array
* waypoints: Array
* markers: Array
Each array is in format:
[entity1, id1, entity2, id2, ..., entityN, idN]
* entity: [[Object]], [[Group]], [[Array]] or [[String]]
* ID: [[Number]]
|-
|-
| <!-- Title -->
| <!-- Title -->
Line 96: Line 134:
| <!-- Description -->
| <!-- Description -->
| <!-- Arguments -->
| <!-- Arguments -->
''None''
|-
|-
| <!-- Title -->
| <!-- Title -->
Line 101: Line 140:
| <!-- Description -->
| <!-- Description -->
| <!-- Arguments -->
| <!-- Arguments -->
''None''
|-
|-
| <!-- Title -->
| <!-- Title -->
Line 106: Line 146:
| <!-- Description -->
| <!-- Description -->
| <!-- Arguments -->
| <!-- Arguments -->
''None''
|-
|-
| <!-- Title -->
| <!-- Title -->
Line 111: Line 152:
| <!-- Description -->
| <!-- Description -->
| <!-- Arguments -->
| <!-- Arguments -->
''None''
|-
|-
| <!-- Title -->
| <!-- Title -->
Line 116: Line 158:
| <!-- Description -->
| <!-- Description -->
| <!-- Arguments -->
| <!-- Arguments -->
''None''
|-
|-
| <!-- Title -->
| <!-- Title -->
Line 121: Line 164:
| <!-- Description -->
| <!-- Description -->
| <!-- Arguments -->
| <!-- Arguments -->
''None''
|-
|-
| <!-- Title -->
| <!-- Title -->
Line 126: Line 170:
| <!-- Description -->
| <!-- Description -->
| <!-- Arguments -->
| <!-- Arguments -->
''None''
|-
|-
| <!-- Title -->
| <!-- Title -->
Line 131: Line 176:
| <!-- Description -->
| <!-- Description -->
| <!-- Arguments -->
| <!-- Arguments -->
''None''
|-
|-
| <!-- Title -->
| <!-- Title -->
Line 136: Line 182:
| <!-- Description -->
| <!-- Description -->
| <!-- Arguments -->
| <!-- Arguments -->
''None''
|-
|-
| <!-- Title -->
| <!-- Title -->
Line 141: Line 188:
| <!-- Description -->
| <!-- Description -->
| <!-- Arguments -->
| <!-- Arguments -->
''None''
|-
|-
| <!-- Title -->
| <!-- Title -->
Line 146: Line 194:
| <!-- Description -->
| <!-- Description -->
| <!-- Arguments -->
| <!-- Arguments -->
''None''
|-
|-
| <!-- Title -->
| <!-- Title -->
Line 151: Line 200:
| <!-- Description -->
| <!-- Description -->
| <!-- Arguments -->
| <!-- Arguments -->
''None''
|-
|-
| <!-- Title -->
| <!-- Title -->
Line 156: Line 206:
| <!-- Description -->
| <!-- Description -->
| <!-- Arguments -->
| <!-- Arguments -->
''None''
|-
|-
| <!-- Title -->
| <!-- Title -->
Line 161: Line 212:
| <!-- Description -->
| <!-- Description -->
| <!-- Arguments -->
| <!-- Arguments -->
''None''
|-
|-
| <!-- Title -->
| <!-- Title -->
Line 166: Line 218:
| <!-- Description -->
| <!-- Description -->
| <!-- Arguments -->
| <!-- Arguments -->
''None''
|-
|-
| <!-- Title -->
| <!-- Title -->
Line 171: Line 224:
| <!-- Description -->
| <!-- Description -->
| <!-- Arguments -->
| <!-- Arguments -->
''None''
|-
|-
| <!-- Title -->
| <!-- Title -->
Line 176: Line 230:
| <!-- Description -->
| <!-- Description -->
| <!-- Arguments -->
| <!-- Arguments -->
''None''
|-
|-
| <!-- Title -->
| <!-- Title -->
Line 181: Line 236:
| <!-- Description -->
| <!-- Description -->
| <!-- Arguments -->
| <!-- Arguments -->
''None''
|-
|-
| <!-- Title -->
| <!-- Title -->
Line 186: Line 242:
| <!-- Description -->
| <!-- Description -->
| <!-- Arguments -->
| <!-- Arguments -->
''None''
|-
|-
| <!-- Title -->
| <!-- Title -->
Line 191: Line 248:
| <!-- Description -->
| <!-- Description -->
| <!-- Arguments -->
| <!-- Arguments -->
''None''
|-
|-
| <!-- Title -->
| <!-- Title -->
Line 196: Line 254:
| <!-- Description -->
| <!-- Description -->
| <!-- Arguments -->
| <!-- Arguments -->
''None''
|-
|-
| <!-- Title -->
| <!-- Title -->
Line 201: Line 260:
| <!-- Description -->
| <!-- Description -->
| <!-- Arguments -->
| <!-- Arguments -->
''None''
|-
|-
| <!-- Title -->
| <!-- Title -->
Line 206: Line 266:
| <!-- Description -->
| <!-- Description -->
| <!-- Arguments -->
| <!-- Arguments -->
''None''
|-
|-
| <!-- Title -->
| <!-- Title -->
Line 211: Line 272:
| <!-- Description -->
| <!-- Description -->
| <!-- Arguments -->
| <!-- Arguments -->
''None''
|-
|-
| <!-- Title -->
| <!-- Title -->
Line 216: Line 278:
| <!-- Description -->
| <!-- Description -->
| <!-- Arguments -->
| <!-- Arguments -->
''None''
|-
|-
| <!-- Title -->
| <!-- Title -->
Line 221: Line 284:
| <!-- Description -->
| <!-- Description -->
| <!-- Arguments -->
| <!-- Arguments -->
''None''
|-
|-
| <!-- Title -->
| <!-- Title -->
Line 226: Line 290:
| <!-- Description -->
| <!-- Description -->
| <!-- Arguments -->
| <!-- Arguments -->
''None''
|-
|-
| <!-- Title -->
| <!-- Title -->
Line 231: Line 296:
| <!-- Description -->
| <!-- Description -->
| <!-- Arguments -->
| <!-- Arguments -->
''None''
|-
|-
| <!-- Title -->
| <!-- Title -->
Line 236: Line 302:
| <!-- Description -->
| <!-- Description -->
| <!-- Arguments -->
| <!-- Arguments -->
''None''
|-
|-
| <!-- Title -->
| <!-- Title -->
Line 241: Line 308:
| <!-- Description -->
| <!-- Description -->
| <!-- Arguments -->
| <!-- Arguments -->
''None''
|}
|}


[[Category: Eden Editor]]
[[Category: Eden Editor]]
[[Category: Arma 3: Editing]]
[[Category: Arma 3: Editing]]

Revision as of 14:30, 2 November 2015

Eden Editor event handlers. When added, they will remain until Eden Editor is closed. Playing preview will not erase them.

Scripting

Commands:

Example:

add3DENEventHandler ["onUndo",{hint "Undo";}]

Config

Alternatively, you can define event handlers directly in the config. Use your custom section (mySection in the example) to prevent overriding handlers from other sources. Handlers defined here will be added automatically when Eden Editor is opened.

class Cfg3DEN
{
	class EventHandlers
	{
		class mySection
		{
			onUndo = "hint 'Undo';";
			// <handlerName> = <handlerExpression>
		};
	};
};

List

Class Description Arguments

OnConnectingStart

[<class>,<from>]
  • class: Config - connection config class
  • from: Array of Eden entities

OnConnectingEnd

[<class>,<from>,<to>]
  • class: Config - connection config class
  • from: Array of 3DEN entities
  • to: 3DEN Entity (when connecting was successful) or nil (when connecting was terminated)

This handler is called every time connecting mode ends, even when user cancelled it

OnCopy

None

OnCut

None

OnDeleteUnits

None

OnGridChange

[gridType, gridValue]
  • gridType: String - can be "translation", "rotation" or "scaling"
  • gridValue: Number

OnMapClosed

None

OnMapOpened

None

OnMessage

Message IDs:

  • 0 - Mission saved
  • 1 - Mission autosaved
  • 2 - Trying to move a character into full vehicle
  • 3 - Moved character into enemy vehicle
  • 4 - Trying to run mission without any player
  • 5 - Mission exported to SP
  • 6 - Mission exported to MP
  • 7 - Attempting to delete a default layer
[messageID]

OnMissionLoad

None

OnMissionNew

None

OnMissionPreview

[objects, groups, waypoints, markers]
  • objects: Array
  • groups: Array
  • waypoints: Array
  • markers: Array

Each array is in format:

[entity1, id1, entity2, id2, ..., entityN, idN]

OnMissionPreviewEnd

None

OnMissionSave

None

OnMissionSaveAs

None

OnModeChange

None

OnMoveGridDecrease

None

OnMoveGridIncrease

None

OnMoveGridToggle

None

OnPaste

None

OnPasteUnitOrig

None

OnRedo

None

OnRotateGridDecrease

None

OnRotateGridIncrease

None

OnRotateGridToggle

None

OnScaleGridToggle

None

OnSearchCreate

None

OnSearchEdit

None

OnServerToggle

None

OnSubmodeChange

None

OnSurfaceSnapToggle

None

OnTerrainNew

None

OnToggleMapIDs

None

OnToggleMapTextures

None

OnUndo

None

OnVerticalToggle

None

OnWidgetNone

None

OnWidgetRotation

None

OnWidgetScale

None

OnWidgetToggle

None

OnWidgetTranslation

None

OnWorkspacePartSwitch

None