EditorPlugin Class Reference

Main object for running methods related to editor plugins.

Member Functions
	getAllObjects()
	Returns a table of all objects in the editor.
	getDisplayCenter()
	Get the center of the current display window. [details]
	getDisplayExtents()
	Get the corners of the current editor window. [details]
	getDisplayZoom()
	Gets the current zoom level of the display. [details]
	getGridSize()
	Returns the current Grid Size setting. [details]
	getSelectedObjects()
	Returns a list of all selected objects in the editor. [details]
	setDisplayCenter(pos)
	Center editor window on specified point. [details]
	setDisplayExtents(pt1, pt2)
	Set the display to the specified bounding box. [details]
	setDisplayZoom(zoom)
	Zoom the display to the specified zoom level. [details]
	showMessage(msg, good)
	Display a big message on-screen. [details]

Detailed Description

Main object for running methods related to editor plugins.

The current editor plugin is always available in a global variable called 'plugin'.

Member Function Documentation

getAllObjects()

returns table

Returns a table of all objects in the editor.

Returns

Lua table containing all the objects in the editor.

getDisplayCenter()

returns nothing

Get the center of the current display window.

Returns

A point representing the center of the current editor display window.

getDisplayExtents()

returns nothing

Get the corners of the current editor window.

Returns

Two points representing the corners of the current display window.

getDisplayZoom()

returns nothing

Gets the current zoom level of the display.

Zoom level is a number between MIN_SCALE and MAX_SCALE, which are currently 0.02 and 10 respectively. Zoom levels are not linear; that is, the difference between 1 and 2 is different than between 2 and 3. However, the difference between 1 and 2 is the same as between 2 and 4.

Returns

Number representing the current zone level.

getGridSize()

returns num

Returns the current Grid Size setting.

Returns

The current GridSize setting in the editor.

getSelectedObjects()

returns table

Returns a list of all selected objects in the editor.

The following code sample shows how to visit each object selected in the editor. Here, we nudge every selected item 100 pixels to the right.

local t = plugin:getSelectedObjects()  -- Get every selected object
 
for i, v in ipairs(t) do               -- Iterate over list
   local g = v:getGeom()               -- Get the object's geometry
   g = Geom.translate(g, 100, 0)       -- Add 100 to the x-coords
   v:setGeom(g)                        -- Save the new geometry
end

This result is sorted by the time at which the objects was selected, so 't[1]' will always be the first selected object and 't[#t]' will always be the last.

Returns

Table containing all the objects that are currently selected in the editor, ordered by selection time.

setDisplayCenter(pos)

Arg types: pos: point  |  returns nothing

Center editor window on specified point.

Will move the editor window to be centered on the specified point. Will not change the zoom level.

Parameters

pos	Where the window should be centered.

setDisplayExtents(pt1, pt2)

Arg types: pt1: point, pt2: point  |  returns nothing

Set the display to the specified bounding box.

Sets the display window to the specified bounding box. If the bounding box is a different aspect ratio than the screen, will center the bounding box on the screen. It doesn't matter which points are in which corners, as long as pt1 and pt2 are diagonally opposed on the bounding box.

When setting the bounding box, the display will zoom out a bit to make the fit look less cramped.

The following code will find all selected objects and change the display so they are all visible. It uses the stardust library (included with Bitfighter) to figure out the combined extent of all the selected objects.

local sd = require('stardust')
 
function main()
   local objects = plugin:getSelectedObjects()
   local ext = sd.mergeExtents(objects)
     plugin:setDisplayExtents(point.new(ext.minx, ext.miny), point.new(ext.maxx, ext.maxy))
end   

Parameters

pt1
pt2

setDisplayZoom(zoom)

Arg types: zoom: num  |  returns nothing

Zoom the display to the specified zoom level.

Zooms the display to the specified level. Will not change the center point.
Editor will override specified zoom if it exceeds internal limits, specified by internal constants MIN_SCALE and MAX_SCALE, which are currently 0.02 and 10 respectively. Current starting zoom is 0.5.

Note

Note that the lower zoom values correspond to a wider, more zoomed-out view.

Dividing the zoom by 2 will result in twice the width and height being displayed.

Parameters

zoom	Zoom level to zoom to.

showMessage(msg, good)

Arg types: msg: string, good: bool  |  returns nothing

Display a big message on-screen.

Display a message to the user like the message displayed when saving a file. Please be courteous and give the user some feedback about whether or not your plugin has run successfully.

Note

There is no guarantee that your message will fit on-screen.

Parameters

msg	The text to display.
good	Controls the color of the displayed text as follows: true: green false: red