Token

This is a global built in package that provides global interfaces to token specific activities.

Only tokens which are placed into token containers are handled by these functions. Imagecontrols are currently the only valid token container objects.


getDistanceBetween [FGU]

1 function getDistanceBetween(token, token)

Returns the distance (in game system units) between two tokens. If the tokens specified are not in the same image value (i.e. map), then zero will be returned.

Parameters

token (tokeninstance)   
tokeninstance object on the current image control.

Return values

(number)
The distance between the two specified tokens in game system units

getToken

1 function getToken(containernodename, containerid)

Gets the tokeninstance object referred to by the container node name and ID parameters.

Parameters

containernodename   (string)   
The database path identifier for the container node

containerid   (number)   
The ID of the token within the container node

Return values

(tokeninstance)
tokeninstance object representing the requested token, or nil if the container does not exist or the ID is not valid.

getTokensWithinDistance [FGU]

1 function getTokensWithinDistance(token, distance)

Returns a list of all tokens within the given game system unit distance from the specified token.

Parameters

token (tokeninstance)   
tokeninstance object on the current image control.

Return values

(table)
A table with integer index values containing references to tokeninstance objects contained in the control

onAdd

1 function onAdd(target)

This handler is called when a token is added to a token container.

Parameters

target   (tokeninstance)   
The tokeninstance triggering the event

onClickDown

1 function onClickDown(target, button, image)

This handler is called when a mouse button is pressed down on a token.

Parameters

target   (tokeninstance)   
The tokeninstance triggering the event

button   (number)   
Returns a numerical value indicating the button pressed (1 = left, 2 = middle, 4 = button 4, 5 = button 5). Right button is used for radial menus.

image   (imagecontrol)   
The imagecontrol object in which the token was clicked.

onClickRelease

1 function onClickRelease(target, button, image)

This handler is called when a mouse button is released on a token.

Parameters

target   (tokeninstance)   
The tokeninstance triggering the event

button   (number)   
Returns a numerical value indicating the button released (1 = left, 2 = middle, 4 = button 4, 5 = button 5). Right button is used for radial menus.

image   (imagecontrol)   
The imagecontrol object in which the token was clicked.

onContainerChanged

1 function onContainerChanged(target, oldcontainernode, oldcontainerid)

This handler is called after a token is dragged from one container to another.

Parameters

target   (tokeninstance)   
The tokeninstance triggering the event

oldcontainernode   (databasenode)   
databasenode object representing the underlying database node of the old container, or nil if the no previous container found.

oldcontainerid   (number)   
The old ID of the token within the old container.

onDelete

1 function onDelete(target)

This handler is called just before a token is deleted.

Parameters

target   (tokeninstance)   
The tokeninstance triggering the event

onDoubleClick

1 function onDoubleClick(target, image)

This handler is called when the left mouse button is double-clicked on a token.

Parameters

target   (tokeninstance)   
The tokeninstance triggering the event

image   (imagecontrol)   
The imagecontrol object in which the token was clicked.

onDrag

1 function onDrag(target, button, x, y, dragdata)

This function is called when the mouse is moved after having been pressed down on the token. The event is called repeatedly as the user adjusts the mouse position.

Parameters

target   (tokeninstance)   
The tokeninstance triggering the event

button   (number)   
1 if the event was caused by the left mouse button, 2 if it was caused by the middle (wheel) button.

x   (number)   
The X coordinate relative to the top left corner of the token

y   (number)   
The Y coordinate relative to the top left corner of the token

dragdata   (dragdata)   
dragdata object containing the state of values connected to the mouse cursor as part of a drag and drop operation.

Return values

(boolean)
This function should return true if it handled the event and the processing of the event should be stopped. A value of false indicates that the default framework functionality for the this particular control should not be executed, but the processing should continue for the element below this control, if any. A return value of nil (or the absence of a return statement) indicates that the framework should continue handling the event normally.

onDragEnd

1 function onDragEnd(target, dragdata)

This function is called when the mouse is released at the end of a drag operation that started on the token. The dragdata object is first passed to the Token handler in the receiving control, which can set properties in the dragdata object that notify this control of the events.

Parameters

target   (tokeninstance)   
The tokeninstance triggering the event

dragdata   (dragdata)   
dragdata object containing the state of values connected to the mouse cursor as part of a drag and drop operation.

onDragStart

1 function onDragStart(target, button, x, y, dragdata)

This function is called when the mouse is moved after having been pressed down on the token. The event is called once.

If a customized drag and drop transfer is done, the dragdata parameter should be used to make the required changes.

Parameters

target   (tokeninstance)   
The tokeninstance triggering the event

button   (number)   
1 if the event was caused by the left mouse button, 2 if it was caused by the middle (wheel) button.

x   (number)   
The X coordinate relative to the top left corner of the token

y   (number)   
The Y coordinate relative to the top left corner of the token

dragdata   (dragdata)   
dragdata object containing the state of values connected to the mouse cursor as part of a drag and drop operation.

Return values

(boolean)
This function should return true if it handled the event and the processing of the event should be stopped. A value of false indicates that the default framework functionality for the this particular control should not be executed, but the processing should continue for the element below this control, if any. A return value of nil (or the absence of a return statement) indicates that the framework should continue handling the event normally.

onDrop

1 function onDrop(target, dragdata)

This handler is called when a drag and drop operation finishes on a token. The dragdata parameter should be used to access the dragged information.

To transfer information back to the object where the drag originated, the same dragdata object is passed to the onDragEnd function in that object.

Parameters

target   (tokeninstance)   
The tokeninstance triggering the eventdragdata   (dragdata)   
dragdata object containing the state of values connected to the mouse cursor as part of a drag and drop operation.

onHover

1 function onHover(target, state)

This handler is called when the hover state of a token changes.

Parameters

target   (tokeninstance)   
The tokeninstance triggering the event

state   (boolean)   
true if the mouse is entering the area, false if leaving

onHoverUpdate

1 function onHoverUpdate(target, x, y)

This handler is called when the mouse cursor is moved while over a token.

Parameters

target   (tokeninstance)   
The tokeninstance triggering the event

x   (number)   
The X coordinate of the mouse pointer in pixels relative to the top left corner of the token

y   (number)   
The Y coordinate of the mouse pointer in pixels relative to the top left corner of the token

onScaleChanged

1 function onScaleChanged(target)

This handler is called after a token's individual scale is changed.

Parameters

target   (tokeninstance)   
The tokeninstance triggering the event

onTargetUpdate

1 function onTargetUpdate(source, target, targeted)

This handler is called when the targeting information for a token is changed.

Parameters

source   (tokeninstance)   
The tokeninstance that is the targeting source.

target   (tokeninstance)   
The tokeninstance that is the targeting target.

targeted   (boolean)   
Whether the target token is currently targeted by the source token.

onWheel

1 function onWheel(target, notches)

This handler is called when the mouse wheel is spun over a token.

Parameters

target   (tokeninstance)   
The tokeninstance triggering the event

notches   (number)   
This number specifies the number of notches the wheel was spun. Typically one notch corresponds to one adjustment step on the wheel.