WowWiki - User contributions [en]

SDK

2021-06-26T06:53:33Z

Oleg.sayakhov: /* Quick start */

SDK/Framework

*[[pawn]]

==WOWCube Emulator installation==

===Windows===
Launch the wowcube-sdk.exe installer and follow the steps of the installer.

Installing Dependencies (for Pawn Application Developers)
To run scripts written in the Pawn language, you need to install Python 3, Pip, IntelHex, and Pillow.

'''Installing Python'''

Go to the site https://www.python.org/downloads/windows/, click on the "Latest Python 3 Release" link, wait for the download to complete.
[[File:Highlight_Latest_Python_3_Release_link.png]]

Run the downloaded Python installer, select the "Add Python to PATH" checkbox (without it, the path to Python will need to be specified in full), and then click "Install Now".
[[File:Python_installation_configuration.png]]

Python 3 will be installed in "%LOCALAPPDATA%\Programs\Python". After installation, it will offer to remove the 260-character limit on the PATH length. Click. We complete the installation. Some Python libraries may not work or work incorrectly due to the standard 260 character limit.
[[File:Python_disable_path_length_limit.png]]

'''Installing libraries'''

To install the dependencies, you need to start the terminal. Go to Start menu (or press Windows key + X) and select Windows PowerShell.

[[File:Start_menu_with_PowerShell.png]]

Type command "pip install intelhex pillow" and press enter.
[[File:Intelhex_and_pillow_installation.png]]

This command will download and install the IntelHex and Pillow dependencies. If the installation is successful, a corresponding message will be displayed.

If your company uses a proxy, then you need to add the --proxy option to the command above. The option has the following format:

[user: password @] proxy.server: port

For example:

''pip install --proxy = http: //proxy.jf.intel.com: 911 intelhex pillow''

===macOS===

Open the .dmg file, drag the WOWCube Emulator application into the Applications folder.
[[File:Installation_on_macOS.png]]

If the .dmg file was downloaded not in the App Store, then an error will pop up when starting the application.
[[File:Error_message_macOS_emulator_installation.png]]

To fix this error, you need to open the Terminal application. It can be opened in a number of ways: with Siri, or through Launchpad, or through the Finder, or by pressing Command + Space bar and pressing the Enter.

[[File:Terminal_window_in_macOS.png]]

In the terminal, write the command ''/ Applications / WOWCube \ Emulator.app/Contents/MacOS/bin/wowcube'' and press enter.

If the following error occurs

''/ usr / bin / env: bad interpreter: Operation not permitted, or zsh: operation not permitted: / Applications / WOWCube Emulator.app/Contents/MacOS/bin/wowcube''

Then run the following command ''xattr -rd com.apple.quarantine / Applications / WOWCube \ Emulator.app/''. It will output errors Permission Denied, but they are expected.

'''Installing Python'''

For macOS version below Catalina open a terminal, install and download Homebrew

''/ bin / bash -c "$ (curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"''

Homebrew is a package manager that lets you install Open Source applications.

Next, install Python 3 and Pip

''brew install python3''

''brew cask install python3''

For macOS by Catalina. First you need to make sure that python is installed and that it is the correct version.

''python3 -V''

This command should print “Python 3.x.x”. If the command did not display anything, or was not found, try to execute

''python -V''

If it displays “Python 2.x.x”, then Python 3 is not installed.

Install pip:

''curl -fsSL https://bootstrap.pypa.io/get-pip.py | python3''

[[File:Check_for_python_and_installing_pip.png]]

'''Installing labraries'''

Install IntelHex and Pillow libraries.

''pip3 install pillow intelhex''

==Starting WOWCube Emulator==

===Windows===

Launch WOWCube Emulator by clicking on shortcut on desktop.

[[File:WOWCube_Emulator_shortcut_windows.png]]

On first launch, a warning from the firewall will appear.

[[File:Windows_security_alert_first_emulator_launch.png]]

Allow access. WOWCube Emulator uses local ports for communication between the processes it creates, as well as for projector mode.

===macOS===

Open terminal and enter ''WOWCube Emulator'' then and press Enter.

==WOWCube Emulator interface==

===General view===

There are 4 main groups of widgets in the WOWCube Emulator interface.

[[File:WOWCube_Emulator_UI.png]]

===Cube model interactions===

Contains links for interacting with the cube module. Buttons from left to right:

* simulates the shaking of a cube
* returns the cube module to its original state (restoring rotations and position)
* open code editor (does not work in version 2.2.0 and below)
* rotates a random side of the cube

===Emulation progress control===

Serves to interact with the progress of the script. Buttons from left to right:

* start emulation of the selected pawn script. Аfter startup is replaced by the emulation restart button
* stops pawn script emulation
* loading a script to a physical cube using the bluetooth protocol (does not work in version 2.2.0 and below)

===General settings===

====Project tab====

In this tab you can choose one of two modes of operation:

* Pawn;
* Projector.

''Projector mode''

The projector is used to transfer images from a computer or mobile device to the WOWCube via the Bluetooth protocol.

The projector in the WOWCube Emulator is used for prototyping and faster development of web-projector applications.

''Pawn Mode''

In this mode, you can:

* select the path to the projects folder
* select a startup project
* view additional data for a running project

====View tab====

The Sound adjusts the overall volume.

[[File:WOWCube_Emulator_view_tab_sound.png]]

In the Emulation, the transparency of the overlay is adjusted. The overlay displays on each module its current number, screen and adjacent modules.

The Limit FPS slider allows you to limit the frame rate in the application running on the emulator.

If necessary, it is possible to configure the simulation of lost packets during transmission.

[[File:WOWCube_Emulator_view_tab_emulation.png]]

In the CubeNet, the transparency and the size of the cube unfolding are configured.

[[File:WOWCube_Emulator_view_tab_CubeNet.png]]

In the Scene, the removal of the camera, the field of view, the backdrop are configured.

ABI calls - displays abi function calls to the console.

Console follows mouse click - if you click on one of the modules of the virtual cube model, it opens the console tab corresponding to the module number.

[[File:WOWCube_Emulator_view_tab_scene.png]]

====Settings Tab====

This is where the PAWN compiler path and python path are selected.

[[File:WOWCube_Emulator_settings_tab.png]]

===Console and logs===

Contains tabs for displaying script assembly logs and tabs with the console of each module separately.

===Controls===

LMB on a cube - rotation of the sides.

RMB (or Ctrl + LMB) on a cube - tilt the cube.

RMB (or Ctrl + LMB) past the cube - rotate the camera.

Mouse wheel - zoom out / zoom in the camera.

==Quick start==

Go to https://github.com/wowcube/WOWCube_apps_examples

Clone or download to the necessary folder.

Launch WOWCube Emulator.

In ''Project'' tab switch Pawn mode.

Specify ''Project path'' to the folder with examples.

[[File:WOWCube_emulator_path_to_examples.png]]

Under ''Run configuration'' choose example project.

[[File:WOWCube_emulator_choose_example.png]]

You can press 'i' button to watch what resources loaded for each script

[[File:WOWCube_emulator_resources_for_scripts.png]]

Press ''Start button'' to launch emulation

[[File:WOWCube_emulator_launched_first_example.png]]

In order to make changes in examples you need:

* Go to folder where your WOWCube examples located
* Open file 'example1.pwn' with any text editor
* make what changes you need

SDK

2021-06-25T16:48:05Z

Oleg.sayakhov: /* Cube model interactions */

API

2020-09-03T17:10:46Z

Oleg.sayakhov:

{{notice|This is a beta version, API changes can be made without warning.}}

=Introduction=

The main functions of the API are listed here, the features of the work of the environment are described

==WOWCube Paradigms==

WOWCube executes 8 copies of the byte-code of the script at the same time, providing functions for the interaction of scripts with each other, drawing functions, functions for accessing resources, and other specific functions. Each copy of the script has access to 3 displays. Resource scripts are packed into a package.

==Pawn API==
===Graphic functions===

====Graphics 2D acceleration (G2D)====
WOWCube provides the 2D acceleration interfaces to enhance gaming experience . Basically G2D engine allows to blend up to the 4 image layers at once with a HW acceleration. However there is no limit of layers, they are blended in a cascade. For example, if Pawn script requested 7 layers to be blended then 2 HW blending will occur:
[[File:Cascade.png|center|G2D cascading scheme]]
Result of the blending can be saved as an internal G2D resource or flushed immediately on the specified display. Internal G2D resources can be used as an usual bitmap primitive ([[API#abi_CMD_BITMAP|abi_CMD_BITMAP]]) or reused as an input for the next G2D action.
Basic coordinate principle:
[[File:G2d_coordinates.png|center|G2D coordinates sceme]]
Coordinates are limited from -2048 to 2047. Maximum layers size is 240x240.

=====abi_CMD_G2D_BEGIN_BITMAP=====
Syntax:
abi_CMD_G2D_BEGIN_BITMAP(const resID, const width, const height, const bool:replace)
Description:
: abi_CMD_G2D_BEGIN_BITMAP and [[API#abi_CMD_G2D_END|abi_CMD_G2D_END]] delimits the group of layers to be blended into internal G2D resource. This API is not intended for frequent usage. It is better suited for complex background generation on game initialization or dynamic resource modification triggered by rare game events.
Arguments:
: ''resID''
:: ID of the resource that will be generated from blending layers presented between abi_CMD_G2D_BEGIN_BITMAP and the subsequent [[API#abi_CMD_G2D_END|abi_CMD_G2D_END]]. G2D engine can keep up to 3 different resources with IDs: 0, 1 and 2.
: ''width''
:: Width of the resulting resource. G2D engine can keep resource of 240px width maximum.
: ''height''
:: Height of the resulting resource. G2D engine can keep resource of 240px height maximum.
: ''replace''
:: If true, then an existing image will be replaced completely, otherwise it will be overwritten by reusing itself as a background layer.

=====abi_CMD_G2D_BEGIN_DISPLAY=====
Syntax:
abi_CMD_G2D_BEGIN_DISPLAY(const display, const bool:replace)
Description:
: abi_CMD_G2D_BEGIN_DISPLAY and [[API#abi_CMD_G2D_END|abi_CMD_G2D_END]] delimits the group of layers to be blended directly into display framebuffer. Obviously this API is designed for rendering scene on game tick. This API is not limited by layers count as well as [[API#abi_CMD_G2D_BEGIN_BITMAP|abi_CMD_G2D_BEGIN_BITMAP]]. However it is strictly recommended to blend no more than 4 layers. Otherwise cascade blending will be initiated resulting in some FPS drop.
Arguments:
: ''display''
:: ID of the display which framebuffer will be used for blending. Each module have 3 displays with ID starting from 0.
: ''replace''
:: If true then an existing image will be replaced completely, otherwise it will be overwritten by reusing itself as a background layer.

=====abi_CMD_G2D_ADD_SPRITE=====
Syntax:
abi_CMD_G2D_ADD_SPRITE(const resID, const bool:g2d, const x, const y, const alpha, const color, const rotation, const mirror)
Description:
: Specifies game resource which will be used as a layer for blending.
Arguments:
: ''resID''
:: ID of the resource to be uses as a layer.
: ''g2d''
:: Indicates if an internal G2D resource is specified or not.
: ''x'', ''y''
:: Coordinates of the bitmap center to place on the layer.
: ''alpha''
:: Layer transparency in range between 0x00 and 0xFF, where 0x00 is a fully transparent layer.
: ''color''
:: Layer's source key - a color in ARGB8888 format to be avoided.
: ''rotation''
:: Clockwise rotation angle in degrees. It is possible to specify free angle, but only right angles have HW acceleration.
: ''mirror''
:: Mirroring variant. Possible values are self-explained: MIRROR_BLANK, MIRROR_X, MIRROR_Y, MIRROR_XY.

=====abi_CMD_G2D_ADD_RECTANGLE=====
Syntax:
abi_CMD_G2D_ADD_RECTANGLE(const x, const y, const width, const height, const color)
Description:
: Specifies rectangle area which will be used as layer of blending. This API is not intended for frequent usage, i.e. particles generation. It is better suited for changing image background or applying color mask.
Arguments:
: ''x'', ''y''
:: Coordinates of top left rectangle corner.
: ''width''
:: Rectangle width.
: ''height''
:: Rectangle height.
: ''color''
:: Rectangle color in ARGB8888 format.

=====abi_CMD_G2D_END=====
Syntax:
abi_CMD_G2D_END()
Description:
: abi_CMD_G2D_END() and [[API#abi_CMD_G2D_BEGIN_BITMAP|abi_CMD_G2D_BEGIN_BITMAP]]/[[API#abi_CMD_G2D_BEGIN_DISPLAY|abi_CMD_G2D_BEGIN_DISPLAY]] delimits the group of layers to be blended. After abi_CMD_G2D_END call final blending will be initiated and results will be stored according to the begin comand.

====Font drawing functions====
=====abi_CMD_TEXT=====
API:
abi_CMD_TEXT(const text[], const fontResID, const x, const y, const scale, const angle, const r, const g, const b)
Description:
: Intended to render a system font or a custom font from resources with specified coordinates, scale and rotation at an arbitrary angle.
Arguments:
: ''text''
:: Array of chars.
: ''fontResID''
:: Custom font resource identifier.
: ''x'', ''y''
:: Coordinates of top left rectangle corner.
: ''scale'', ''angle''
:: Percentage scale and clockwise rotation angle in degrees. Max size of font is 200x200 px. (scale = 100%)
: ''r'', ''g'', ''b''
:: Font color in RGB format.

Example:
new text[4] = ['A', 'p', 'p', '\0'];
abi_CMD_TEXT(text, RES_ID_FONT, 90, 160, 16, current_angles[face], 255, 0, 0);

API

2020-09-03T17:10:29Z

Oleg.sayakhov:

{{notice|This is a beta version, API changes can be made without warning.}}

=Introduction=

The main functions of the API are listed here, the features of the work of the environment are described

==WOWCube Paradigms==

WOWCube executes 8 copies of the byte-code of the script at the same time, providing functions for the interaction of scripts with each other, drawing functions, functions for accessing resources, and other specific functions. Each copy of the script has access to 3 displays. Resource scripts are packed into a package.

==Pawn API==
===Graphic functions===

====Graphics 2D acceleration (G2D)====
WOWCube provides the 2D acceleration interfaces to enhance gaming experience . Basically G2D engine allows to blend up to the 4 image layers at once with a HW acceleration. However there is no limit of layers, they are blended in a cascade. For example, if Pawn script requested 7 layers to be blended then 2 HW blending will occur:
[[File:Cascade.png|center|G2D cascading scheme]]
Result of the blending can be saved as an internal G2D resource or flushed immediately on the specified display. Internal G2D resources can be used as an usual bitmap primitive ([[API#abi_CMD_BITMAP|abi_CMD_BITMAP]]) or reused as an input for the next G2D action.
Basic coordinate principle:
[[File:G2d_coordinates.png|center|G2D coordinates sceme]]
Coordinates are limited from -2048 to 2047. Maximum layers size is 240x240.

=====abi_CMD_G2D_BEGIN_BITMAP=====
Syntax:
abi_CMD_G2D_BEGIN_BITMAP(const resID, const width, const height, const bool:replace)
Description:
: abi_CMD_G2D_BEGIN_BITMAP and [[API#abi_CMD_G2D_END|abi_CMD_G2D_END]] delimits the group of layers to be blended into internal G2D resource. This API is not intended for frequent usage. It is better suited for complex background generation on game initialization or dynamic resource modification triggered by rare game events.
Arguments:
: ''resID''
:: ID of the resource that will be generated from blending layers presented between abi_CMD_G2D_BEGIN_BITMAP and the subsequent [[API#abi_CMD_G2D_END|abi_CMD_G2D_END]]. G2D engine can keep up to 3 different resources with IDs: 0, 1 and 2.
: ''width''
:: Width of the resulting resource. G2D engine can keep resource of 240px width maximum.
: ''height''
:: Height of the resulting resource. G2D engine can keep resource of 240px height maximum.
: ''replace''
:: If true, then an existing image will be replaced completely, otherwise it will be overwritten by reusing itself as a background layer.

=====abi_CMD_G2D_BEGIN_DISPLAY=====
Syntax:
abi_CMD_G2D_BEGIN_DISPLAY(const display, const bool:replace)
Description:
: abi_CMD_G2D_BEGIN_DISPLAY and [[API#abi_CMD_G2D_END|abi_CMD_G2D_END]] delimits the group of layers to be blended directly into display framebuffer. Obviously this API is designed for rendering scene on game tick. This API is not limited by layers count as well as [[API#abi_CMD_G2D_BEGIN_BITMAP|abi_CMD_G2D_BEGIN_BITMAP]]. However it is strictly recommended to blend no more than 4 layers. Otherwise cascade blending will be initiated resulting in some FPS drop.
Arguments:
: ''display''
:: ID of the display which framebuffer will be used for blending. Each module have 3 displays with ID starting from 0.
: ''replace''
:: If true then an existing image will be replaced completely, otherwise it will be overwritten by reusing itself as a background layer.

=====abi_CMD_G2D_ADD_SPRITE=====
Syntax:
abi_CMD_G2D_ADD_SPRITE(const resID, const bool:g2d, const x, const y, const alpha, const color, const rotation, const mirror)
Description:
: Specifies game resource which will be used as a layer for blending.
Arguments:
: ''resID''
:: ID of the resource to be uses as a layer.
: ''g2d''
:: Indicates if an internal G2D resource is specified or not.
: ''x'', ''y''
:: Coordinates of the bitmap center to place on the layer.
: ''alpha''
:: Layer transparency in range between 0x00 and 0xFF, where 0x00 is a fully transparent layer.
: ''color''
:: Layer's source key - a color in ARGB8888 format to be avoided.
: ''rotation''
:: Clockwise rotation angle in degrees. It is possible to specify free angle, but only right angles have HW acceleration.
: ''mirror''
:: Mirroring variant. Possible values are self-explained: MIRROR_BLANK, MIRROR_X, MIRROR_Y, MIRROR_XY.

=====abi_CMD_G2D_ADD_RECTANGLE=====
Syntax:
abi_CMD_G2D_ADD_RECTANGLE(const x, const y, const width, const height, const color)
Description:
: Specifies rectangle area which will be used as layer of blending. This API is not intended for frequent usage, i.e. particles generation. It is better suited for changing image background or applying color mask.
Arguments:
: ''x'', ''y''
:: Coordinates of top left rectangle corner.
: ''width''
:: Rectangle width.
: ''height''
:: Rectangle height.
: ''color''
:: Rectangle color in ARGB8888 format.

=====abi_CMD_G2D_END=====
Syntax:
abi_CMD_G2D_END()
Description:
: abi_CMD_G2D_END() and [[API#abi_CMD_G2D_BEGIN_BITMAP|abi_CMD_G2D_BEGIN_BITMAP]]/[[API#abi_CMD_G2D_BEGIN_DISPLAY|abi_CMD_G2D_BEGIN_DISPLAY]] delimits the group of layers to be blended. After abi_CMD_G2D_END call final blending will be initiated and results will be stored according to the begin comand.

====Font drawing functions====
=====abi_CMD_TEXT=====
API:
abi_CMD_TEXT(const text[], const fontResID, const x, const y, const scale, const angle, const r, const g, const b)
Description:
: Intended to render a system font or a custom font from resources with specified coordinates, scale and rotation at an arbitrary angle.
Arguments:
: ''text''
:: Array of chars.
: ''fontResID''
:: Custom font resource identifier.
: ''x'', ''y''
:: Coordinates of top left rectangle corner.
: ''scale'', ''angle''
:: Percentage scale and clockwise rotation angle in degrees. Max size of font is 200x200 px. (scale = 100%)
: 'r', 'g', 'b'
:: Font color in RGB format.

Example:
new text[4] = ['A', 'p', 'p', '\0'];
abi_CMD_TEXT(text, RES_ID_FONT, 90, 160, 16, current_angles[face], 255, 0, 0);

API

2020-09-03T17:09:40Z

Oleg.sayakhov:

{{notice|This is a beta version, API changes can be made without warning.}}

=Introduction=

The main functions of the API are listed here, the features of the work of the environment are described

==WOWCube Paradigms==

WOWCube executes 8 copies of the byte-code of the script at the same time, providing functions for the interaction of scripts with each other, drawing functions, functions for accessing resources, and other specific functions. Each copy of the script has access to 3 displays. Resource scripts are packed into a package.

==Pawn API==
===Graphic functions===

====Graphics 2D acceleration (G2D)====
WOWCube provides the 2D acceleration interfaces to enhance gaming experience . Basically G2D engine allows to blend up to the 4 image layers at once with a HW acceleration. However there is no limit of layers, they are blended in a cascade. For example, if Pawn script requested 7 layers to be blended then 2 HW blending will occur:
[[File:Cascade.png|center|G2D cascading scheme]]
Result of the blending can be saved as an internal G2D resource or flushed immediately on the specified display. Internal G2D resources can be used as an usual bitmap primitive ([[API#abi_CMD_BITMAP|abi_CMD_BITMAP]]) or reused as an input for the next G2D action.
Basic coordinate principle:
[[File:G2d_coordinates.png|center|G2D coordinates sceme]]
Coordinates are limited from -2048 to 2047. Maximum layers size is 240x240.

=====abi_CMD_G2D_BEGIN_BITMAP=====
Syntax:
abi_CMD_G2D_BEGIN_BITMAP(const resID, const width, const height, const bool:replace)
Description:
: abi_CMD_G2D_BEGIN_BITMAP and [[API#abi_CMD_G2D_END|abi_CMD_G2D_END]] delimits the group of layers to be blended into internal G2D resource. This API is not intended for frequent usage. It is better suited for complex background generation on game initialization or dynamic resource modification triggered by rare game events.
Arguments:
: ''resID''
:: ID of the resource that will be generated from blending layers presented between abi_CMD_G2D_BEGIN_BITMAP and the subsequent [[API#abi_CMD_G2D_END|abi_CMD_G2D_END]]. G2D engine can keep up to 3 different resources with IDs: 0, 1 and 2.
: ''width''
:: Width of the resulting resource. G2D engine can keep resource of 240px width maximum.
: ''height''
:: Height of the resulting resource. G2D engine can keep resource of 240px height maximum.
: ''replace''
:: If true, then an existing image will be replaced completely, otherwise it will be overwritten by reusing itself as a background layer.

=====abi_CMD_G2D_BEGIN_DISPLAY=====
Syntax:
abi_CMD_G2D_BEGIN_DISPLAY(const display, const bool:replace)
Description:
: abi_CMD_G2D_BEGIN_DISPLAY and [[API#abi_CMD_G2D_END|abi_CMD_G2D_END]] delimits the group of layers to be blended directly into display framebuffer. Obviously this API is designed for rendering scene on game tick. This API is not limited by layers count as well as [[API#abi_CMD_G2D_BEGIN_BITMAP|abi_CMD_G2D_BEGIN_BITMAP]]. However it is strictly recommended to blend no more than 4 layers. Otherwise cascade blending will be initiated resulting in some FPS drop.
Arguments:
: ''display''
:: ID of the display which framebuffer will be used for blending. Each module have 3 displays with ID starting from 0.
: ''replace''
:: If true then an existing image will be replaced completely, otherwise it will be overwritten by reusing itself as a background layer.

=====abi_CMD_G2D_ADD_SPRITE=====
Syntax:
abi_CMD_G2D_ADD_SPRITE(const resID, const bool:g2d, const x, const y, const alpha, const color, const rotation, const mirror)
Description:
: Specifies game resource which will be used as a layer for blending.
Arguments:
: ''resID''
:: ID of the resource to be uses as a layer.
: ''g2d''
:: Indicates if an internal G2D resource is specified or not.
: ''x'', ''y''
:: Coordinates of the bitmap center to place on the layer.
: ''alpha''
:: Layer transparency in range between 0x00 and 0xFF, where 0x00 is a fully transparent layer.
: ''color''
:: Layer's source key - a color in ARGB8888 format to be avoided.
: ''rotation''
:: Clockwise rotation angle in degrees. It is possible to specify free angle, but only right angles have HW acceleration.
: ''mirror''
:: Mirroring variant. Possible values are self-explained: MIRROR_BLANK, MIRROR_X, MIRROR_Y, MIRROR_XY.

=====abi_CMD_G2D_ADD_RECTANGLE=====
Syntax:
abi_CMD_G2D_ADD_RECTANGLE(const x, const y, const width, const height, const color)
Description:
: Specifies rectangle area which will be used as layer of blending. This API is not intended for frequent usage, i.e. particles generation. It is better suited for changing image background or applying color mask.
Arguments:
: ''x'', ''y''
:: Coordinates of top left rectangle corner.
: ''width''
:: Rectangle width.
: ''height''
:: Rectangle height.
: ''color''
:: Rectangle color in ARGB8888 format.

=====abi_CMD_G2D_END=====
Syntax:
abi_CMD_G2D_END()
Description:
: abi_CMD_G2D_END() and [[API#abi_CMD_G2D_BEGIN_BITMAP|abi_CMD_G2D_BEGIN_BITMAP]]/[[API#abi_CMD_G2D_BEGIN_DISPLAY|abi_CMD_G2D_BEGIN_DISPLAY]] delimits the group of layers to be blended. After abi_CMD_G2D_END call final blending will be initiated and results will be stored according to the begin comand.

====Font drawing functions====
=====abi_CMD_TEXT=====
API:
abi_CMD_TEXT(const text[], const fontResID, const x, const y, const scale, const angle, const r, const g, const b)
Description:
: Intended for render a system font or a custom font from resources with specified coordinates, scale and rotation at an arbitrary angle.
Arguments:
: ''text''
:: Array of chars.
: ''fontResID''
:: Custom font resource identifier.
: ''x'', ''y''
:: Coordinates of top left rectangle corner.
: ''scale'', ''angle''
:: Percentage scale and clockwise rotation angle in degrees. Max size of font is 200x200 px. (scale = 100%)
: 'r', 'g', 'b'
:: Font color in RGB format.

Example:
new text[4] = ['A', 'p', 'p', '\0'];
abi_CMD_TEXT(text, RES_ID_FONT, 90, 160, 16, current_angles[face], 255, 0, 0);

API

2020-09-03T17:08:52Z

Oleg.sayakhov:

{{notice|This is a beta version, API changes can be made without warning.}}

=Introduction=

The main functions of the API are listed here, the features of the work of the environment are described

==WOWCube Paradigms==

WOWCube executes 8 copies of the byte-code of the script at the same time, providing functions for the interaction of scripts with each other, drawing functions, functions for accessing resources, and other specific functions. Each copy of the script has access to 3 displays. Resource scripts are packed into a package.

==Pawn API==
===Graphic functions===

====Graphics 2D acceleration (G2D)====
WOWCube provides the 2D acceleration interfaces to enhance gaming experience . Basically G2D engine allows to blend up to the 4 image layers at once with a HW acceleration. However there is no limit of layers, they are blended in a cascade. For example, if Pawn script requested 7 layers to be blended then 2 HW blending will occur:
[[File:Cascade.png|center|G2D cascading scheme]]
Result of the blending can be saved as an internal G2D resource or flushed immediately on the specified display. Internal G2D resources can be used as an usual bitmap primitive ([[API#abi_CMD_BITMAP|abi_CMD_BITMAP]]) or reused as an input for the next G2D action.
Basic coordinate principle:
[[File:G2d_coordinates.png|center|G2D coordinates sceme]]
Coordinates are limited from -2048 to 2047. Maximum layers size is 240x240.

=====abi_CMD_G2D_BEGIN_BITMAP=====
Syntax:
abi_CMD_G2D_BEGIN_BITMAP(const resID, const width, const height, const bool:replace)
Description:
: abi_CMD_G2D_BEGIN_BITMAP and [[API#abi_CMD_G2D_END|abi_CMD_G2D_END]] delimits the group of layers to be blended into internal G2D resource. This API is not intended for frequent usage. It is better suited for complex background generation on game initialization or dynamic resource modification triggered by rare game events.
Arguments:
: ''resID''
:: ID of the resource that will be generated from blending layers presented between abi_CMD_G2D_BEGIN_BITMAP and the subsequent [[API#abi_CMD_G2D_END|abi_CMD_G2D_END]]. G2D engine can keep up to 3 different resources with IDs: 0, 1 and 2.
: ''width''
:: Width of the resulting resource. G2D engine can keep resource of 240px width maximum.
: ''height''
:: Height of the resulting resource. G2D engine can keep resource of 240px height maximum.
: ''replace''
:: If true, then an existing image will be replaced completely, otherwise it will be overwritten by reusing itself as a background layer.

=====abi_CMD_G2D_BEGIN_DISPLAY=====
Syntax:
abi_CMD_G2D_BEGIN_DISPLAY(const display, const bool:replace)
Description:
: abi_CMD_G2D_BEGIN_DISPLAY and [[API#abi_CMD_G2D_END|abi_CMD_G2D_END]] delimits the group of layers to be blended directly into display framebuffer. Obviously this API is designed for rendering scene on game tick. This API is not limited by layers count as well as [[API#abi_CMD_G2D_BEGIN_BITMAP|abi_CMD_G2D_BEGIN_BITMAP]]. However it is strictly recommended to blend no more than 4 layers. Otherwise cascade blending will be initiated resulting in some FPS drop.
Arguments:
: ''display''
:: ID of the display which framebuffer will be used for blending. Each module have 3 displays with ID starting from 0.
: ''replace''
:: If true then an existing image will be replaced completely, otherwise it will be overwritten by reusing itself as a background layer.

=====abi_CMD_G2D_ADD_SPRITE=====
Syntax:
abi_CMD_G2D_ADD_SPRITE(const resID, const bool:g2d, const x, const y, const alpha, const color, const rotation, const mirror)
Description:
: Specifies game resource which will be used as a layer for blending.
Arguments:
: ''resID''
:: ID of the resource to be uses as a layer.
: ''g2d''
:: Indicates if an internal G2D resource is specified or not.
: ''x'', ''y''
:: Coordinates of the bitmap center to place on the layer.
: ''alpha''
:: Layer transparency in range between 0x00 and 0xFF, where 0x00 is a fully transparent layer.
: ''color''
:: Layer's source key - a color in ARGB8888 format to be avoided.
: ''rotation''
:: Clockwise rotation angle in degrees. It is possible to specify free angle, but only right angles have HW acceleration.
: ''mirror''
:: Mirroring variant. Possible values are self-explained: MIRROR_BLANK, MIRROR_X, MIRROR_Y, MIRROR_XY.

=====abi_CMD_G2D_ADD_RECTANGLE=====
Syntax:
abi_CMD_G2D_ADD_RECTANGLE(const x, const y, const width, const height, const color)
Description:
: Specifies rectangle area which will be used as layer of blending. This API is not intended for frequent usage, i.e. particles generation. It is better suited for changing image background or applying color mask.
Arguments:
: ''x'', ''y''
:: Coordinates of top left rectangle corner.
: ''width''
:: Rectangle width.
: ''height''
:: Rectangle height.
: ''color''
:: Rectangle color in ARGB8888 format.

=====abi_CMD_G2D_END=====
Syntax:
abi_CMD_G2D_END()
Description:
: abi_CMD_G2D_END() and [[API#abi_CMD_G2D_BEGIN_BITMAP|abi_CMD_G2D_BEGIN_BITMAP]]/[[API#abi_CMD_G2D_BEGIN_DISPLAY|abi_CMD_G2D_BEGIN_DISPLAY]] delimits the group of layers to be blended. After abi_CMD_G2D_END call final blending will be initiated and results will be stored according to the begin comand.

====Graphic primitives====

=====Font drawing functions=====
======abi_CMD_TEXT======
API:
abi_CMD_TEXT(const text[], const fontResID, const x, const y, const scale, const angle, const r, const g, const b)
Description:
: Intended for render a system font or a custom font from resources with specified coordinates, scale and rotation at an arbitrary angle.
Arguments:
: ''text''
:: Array of chars.
: ''fontResID''
:: Custom font resource identifier.
: ''x'', ''y''
:: Coordinates of top left rectangle corner.
: ''scale'', ''angle''
:: Percentage scale and clockwise rotation angle in degrees. Max size of font is 200x200 px. (scale = 100%)
: 'r', 'g', 'b'
:: Font color in RGB format.

Example:
new text[4] = ['A', 'p', 'p', '\0'];
abi_CMD_TEXT(text, RES_ID_FONT, 90, 160, 16, current_angles[face], 255, 0, 0);

API

2020-09-03T17:07:55Z

Oleg.sayakhov:

{{notice|This is a beta version, API changes can be made without warning.}}

=Introduction=

The main functions of the API are listed here, the features of the work of the environment are described

==WOWCube Paradigms==

WOWCube executes 8 copies of the byte-code of the script at the same time, providing functions for the interaction of scripts with each other, drawing functions, functions for accessing resources, and other specific functions. Each copy of the script has access to 3 displays. Resource scripts are packed into a package.

==Pawn API==
===Graphic functions===

====Graphics 2D acceleration (G2D)====
WOWCube provides the 2D acceleration interfaces to enhance gaming experience . Basically G2D engine allows to blend up to the 4 image layers at once with a HW acceleration. However there is no limit of layers, they are blended in a cascade. For example, if Pawn script requested 7 layers to be blended then 2 HW blending will occur:
[[File:Cascade.png|center|G2D cascading scheme]]
Result of the blending can be saved as an internal G2D resource or flushed immediately on the specified display. Internal G2D resources can be used as an usual bitmap primitive ([[API#abi_CMD_BITMAP|abi_CMD_BITMAP]]) or reused as an input for the next G2D action.
Basic coordinate principle:
[[File:G2d_coordinates.png|center|G2D coordinates sceme]]
Coordinates are limited from -2048 to 2047. Maximum layers size is 240x240.

=====abi_CMD_G2D_BEGIN_BITMAP=====
Syntax:
abi_CMD_G2D_BEGIN_BITMAP(const resID, const width, const height, const bool:replace)
Description:
: abi_CMD_G2D_BEGIN_BITMAP and [[API#abi_CMD_G2D_END|abi_CMD_G2D_END]] delimits the group of layers to be blended into internal G2D resource. This API is not intended for frequent usage. It is better suited for complex background generation on game initialization or dynamic resource modification triggered by rare game events.
Arguments:
: ''resID''
:: ID of the resource that will be generated from blending layers presented between abi_CMD_G2D_BEGIN_BITMAP and the subsequent [[API#abi_CMD_G2D_END|abi_CMD_G2D_END]]. G2D engine can keep up to 3 different resources with IDs: 0, 1 and 2.
: ''width''
:: Width of the resulting resource. G2D engine can keep resource of 240px width maximum.
: ''height''
:: Height of the resulting resource. G2D engine can keep resource of 240px height maximum.
: ''replace''
:: If true, then an existing image will be replaced completely, otherwise it will be overwritten by reusing itself as a background layer.

=====abi_CMD_G2D_BEGIN_DISPLAY=====
Syntax:
abi_CMD_G2D_BEGIN_DISPLAY(const display, const bool:replace)
Description:
: abi_CMD_G2D_BEGIN_DISPLAY and [[API#abi_CMD_G2D_END|abi_CMD_G2D_END]] delimits the group of layers to be blended directly into display framebuffer. Obviously this API is designed for rendering scene on game tick. This API is not limited by layers count as well as [[API#abi_CMD_G2D_BEGIN_BITMAP|abi_CMD_G2D_BEGIN_BITMAP]]. However it is strictly recommended to blend no more than 4 layers. Otherwise cascade blending will be initiated resulting in some FPS drop.
Arguments:
: ''display''
:: ID of the display which framebuffer will be used for blending. Each module have 3 displays with ID starting from 0.
: ''replace''
:: If true then an existing image will be replaced completely, otherwise it will be overwritten by reusing itself as a background layer.

=====abi_CMD_G2D_ADD_SPRITE=====
Syntax:
abi_CMD_G2D_ADD_SPRITE(const resID, const bool:g2d, const x, const y, const alpha, const color, const rotation, const mirror)
Description:
: Specifies game resource which will be used as a layer for blending.
Arguments:
: ''resID''
:: ID of the resource to be uses as a layer.
: ''g2d''
:: Indicates if an internal G2D resource is specified or not.
: ''x'', ''y''
:: Coordinates of the bitmap center to place on the layer.
: ''alpha''
:: Layer transparency in range between 0x00 and 0xFF, where 0x00 is a fully transparent layer.
: ''color''
:: Layer's source key - a color in ARGB8888 format to be avoided.
: ''rotation''
:: Clockwise rotation angle in degrees. It is possible to specify free angle, but only right angles have HW acceleration.
: ''mirror''
:: Mirroring variant. Possible values are self-explained: MIRROR_BLANK, MIRROR_X, MIRROR_Y, MIRROR_XY.

=====abi_CMD_G2D_ADD_RECTANGLE=====
Syntax:
abi_CMD_G2D_ADD_RECTANGLE(const x, const y, const width, const height, const color)
Description:
: Specifies rectangle area which will be used as layer of blending. This API is not intended for frequent usage, i.e. particles generation. It is better suited for changing image background or applying color mask.
Arguments:
: ''x'', ''y''
:: Coordinates of top left rectangle corner.
: ''width''
:: Rectangle width.
: ''height''
:: Rectangle height.
: ''color''
:: Rectangle color in ARGB8888 format.

=====abi_CMD_G2D_END=====
Syntax:
abi_CMD_G2D_END()
Description:
: abi_CMD_G2D_END() and [[API#abi_CMD_G2D_BEGIN_BITMAP|abi_CMD_G2D_BEGIN_BITMAP]]/[[API#abi_CMD_G2D_BEGIN_DISPLAY|abi_CMD_G2D_BEGIN_DISPLAY]] delimits the group of layers to be blended. After abi_CMD_G2D_END call final blending will be initiated and results will be stored according to the begin comand.

====Graphic primitives====

====Font drawing functions====
=====abi_CMD_TEXT=====
API:
abi_CMD_TEXT(const text[], const fontResID, const x, const y, const scale, const angle, const r, const g, const b)
Description:
: Intended for render a system font or a custom font from resources with specified coordinates, scale and rotation at an arbitrary angle.
Arguments:
: ''text''
:: Array of chars.
: ''fontResID''
:: Custom font resource identifier.
: ''x'', ''y''
:: Coordinates of top left rectangle corner.
: ''scale'', ''angle''
:: Percentage scale and clockwise rotation angle in degrees. Max size of font is 200x200 px. (scale = 100%)
: 'r', 'g', 'b'
:: Font color in RGB format.

Example:
new text[4] = ['A', 'p', 'p', '\0'];
abi_CMD_TEXT(text, RES_ID_FONT, 90, 160, 16, current_angles[face], 255, 0, 0);

API

2020-09-02T16:56:55Z

Oleg.sayakhov: