Game 2 Editor
57 scripting commands. Also as Markdown for agents.
- addEditorObjectAdd an object to the editor and assign arguments. Create script is,called with _new equal to true. Returns the ID of the new EditorObject.,Subtype…
- addMenuAdds a new menu button. Priority is optional.
- addMenuItemCreates a new menu item. Menu can be "file" or "view",index is index,as returned from addMenu command. priority is optional and determines,where in…
- allow3DModeAllow/dissallow 3D mode.,
- allowFileOperationsAllow/dissallow file ops (load/save etc).
- clearOverlayClear the current overlay.
- closeOverlayCloses the current overlay without committing.
- collapseObjectTreeCollapse the object tree.
- commitOverlayCommit the current overlay.
- createMenuCreates a previously added menu.
- deleteEditorObjectDelete the editor object. Requires all editor object links to be removed prior.
- drawLinkThe editor will draw a line between the two specified editor objects. Line type can be LINE or ARROW.
- editObjectShow the edit object dialog for the given object.
- editorSetEventHandlerSets given event handler of given editor.
- evalObjectArgumentReturn argument in mission editor of a given object.
- execEditorScriptExecute an editor script for the specified object.
- findEditorObjectReturn object that matches the provided reference.
- fromEditorReturn if given team was inserted directly from mission editor.
- getEditorCameraFetches a reference to the mission editor camera.
- getEditorModeReturns the current mode of the editor.
- getEditorObjectScopeReturns the editor object scope of the specified editor object.
- getObjectArgumentReturn name of object argument in mission editor.
- getObjectChildrenReturn a list of all the children of the specified object.
- getObjectProxyReturn the proxy object associated with the given editor object.
- importAllGroupsImports all groups into the RTE.
- insertEditorObjectInsert an object to the editor and assign arguments. Create script is,not called. Returns the ID of the new EditorObject. Subtype class is,optional.
- isRealTimeReturns true if the mission editor is operating in real time mode.
- isShowing3DIconsReturns true if the editor is set to draw 3D icons.
- listObjectsReturn the list of all objects of given type.
- loadOverlayCreates the load overlay dialog for the specified type of overlay.
- lookAtPosPoint the camera and center the map on the position.
- moveObjectToEndShifts an editor object to the end of the objects array. This means,that the object will be drawn last (after all other objects).
- newOverlayCreates the new overlay dialog for the specified type of overlay.
- nextMenuItemIndexReturns the next available menu item index.
- nMenuItemsReturns the total number of user-added menu items belonging to the given menu.
- onDoubleClickDefines an action performed when the user double clicks on the map. Command receives:,_pos array position,_units array selected units,_shift,_alt…
- onShowNewObjectDefines an action performed when the user right clicks on the map and,selects New Object. Set to empty for default behavior. Command receives:,_pos…
- removeDrawIconRemoves an icon for an editor object.
- removeDrawLinksRemove all drawn links for the given editor object for the given editor,object type. Pass an empty string as param type to remove all draw,links for…
- removeMenuItemRemoves a previously added menu item.
- restartEditorCameraRestarts the mission editor camera (if it was deleted by a script,for example).
- saveOverlaySave the current overlay.
- selectedEditorObjectsReturns a list of currently selected editor objects.
- selectEditorObjectSelect an editor object. Does not un-select previously selected objects.
- setDrawIconSet the icon to be shown in 2D editor for the specified editor object. If maintain size is false,icon will not scale depending on the scale,of the…
- setEditorModeSets map mode to MAP,3D or PREVIEW.
- setEditorObjectScopeThis command defines the level of access a user has to editor objects.
- setFromEditorSet if given team member was inserted directly from editor.
- setObjectArgumentsSet object arguments in mission editor.
- setObjectProxySet the proxy object associated with the given editor object.
- setVisibleIfTreeCollapsedSets whether or not the object is visible even if the tree is collapsed.
- show3DIconsToggle the drawing of 3D icons.
- showLegendShow/hide map legend.
- showNewEditorObjectShow the add editor object dialog,type is editor object type,class is,class definition to automatically select,side filters by a certain,side,pos is…
- updateDrawIconUpdates the icon to be shown in 2D editor for the specified editor,object. If maintain size is false,icon will not scale depending on the,scale of…
- updateMenuItemSets the text and command for the menu item. Index is index returned by addMenuItem command. Command is optional.
- updateObjectTreeUpdate the editor object tree.