npScop plugin

npScopCreate

Create a new instance of a Scop object and attach it to a NeoBook rectangle object. The result variable store "True" if everything is OK, or "False" if an error occur. In this case the [LastError] store the error information.

↑↑

npScopDestroy

Destroy a previously Scop object instance and deattach from their NeoBook rectangle. The result variable store "True" if everything is OK, or "False" if an error occur. In this case the [LastError] store the error information.

↑↑

npScopDestroyAll

Destroy all previously Scop objects instances and deattach from their NeoBook rectangles.

↑↑

npScopActive

Active a deactivated Scop object instance. The result variable store "True" if everything is OK, or "False" if an error occur. In this case the [LastError] store the error information.

↑↑

npScopDeactive

Deactive an activated Scop object instance. The result variable store "True" if everything is OK, or "False" if an error occur. In this case the [LastError] store the error information.

↑↑

npScopIsActive

Find if the specified Scop object instance is active or not. The result variable store "True" if the Scop object is active, or "False" if not. The result variable also can store "False" if an error ocurr. In this case the [LastError] store the error information.

↑↑

npScopSetLine

Set or update the properties of a line on an Scop object instance. This action create a new line based on the line name if a line with such name not exists, or update the appropiate line based on the line name if exists. The line unit can be one of this values: "Percent", "Absolute", "Percent" by default.

The result variable store "True" if everything is OK, or "False" if an error occur. In this case the [LastError] store the error information.

↑↑

npScopColors

Set the colors of a Scop object instance. The result variable store "True" if everything is OK, or "False" if an error occur. In this case the [LastError] store the error information. The available Scop colors are listed below:

• BaseLine Scop baseline. 255,0,0 by default.
• Color Scop color. 0,0,0 by default.
• GridColor Scop grid color. 0,128,0 by default

↑↑

npScopOptions

Set the options of a Scop object instance. The result variable store "True" if everything is OK, or "False" if an error occur. In this case the [LastError] store the error information. The available Scop options are listed below:

• BaseLine Base line position. Numeric. 50 by default.
• BaseLineUnit Base line unit. One of this values: "Percent", "Absolute". "Percent" by default.
• DisplayUnits Scop display unit. One of this values: "Pixels", "Logical". "Pixels" by default.
• HorizontalGridSize Scop horizontal grid size in pixels. Numeric. 16 by default.
• Interval Scop update interval in milliseconds. Numeric. 50 by default.
• Maximum Scop maximum value. Numeric. 225 by default -same value that default scop height.
• Minimum Scop minimum value. Numeric. 0 by default.
• TotalTimeSteps Scop total update times. Numeric. 300 by default -same value that default scop width.
• UpdateTimeSteps Scop timer steps when update. Numeric. 2 by default.
• VerticalGridSize Scop vertical grid size in pixels. Numeric. 16 by default.

↑↑

npOnScopUpdate

Set a publication subroutine to be executed when the Scop object instance is updated accordingly with their interval. The rectangle variable store the rectangle in which the update ocurr. The result variable store "True" if everything is OK, or "False" if an error occur. In this case the [LastError] store the error information.

↑↑

npOnScopMouseDown

Set a publication subroutine to be executed when the Scop mouse down event is fired. The rectangle variable store the rectangle in which the mouse down has made. The button variable can contain one the values: mbLeft, mbMiddle or mbRight. The X variable store the mouse X position, and the Y variable the Y mouse position. The result variable store "True" if everything is OK, or "False" if an error occur. In this case the [LastError] store the error information.

↑↑

npOnScopMouseMove

Set a publication subroutine to be executed when the Scop mouse move event is fired. The rectangle variable store the rectangle in which the mouse move has made. The X variable store the mouse X position, and the Y variable the Y mouse position. The result variable store "True" if everything is OK, or "False" if an error occur. In this case the [LastError] store the error information.

↑↑

npOnScopMouseUp

Set a publication subroutine to be executed when the Scop mouse up event is fired. The rectangle variable store the rectangle in which the mouse up has made. The button variable can contain one the values: mbLeft, mbMiddle or mbRight. The X variable store the mouse X position, and the Y variable the Y mouse position. The result variable store "True" if everything is OK, or "False" if an error occur. In this case the [LastError] store the error information.

↑↑

npOnScopMouseWheelUp

Set a publication subroutine to be executed when the Scop mouse wheel up event is fired. The rectangle variable store the rectangle in which the mouse up has made. The button variable can contain one the values: mbLeft, mbMiddle or mbRight. The X variable store the mouse X position, and the Y variable the Y mouse position. The result variable store "True" if everything is OK, or "False" if an error occur. In this case the [LastError] store the error information.

↑↑

npOnScopMouseWheelDown

Set a publication subroutine to be executed when the Scop mouse wheel down event is fired. The rectangle variable store the rectangle in which the mouse up has made. The button variable can contain one the values: mbLeft, mbMiddle or mbRight. The X variable store the mouse X position, and the Y variable the Y mouse position. The result variable store "True" if everything is OK, or "False" if an error occur. In this case the [LastError] store the error information.

↑↑

Action errors subroutine

All the NeoPlugins deal with errors in the same way that NeoBook does: when the plugin found an action error the [LastError] variable store information about the error, so you can take care about this variable when execute an action.

But all the NeoPlugins also incorporate an advanced way to deal with possible action errors. You can define a subroutine named OnNeoPluginActionError in order to be executed when some action error are found and you can use this variables inside:

• [LastError] The last action error message.
• [PluginName] Store the plugin name which cause the error.

Note that this error handling subroutine are shared for all the NeoPlugins, so you no need to specify a subroutine for every plugin you use in your publication because the same subroutine are recognized and automagically used by every NeoPlugin. Below you can view a sample of this subroutine code:

:OnNeoPluginActionError
  AlertBox "NeoPlugin Error" "Error [LastError] in plugin: [PluginName]"
Return

Also note that the use of this NeoPlugins error handling subroutine is completelly optional. You can continue using the [LastError] variable as usual and even use the both methods at the same time.

↑↑