https://wiki.wowcube.com/api.php?action=feedcontributions&feedformat=atom&user=Raccoon+pirateWowWiki - User contributions [en]2026-05-20T07:25:51ZUser contributionsMediaWiki 1.33.0https://wiki.wowcube.com/index.php?title=API&diff=16506API2022-02-11T06:50:12Z<p>Raccoon pirate: /* Physics_Circle_vs_AABB_obj */</p>
<hr />
<div>{{notice|This is a beta version, API changes can be made without warning.}}<br />
<br />
=Introduction=<br />
<br />
The main functions of the API are listed here, the features of the work of the environment are described<br />
<br />
==WOWCube Paradigms==<br />
<br />
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.<br />
<br />
==Pawn API==<br />
===Graphic functions===<br />
<br />
====Graphics 2D acceleration (G2D)====<br />
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:<br />
[[File:Cascade.png|center|G2D cascading scheme]]<br />
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.<br />
Basic coordinate principle:<br />
[[File:G2d_coordinates.png|center|G2D coordinates sceme]]<br />
Coordinates are limited from -2048 to 2047. Maximum layers size is 240x240.<br />
<br />
=====abi_CMD_G2D_BEGIN_BITMAP=====<br />
Syntax:<br />
abi_CMD_G2D_BEGIN_BITMAP(const resID, const width, const height, const bool:replace)<br />
Description:<br />
: 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.<br />
Arguments:<br />
: ''resID''<br />
:: 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.<br />
: ''width'' <br />
:: Width of the resulting resource. G2D engine can keep resource of 240px width maximum.<br />
: ''height'' <br />
:: Height of the resulting resource. G2D engine can keep resource of 240px height maximum.<br />
: ''replace'' <br />
:: If true, then an existing image will be replaced completely, otherwise it will be overwritten by reusing itself as a background layer.<br />
<br />
=====abi_CMD_G2D_BEGIN_DISPLAY=====<br />
Syntax:<br />
abi_CMD_G2D_BEGIN_DISPLAY(const display, const bool:replace)<br />
Description:<br />
: 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.<br />
Arguments:<br />
: ''display''<br />
:: ID of the display which framebuffer will be used for blending. Each module have 3 displays with ID starting from 0.<br />
: ''replace'' <br />
:: If true then an existing image will be replaced completely, otherwise it will be overwritten by reusing itself as a background layer.<br />
<br />
=====abi_CMD_G2D_ADD_SPRITE=====<br />
Syntax:<br />
abi_CMD_G2D_ADD_SPRITE(const resID, const bool:g2d, const x, const y, const alpha, const color, const rotation, const mirror)<br />
Description:<br />
: Specifies game resource which will be used as a layer for blending.<br />
Arguments:<br />
: ''resID''<br />
:: ID of the resource to be uses as a layer.<br />
: ''g2d''<br />
:: Indicates if an internal G2D resource is specified or not.<br />
: ''x'', ''y''<br />
:: Coordinates of the bitmap center to place on the layer.<br />
: ''alpha''<br />
:: Layer transparency in range between 0x00 and 0xFF, where 0x00 is a fully transparent layer.<br />
: ''color''<br />
:: Layer's source key - a color in ARGB8888 format to be avoided.<br />
: ''rotation''<br />
:: Clockwise rotation angle in degrees. It is possible to specify free angle, but only right angles have HW acceleration. Currently rotation only applicable for external resources.<br />
: ''mirror''<br />
:: Mirroring variant. Possible values are self-explained: MIRROR_BLANK, MIRROR_X, MIRROR_Y, MIRROR_XY.<br />
<br />
=====abi_CMD_G2D_ADD_RECTANGLE=====<br />
Syntax:<br />
abi_CMD_G2D_ADD_RECTANGLE(const x, const y, const width, const height, const color)<br />
Description:<br />
: 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.<br />
Arguments:<br />
: ''x'', ''y''<br />
:: Coordinates of top left rectangle corner.<br />
: ''width''<br />
:: Rectangle width.<br />
: ''height''<br />
:: Rectangle height.<br />
: ''color''<br />
:: Rectangle color in ARGB8888 format.<br />
<br />
=====abi_CMD_G2D_END=====<br />
Syntax:<br />
abi_CMD_G2D_END()<br />
Description:<br />
: 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.<br />
<br />
=====Examples=====<br />
1. Render into inner G2D resource buffer #face and display it on the display #face. Please, note that last argument of abi_CMD_BITMAP is a `true` flag, which means G2D resource should be used:<br />
...<br />
abi_CMD_G2D_BEGIN_BITMAP(face, 240, 240, true);<br />
abi_CMD_G2D_ADD_RECTANGLE(120 - animationSquareSize0, 120 - animationSquareSize0, animationSquareSize0 * 2, animationSquareSize0 * 2, 0xdfff0000);<br />
abi_CMD_G2D_ADD_RECTANGLE(120 - animationSquareSize1, 120 - animationSquareSize1, animationSquareSize1 * 2, animationSquareSize1 * 2, 0xdfffff00);<br />
abi_CMD_G2D_ADD_RECTANGLE(120 - animationSquareSize2, 120 - animationSquareSize2, animationSquareSize2 * 2, animationSquareSize2 * 2, 0xdfff00ff);<br />
abi_CMD_G2D_ADD_RECTANGLE(120 - animationSquareSize3, 120 - animationSquareSize3, animationSquareSize3 * 2, animationSquareSize3 * 2, 0xdf00ffff);<br />
abi_CMD_G2D_ADD_SPRITE(resID, false, 120, 120, animationAlpha, 0x00000000, animationAngle, MIRROR_BLANK);<br />
abi_CMD_G2D_END();<br />
...<br />
abi_CMD_BITMAP(face, 120, 120, 0, MIRROR_BLANK, true);<br />
...<br />
abi_CMD_REDRAW(face);<br />
...<br />
2. Render directly into display framebuffer #face. This will produce same result on display as example #1, but the generated image is not saved:<br />
...<br />
abi_CMD_G2D_BEGIN_DISPLAY(face, true);<br />
abi_CMD_G2D_ADD_RECTANGLE(120 - animationSquareSize0, 120 - animationSquareSize0, animationSquareSize0 * 2, animationSquareSize0 * 2, 0xdfff0000);<br />
abi_CMD_G2D_ADD_RECTANGLE(120 - animationSquareSize1, 120 - animationSquareSize1, animationSquareSize1 * 2, animationSquareSize1 * 2, 0xdfffff00);<br />
abi_CMD_G2D_ADD_RECTANGLE(120 - animationSquareSize2, 120 - animationSquareSize2, animationSquareSize2 * 2, animationSquareSize2 * 2, 0xdfff00ff);<br />
abi_CMD_G2D_ADD_RECTANGLE(120 - animationSquareSize3, 120 - animationSquareSize3, animationSquareSize3 * 2, animationSquareSize3 * 2, 0xdf00ffff);<br />
abi_CMD_G2D_ADD_SPRITE(resID, false, 120, 120, animationAlpha, 0x00000000, animationAngle, MIRROR_BLANK);<br />
abi_CMD_G2D_END();<br />
...<br />
<br />
====Font drawing functions====<br />
=====abi_CMD_TEXT=====<br />
API:<br />
abi_CMD_TEXT(const text[], const fontResID, const x, const y, const scale, const angle, const r, const g, const b)<br />
Description:<br />
: Intended to render a system font or a custom font from resources with specified coordinates, scale and rotation at an arbitrary angle.<br />
Arguments:<br />
: ''text''<br />
:: Array of chars.<br />
: ''fontResID''<br />
:: Custom font resource identifier. Provide ''-1'' to use system font resource.<br />
: ''x'', ''y''<br />
:: Coordinates of top left rectangle corner.<br />
: ''scale'', ''angle''<br />
:: Percentage scale and clockwise rotation angle in degrees. Max size of font is 200x200 px. (scale = 100%)<br />
: ''r'', ''g'', ''b''<br />
:: Font color in RGB format.<br />
<br />
Example:<br />
new text[4] = ['A', 'p', 'p', '\0'];<br />
abi_CMD_TEXT(text, RES_ID_FONT, 90, 160, 16, current_angles[face], 255, 0, 0);<br />
<br />
====TEXTURE drawing functions====<br />
=====abi_CMD_DYNAMIC_TEXTURE=====<br />
<br />
API:<br />
<br />
abi_CMD_DYNAMIC_TEXTURE(const effectId = 1, const time = any value, const args[] = {0x04030201, 0x08070605, 0x00000A09}, const argsCount = 3, const bool:g2d = false)<br />
<br />
Description:<br />
: Render a texture with chosen algorithm and parameters.<br />
Arguments:<br />
: ''effectId''<br />
:: Define algorithm to render texture. <br />
:: Available values : G2D_DYNAMIC_TEXTURE_MOSAIC <br />
<br />
: ''time ''<br />
:: Current time value. Use any fixed value to static texture or set current time value in milliseconds to make texture alive.<br />
: ''args'', ''argsCount''<br />
:: Byte stream of algorithm settings it's aligned to 4 bytes, because of pawn supports only 32-bit values.<br />
:: Size of array depends on algorithm. For example mosaic algorithm has size of settings equals 10 bytes , so we must use aligned 4 bytes - 12 bytes array and argsCount = 3<br />
<br />
: ''g2d''<br />
:: false - Use pawn default buffer to draw texture.<br />
:: true - Use g2d buffer to draw texture - not supported now.<br />
<br />
'''G2D_DYNAMIC_TEXTURE_MOSAIC''' alogrithm description<br />
<br />
:So in effect named 'mosaic' we have settings of 10 parameters each one 1 byte<br />
<br />
:Noise factors :<br />
::factor x : values from 0 to 10<br />
::factor y : values from 0 to 10<br />
::factor xy : values from 0 to 10<br />
:Time factors :<br />
::factor x : values from 0 to 10<br />
::factor y : values from 0 to 10<br />
::factor xy : values from 0 to 10<br />
:Color factors :<br />
::r : values from 0 to 10<br />
::g : values from 0 to 10<br />
::b : values from 0 to 10<br />
:Zoom factor :<br />
::zoom values from 0 to 10<br />
<br />
For example we want to set all parameters above with values in order 1,2,3,4,5,6,7,8,9,10. Take in attention that each parameter is 1 byte we must make array of 32-bit values<br />
0x04030201, 0x08070605, 0x00000A09<br />
<br />
Example:<br />
mosaic_effect_settings = { 0x04030201, 0x08070605, 0x00000A09 };<br />
mosaic_effect_settings_length = 3;<br />
abi_CMD_DYNAMIC_TEXTURE(G2D_DYNAMIC_TEXTURE_MOSAIC , currentTime, mosaic_effect_settings, mosaic_effect_settings_length);<br />
<br />
===Motion sensors===<br />
====abi_MTD_GetFaceAccel(X/Y/Z)====<br />
Syntax:<br />
abi_MTD_GetFaceAccelX(const faceN)<br />
abi_MTD_GetFaceAccelY(const faceN)<br />
abi_MTD_GetFaceAccelZ(const faceN)<br />
Description:<br />
: Get the value of acceleration along the requested axis.<br />
Arguments<br />
: ''faceN''<br />
:: Number of the module face for which requested axis is belong.<br />
<br />
====abi_MTD_GetFaceGyro(X/Y/Z)====<br />
Syntax:<br />
abi_MTD_GetFaceGyroX(const faceN)<br />
abi_MTD_GetFaceGyroY(const faceN)<br />
abi_MTD_GetFaceGyroZ(const faceN)<br />
Description:<br />
: Get the gyro value around the requested axis.<br />
Arguments<br />
: ''faceN''<br />
:: Number of the module face for which requested axis is belong.<br />
<br />
====abi_MTD_GetTapFace====<br />
Syntax:<br />
abi_MTD_GetTapFace()<br />
Description:<br />
: Get the face ID which was tapped. ID is not a face number which is used for drawing in abi_CMD_G2D_BEGIN_DISPLAY or abi_CMD_REDRAW, but that number can be calculated by subtracting by one from ID value. See possible values below.<br />
Return values:<br />
: ''MTD_TAP_DIRECTION_NONE = 0''<br />
:: Indicates that the module wan not tapped.<br />
: ''MTD_TAP_DIRECTION_X = 1''<br />
: ''MTD_TAP_DIRECTION_Y = 2''<br />
: ''MTD_TAP_DIRECTION_Z = 3''<br />
:: Indicated direction of tap.<br />
<br />
====abi_MTD_IsTapOpposite====<br />
Syntax:<br />
abi_MTD_IsTapOpposite()<br />
Description:<br />
: Get the flag if the tap was detected in opposite direction.<br />
<br />
====abi_MTD_GetTapsCount====<br />
Syntax:<br />
abi_MTD_GetTapsCount()<br />
Description:<br />
: Get the count of subsequent taps. Tap is treated as a subsequent if it was detected within predefined interval (350ms). Count will be zero until sequence is finished, i.e. next tap is not detected within interval.<br />
<br />
====abi_checkShake====<br />
Syntax:<br />
abi_checkShake()<br />
Description:<br />
: Checks if the number of shakes of the cube was more than a certain threshold then exits the script <br />
<br />
<br />
====Examples====<br />
1. Flash the face on which tap was detected. Print an ID of that face. Color of the flash depends on taps count: red - one tap, green - two taps and blue - three.<br />
new delay = 0;<br />
new color = 0x000000; <br />
ONTICK() {<br />
if (!color) {<br />
switch (abi_MTD_GetTapsCount()) {<br />
case 1:<br />
color = 0xff0000;<br />
case 2:<br />
color = 0x00ff00;<br />
case 3:<br />
color = 0x0000ff;<br />
}<br />
}<br />
if (delay % 25 == 0) {<br />
for (new i = 0; i < FACES_MAX; i++) {<br />
if (i == (abi_MTD_GetTapFace() - 1)) {<br />
abi_CMD_FILL_2(color);<br />
color = 0x000000;<br />
switch (abi_MTD_GetTapFace()) {<br />
case 1:<br />
abi_CMD_TEXT(['1', '\0'], -1, 120, 120, 14, 0, 0xff, 0xff, 0xff);<br />
case 2:<br />
abi_CMD_TEXT(['2', '\0'], -1, 120, 120, 14, 0, 0xff, 0xff, 0xff);<br />
case 3:<br />
abi_CMD_TEXT(['3', '\0'], -1, 120, 120, 14, 0, 0xff, 0xff, 0xff);<br />
}<br />
} else {<br />
abi_CMD_FILL(0, 0, 0);<br />
}<br />
abi_CMD_REDRAW(i);<br />
}<br />
}<br />
delay++;<br />
}<br />
2. Exit from script<br />
ONTICK() {<br />
if (abi_cubeN == 0) {<br />
abi_checkShake();<br />
}<br />
// Script logic<br />
}<br />
<br />
===Save/load functions===<br />
<br />
====abi_CMD_SAVE_STATE====<br />
Syntax:<br />
bool:abi_CMD_SAVE_STATE(const data[], size = sizeof(data))<br />
Description:<br />
: Save maximum 256 bytes of data to wowcube flash memory.<br />
Arguments<br />
: ''data''<br />
:: Game data to save.<br />
: ''size''<br />
:: Size of game data.<br />
Return values:<br />
: ''return false''<br />
:: If size is bigger then 256 bytes.<br />
<br />
====abi_CMD_LOAD_STATE====<br />
Syntax:<br />
abi_CMD_LOAD_STATE()<br />
Description:<br />
: Sends a command requesting the platform to load script data. The response from the platform is not instantaneous and takes several milliseconds.<br />
<br />
====Examples====<br />
1. Load data at the start.<br />
// This function is called when a response is received from the platform<br />
ON_LOAD_GAME_DATA (const pkt[]) {<br />
// Deserialize pkt<br />
currentLevelNumber = pkt[1]; // Starting with 1 cause 0 pkt element holding command ID<br />
score = pkt[2];<br />
moves = pkt[3];<br />
...<br />
record = pkt[GAME_SAVE_SIZE];<br />
}<br />
ON_INIT () {<br />
abi_CMD_LOAD_STATE ();<br />
}<br />
<br />
2. Save the data after the end of the level.<br />
SaveGameState () {<br />
new saveData [GAME_SAVE_SIZE];<br />
// Assign all necessary data<br />
saveData[0] = currentLevelNumber;<br />
saveData[1] = score;<br />
saveData[2] = moves;<br />
...<br />
saveData[GAME_SAVE_SIZE - 1] = record;<br />
<br />
abi_CMD_SAVE_STATE (saveData);<br />
}<br />
ON_CHECK_ROTATE () {<br />
if (isLevelFinished) {<br />
SaveGameState();<br />
}<br />
}<br />
<br />
===Time functions===<br />
====abi_GetTime====<br />
Syntax:<br />
abi_GetTime()<br />
Description:<br />
: Get current time in milliseconds.<br />
<br />
====Examples====<br />
new previousTime = 0;<br />
new currentTime = 0;<br />
new deltaTime = 0;<br />
ON_INIT() {<br />
previousTime = abi_GetTime();<br />
}<br />
ONTICK() {<br />
currentTime = abi_GetTime();<br />
deltaTime = currentTime - previousTime;<br />
previousTime = currentTime;<br />
}<br />
<br />
<br />
===Topology functions===<br />
====get cube/face====<br />
Syntax:<br />
abi_topCubeN(const _cubeN, const _faceN)<br />
abi_topFaceN(const _cubeN, const _faceN)<br />
abi_rightCubeN(const _cubeN, const _faceN)<br />
abi_rightFaceN(const _cubeN, const _faceN)<br />
abi_bottomCubeN(const _cubeN, const _faceN)<br />
abi_bottomFaceN(const _cubeN, const _faceN)<br />
abi_leftCubeN(const _cubeN, const _faceN)<br />
abi_leftFaceN(const _cubeN, const _faceN)<br />
Description:<br />
: Returns the cube / screen located at the top / bottom / left / right of the specified in parameters.<br />
<br />
====Examples====<br />
Find diagonal face and cube<br />
new diagonalCube = CUBES_MAX;<br />
new diagonalFace = FACES_MAX;<br />
new topCube = abi_topCubeN(cube, face);<br />
new topFace = abi_topFaceN(cube, face);<br />
if (topCube < CUBES_MAX) {<br />
diagonalCube = abi_topCubeN(topCube, topFace);<br />
if (diagonalCube < CUBES_MAX) {<br />
diagonalFace = abi_topFaceN(topCube, topFace);<br />
}<br />
}<br />
<br />
<br />
===Sound functions===<br />
====abi_CMD_PLAYSND====<br />
Syntax:<br />
abi_CMD_PLAYSND(const id, const volume)<br />
Description:<br />
: Play chosen sound with a given volume.<br />
Arguments<br />
: ''id''<br />
:: Sound serial number in the application package.<br />
: ''volume''<br />
:: The sound volume.<br />
<br />
<br />
===Messages===<br />
====abi_CMD_NET_TX====<br />
Syntax:<br />
abi_CMD_NET_TX(const line_tx, const TTL, const data[])<br />
Description:<br />
: Send data through given UART line with given TTL.<br />
Arguments<br />
: ''line_tx''<br />
:: UART line for sending a message. Each module has 3 UART lines.<br />
: ''TTL''<br />
:: Message time to live. How many modules message will pass through before stopping. For example, set TTL to 0 message will transfer only to the neighbor module. Set TTL to 1 message will transfer to a neighbor of neighbor. Maximum TTL is 2.<br />
: ''data''<br />
:: Data array to send. Maximum can be sent 20 bytes. The first 4 bytes are message general information that automatically adds before sending. The maximum useful data that can be sent are 16 bytes. Taking into account net command name 15 bytes.<br />
<br />
====Examples====<br />
We want to receive data only from 0 module<br />
<br />
// define net command<br />
#define NEW_TEST_NET_COMMAND P2P_CMD_BASE_SCRIPT_1 + 1<br />
<br />
// create message to send<br />
Send_Test_Message() {<br />
new data[4];<br />
data[0] = NEW_TEST_NET_COMMAND | (abi_cubeN << 8);<br />
data[1] = add_game_data;<br />
// using bitwise operations send more data<br />
data[2] = add_script_data_1 | (add_script_data_2 << 8) | (add_script_data_3 << 16) | (add_script_data_4 << 24);<br />
data[3] = add_game_data_1 | (add_game_data_2 << 16);<br />
<br />
// send message through UART<br />
abi_CMD_NET_TX(0, NET_BROADCAST_TTL_MAX, data);<br />
abi_CMD_NET_TX(1, NET_BROADCAST_TTL_MAX, data);<br />
abi_CMD_NET_TX(2, NET_BROADCAST_TTL_MAX, data);<br />
}<br />
<br />
// process the received message<br />
ON_CMD_NET_RX (const pkt[]) {<br />
// get 4 byte from incoming packet to get net command because first 4 bytes are general info<br />
switch (abi_ByteN(pkt, 4)) {<br />
case NEW_TEST_NET_COMMAND: {<br />
if (abi_ByteN(pkt, 5) == 0) {<br />
game_data = pkt[2];<br />
script_data_1 = abi_ByteN(pkt, 12);<br />
script_data_2 = abi_ByteN(pkt, 13);<br />
script_data_3 = abi_ByteN(pkt, 14);<br />
script_data_4 = abi_ByteN(pkt, 15);<br />
game_data_1 = pkt[4] & 0xFFFF;<br />
game_data_2 = (pkt[4] >> 16) & 0xFFFF;<br />
}<br />
}<br />
}<br />
}<br />
<br />
===Physics functions===<br />
====PHYSICS_CIRCLE_DATA====<br />
Syntax:<br />
#define PHYSICS_CIRCLE_DATA .posX, .posY, .simplePosX, .simplePosY, .spdX, .spdY, .mass, .radius, .CoR, .cube, .face, .cubeT, .faceT<br />
Description:<br />
: PAWN symbolic subscript which represent stucture.<br />
Fields<br />
: ''posX''<br />
:: Circle position on X axis (fixed point)<br />
: ''posY''<br />
:: Circle position on Y axis (fixed point)<br />
: ''simplePosX''<br />
:: Circle position on X axis<br />
: ''simplePosY''<br />
:: Circle position on Y axis<br />
: ''spdX''<br />
:: Circle X speed<br />
: ''spdY''<br />
:: Circle Y speed<br />
: ''mass''<br />
:: Circle mass (fixed point)<br />
: ''radius''<br />
:: Circle radius<br />
: ''CoR''<br />
:: Coefficient of restitution (fixed point)<br />
: ''cube''<br />
:: Module owner of this circle<br />
: ''face''<br />
:: Face owner of this circle<br />
: ''cubeT''<br />
:: Cube transfer, last module owner. Can be used for resending messages<br />
: ''faceT''<br />
:: Face transfer, last face owner. Can be used for resending messages<br />
<br />
====Physics_Circle_Vs_Circle_obj====<br />
Syntax:<br />
Physics_Circle_Vs_Circle_obj(circle1[PHYSICS_CIRCLE_DATA], circle2[PHYSICS_CIRCLE_DATA])<br />
Description:<br />
: Check circle versus circle collision.<br />
Arguments:<br />
: circle1<br />
:: First circle object.<br />
: circle2<br />
:: Second circle object.<br />
<br />
====Physics_Circle_vs_AABB_obj====<br />
Syntax:<br />
Physics_Circle_vs_AABB_obj(circle[PHYSICS_CIRCLE_DATA], rectX, rectY, rectWidth, rectHeight, fakeCircle[PHYSICS_CIRCLE_DATA] = 0)<br />
Description:<br />
: Check circle versus rectangle collision.<br />
Arguments:<br />
: circle<br />
:: Circle object.<br />
: rectX<br />
:: X coordinate of top left rectangle corner.<br />
: rectY<br />
:: Y coordinate of top left rectangle corner.<br />
: rectWidth<br />
:: Rectangle width.<br />
: rectHeight<br />
:: Rectangle height.<br />
: fakeCircle<br />
:: In case of collision returns the collision point.<br />
<br />
====Physics_Circle_Vs_LineSegment====<br />
Syntax:<br />
Physics_Circle_Vs_LineSegment(circle[PHYSICS_CIRCLE_DATA], lineSX, lineSY, lineEX, lineEY, fakeCircle[PHYSICS_CIRCLE_DATA] = 0)<br />
Description:<br />
: Check circle versus line segment collision.<br />
Arguments:<br />
: circle<br />
:: Circle object.<br />
: lineSX<br />
:: Line start X coordinates.<br />
: lineSY<br />
:: Line start Y coordinate.<br />
: lineEX<br />
:: Line end X coordinate.<br />
: lineEY<br />
:: Line end Y coordinate.<br />
: fakeCircle<br />
:: In case of collision returns the collision point.<br />
<br />
====Physics_Res_CvC_Coll_Massless====<br />
Syntax:<br />
Physics_Res_CvC_Coll_Massless(circle1[PHYSICS_CIRCLE_DATA], circle2[PHYSICS_CIRCLE_DATA])<br />
Description:<br />
: Collision resolves without using object mass.<br />
Arguments:<br />
: circle1<br />
:: First circle object.<br />
: circle2<br />
:: Second circle object.<br />
<br />
====Physics_Res_CvC_Coll_Mass====<br />
Syntax:<br />
Physics_Res_CvC_Coll_Mass(circle1[PHYSICS_CIRCLE_DATA], circle2[PHYSICS_CIRCLE_DATA])<br />
Description:<br />
: Resolves collision using object mass.<br />
Arguments:<br />
: circle1<br />
:: First circle object.<br />
: circle2<br />
:: Second circle object.<br />
<br />
====Physics_DeserializeCircle====<br />
Syntax:<br />
Physics_DeserializeCircle(serializedData_1, serializedData_2, circle[PHYSICS_CIRCLE_DATA])<br />
Description:<br />
: Deserialize circle object.<br />
Arguments:<br />
: serializedData_1<br />
:: First part of serialized circle data.<br />
: serializedData_2<br />
:: Second part of serialized circle data.<br />
: circle<br />
:: Circle object where need to save deserialized data.<br />
<br />
====Physics_SerializeCircle====<br />
Syntax:<br />
Physics_SerializeCircle(obj[PHYSICS_CIRCLE_DATA], &serializedData_1, &serializedData_2)<br />
Description:<br />
: Serialize circle object.<br />
Arguments:<br />
: circle<br />
:: Circle object to serialize.<br />
: serializedData_1<br />
:: Return first part of serialized circle data.<br />
: serializedData_2<br />
:: Return second part of serialized circle data.<br />
<br />
====Physics_Overlap====<br />
Syntax:<br />
Physics_Overlap(overlap, positionDifference, distance)<br />
Description:<br />
: Returns the distance by which objects overlap.<br />
Arguments:<br />
: overlap<br />
:: Half distance between two points.<br />
: positionDifference<br />
:: Position difference between two point in one axis. Example - first point position X is 10, second is 6. Then position difference is 10-6=4.<br />
: distance<br />
:: Distance between two points.<br />
<br />
====Examples====<br />
1. Create circle object.<br />
<br />
new ball_1[PHYSICS_CIRCLE_DATA];<br />
ball_1.posX = 180 << 8;<br />
ball_1.posY = 180 << 8;<br />
ball_1.simplePosX = 200;<br />
ball_1.simplePosY = 180;<br />
ball_1.spdX = -155;<br />
ball_1.spdY = -155;<br />
ball_1.mass = 5 << 8;<br />
ball_1.radius = 16;<br />
ball_1.cube = 0;<br />
ball_1.face = 0;<br />
ball_1.CoR = 150;<br />
<br />
2. Check collision of two circles and resolve it.<br />
<br />
if (Physics_Circle_Vs_Circle_obj(ball_1, ball_2)) {<br />
// Resolve collision<br />
Physics_Res_CvC_Coll_Massless(ball_1, ball_2);<br />
}<br />
<br />
3. Check collision of circle versus rectangle and resolve it.<br />
<br />
new fakeCircle[PHYSICS_CIRCLE_DATA];<br />
if (Physics_Circle_vs_AABB_obj(ball, rectanglePosX, rectanglePosY, rectangleWidth, rectangleHeight, fakeCircle)) {<br />
// Resolve collision <br />
Physics_Res_CvC_Coll_Mass(ball, fakeCircle);<br />
}<br />
<br />
4. Sending and receiving circle object.<br />
<br />
// Sending message with ball object<br />
SendBall (const pktNumber) {<br />
new data[4];<br />
new serializedData_1, serializedData_2;<br />
// Serialize 'ball' data<br />
Physics_SerializeCircle(ball, serializedData_1, serializedData_2);<br />
// Prepare message<br />
data[0] = P2P_CMD_SEND_BALL;<br />
data[1] = serializedData_1;<br />
data[2] = serializedData_2;<br />
data[3] = pktNumber;<br />
// Broadcast message<br />
abi_CMD_NET_TX(0, NET_BROADCAST_TTL_MAX, data);<br />
abi_CMD_NET_TX(1, NET_BROADCAST_TTL_MAX, data);<br />
abi_CMD_NET_TX(2, NET_BROADCAST_TTL_MAX, data);<br />
}<br />
<br />
// Receiving message with ball object<br />
case P2P_CMD_SEND_BALL: {<br />
new packetNumberReceived = pkt[4];<br />
if ((ballPacketNumber < packetNumberReceived) || ((ballPacketNumber - packetNumberReceived) > (0x7FFFFFFF >> 1))) {<br />
ballPacketNumber = packetNumberReceived;<br />
Physics_DeserializeCircle(pkt[2], pkt[3], ball);<br />
}<br />
}</div>Raccoon piratehttps://wiki.wowcube.com/index.php?title=API&diff=16505API2022-02-11T06:47:09Z<p>Raccoon pirate: /* Examples */</p>
<hr />
<div>{{notice|This is a beta version, API changes can be made without warning.}}<br />
<br />
=Introduction=<br />
<br />
The main functions of the API are listed here, the features of the work of the environment are described<br />
<br />
==WOWCube Paradigms==<br />
<br />
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.<br />
<br />
==Pawn API==<br />
===Graphic functions===<br />
<br />
====Graphics 2D acceleration (G2D)====<br />
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:<br />
[[File:Cascade.png|center|G2D cascading scheme]]<br />
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.<br />
Basic coordinate principle:<br />
[[File:G2d_coordinates.png|center|G2D coordinates sceme]]<br />
Coordinates are limited from -2048 to 2047. Maximum layers size is 240x240.<br />
<br />
=====abi_CMD_G2D_BEGIN_BITMAP=====<br />
Syntax:<br />
abi_CMD_G2D_BEGIN_BITMAP(const resID, const width, const height, const bool:replace)<br />
Description:<br />
: 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.<br />
Arguments:<br />
: ''resID''<br />
:: 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.<br />
: ''width'' <br />
:: Width of the resulting resource. G2D engine can keep resource of 240px width maximum.<br />
: ''height'' <br />
:: Height of the resulting resource. G2D engine can keep resource of 240px height maximum.<br />
: ''replace'' <br />
:: If true, then an existing image will be replaced completely, otherwise it will be overwritten by reusing itself as a background layer.<br />
<br />
=====abi_CMD_G2D_BEGIN_DISPLAY=====<br />
Syntax:<br />
abi_CMD_G2D_BEGIN_DISPLAY(const display, const bool:replace)<br />
Description:<br />
: 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.<br />
Arguments:<br />
: ''display''<br />
:: ID of the display which framebuffer will be used for blending. Each module have 3 displays with ID starting from 0.<br />
: ''replace'' <br />
:: If true then an existing image will be replaced completely, otherwise it will be overwritten by reusing itself as a background layer.<br />
<br />
=====abi_CMD_G2D_ADD_SPRITE=====<br />
Syntax:<br />
abi_CMD_G2D_ADD_SPRITE(const resID, const bool:g2d, const x, const y, const alpha, const color, const rotation, const mirror)<br />
Description:<br />
: Specifies game resource which will be used as a layer for blending.<br />
Arguments:<br />
: ''resID''<br />
:: ID of the resource to be uses as a layer.<br />
: ''g2d''<br />
:: Indicates if an internal G2D resource is specified or not.<br />
: ''x'', ''y''<br />
:: Coordinates of the bitmap center to place on the layer.<br />
: ''alpha''<br />
:: Layer transparency in range between 0x00 and 0xFF, where 0x00 is a fully transparent layer.<br />
: ''color''<br />
:: Layer's source key - a color in ARGB8888 format to be avoided.<br />
: ''rotation''<br />
:: Clockwise rotation angle in degrees. It is possible to specify free angle, but only right angles have HW acceleration. Currently rotation only applicable for external resources.<br />
: ''mirror''<br />
:: Mirroring variant. Possible values are self-explained: MIRROR_BLANK, MIRROR_X, MIRROR_Y, MIRROR_XY.<br />
<br />
=====abi_CMD_G2D_ADD_RECTANGLE=====<br />
Syntax:<br />
abi_CMD_G2D_ADD_RECTANGLE(const x, const y, const width, const height, const color)<br />
Description:<br />
: 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.<br />
Arguments:<br />
: ''x'', ''y''<br />
:: Coordinates of top left rectangle corner.<br />
: ''width''<br />
:: Rectangle width.<br />
: ''height''<br />
:: Rectangle height.<br />
: ''color''<br />
:: Rectangle color in ARGB8888 format.<br />
<br />
=====abi_CMD_G2D_END=====<br />
Syntax:<br />
abi_CMD_G2D_END()<br />
Description:<br />
: 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.<br />
<br />
=====Examples=====<br />
1. Render into inner G2D resource buffer #face and display it on the display #face. Please, note that last argument of abi_CMD_BITMAP is a `true` flag, which means G2D resource should be used:<br />
...<br />
abi_CMD_G2D_BEGIN_BITMAP(face, 240, 240, true);<br />
abi_CMD_G2D_ADD_RECTANGLE(120 - animationSquareSize0, 120 - animationSquareSize0, animationSquareSize0 * 2, animationSquareSize0 * 2, 0xdfff0000);<br />
abi_CMD_G2D_ADD_RECTANGLE(120 - animationSquareSize1, 120 - animationSquareSize1, animationSquareSize1 * 2, animationSquareSize1 * 2, 0xdfffff00);<br />
abi_CMD_G2D_ADD_RECTANGLE(120 - animationSquareSize2, 120 - animationSquareSize2, animationSquareSize2 * 2, animationSquareSize2 * 2, 0xdfff00ff);<br />
abi_CMD_G2D_ADD_RECTANGLE(120 - animationSquareSize3, 120 - animationSquareSize3, animationSquareSize3 * 2, animationSquareSize3 * 2, 0xdf00ffff);<br />
abi_CMD_G2D_ADD_SPRITE(resID, false, 120, 120, animationAlpha, 0x00000000, animationAngle, MIRROR_BLANK);<br />
abi_CMD_G2D_END();<br />
...<br />
abi_CMD_BITMAP(face, 120, 120, 0, MIRROR_BLANK, true);<br />
...<br />
abi_CMD_REDRAW(face);<br />
...<br />
2. Render directly into display framebuffer #face. This will produce same result on display as example #1, but the generated image is not saved:<br />
...<br />
abi_CMD_G2D_BEGIN_DISPLAY(face, true);<br />
abi_CMD_G2D_ADD_RECTANGLE(120 - animationSquareSize0, 120 - animationSquareSize0, animationSquareSize0 * 2, animationSquareSize0 * 2, 0xdfff0000);<br />
abi_CMD_G2D_ADD_RECTANGLE(120 - animationSquareSize1, 120 - animationSquareSize1, animationSquareSize1 * 2, animationSquareSize1 * 2, 0xdfffff00);<br />
abi_CMD_G2D_ADD_RECTANGLE(120 - animationSquareSize2, 120 - animationSquareSize2, animationSquareSize2 * 2, animationSquareSize2 * 2, 0xdfff00ff);<br />
abi_CMD_G2D_ADD_RECTANGLE(120 - animationSquareSize3, 120 - animationSquareSize3, animationSquareSize3 * 2, animationSquareSize3 * 2, 0xdf00ffff);<br />
abi_CMD_G2D_ADD_SPRITE(resID, false, 120, 120, animationAlpha, 0x00000000, animationAngle, MIRROR_BLANK);<br />
abi_CMD_G2D_END();<br />
...<br />
<br />
====Font drawing functions====<br />
=====abi_CMD_TEXT=====<br />
API:<br />
abi_CMD_TEXT(const text[], const fontResID, const x, const y, const scale, const angle, const r, const g, const b)<br />
Description:<br />
: Intended to render a system font or a custom font from resources with specified coordinates, scale and rotation at an arbitrary angle.<br />
Arguments:<br />
: ''text''<br />
:: Array of chars.<br />
: ''fontResID''<br />
:: Custom font resource identifier. Provide ''-1'' to use system font resource.<br />
: ''x'', ''y''<br />
:: Coordinates of top left rectangle corner.<br />
: ''scale'', ''angle''<br />
:: Percentage scale and clockwise rotation angle in degrees. Max size of font is 200x200 px. (scale = 100%)<br />
: ''r'', ''g'', ''b''<br />
:: Font color in RGB format.<br />
<br />
Example:<br />
new text[4] = ['A', 'p', 'p', '\0'];<br />
abi_CMD_TEXT(text, RES_ID_FONT, 90, 160, 16, current_angles[face], 255, 0, 0);<br />
<br />
====TEXTURE drawing functions====<br />
=====abi_CMD_DYNAMIC_TEXTURE=====<br />
<br />
API:<br />
<br />
abi_CMD_DYNAMIC_TEXTURE(const effectId = 1, const time = any value, const args[] = {0x04030201, 0x08070605, 0x00000A09}, const argsCount = 3, const bool:g2d = false)<br />
<br />
Description:<br />
: Render a texture with chosen algorithm and parameters.<br />
Arguments:<br />
: ''effectId''<br />
:: Define algorithm to render texture. <br />
:: Available values : G2D_DYNAMIC_TEXTURE_MOSAIC <br />
<br />
: ''time ''<br />
:: Current time value. Use any fixed value to static texture or set current time value in milliseconds to make texture alive.<br />
: ''args'', ''argsCount''<br />
:: Byte stream of algorithm settings it's aligned to 4 bytes, because of pawn supports only 32-bit values.<br />
:: Size of array depends on algorithm. For example mosaic algorithm has size of settings equals 10 bytes , so we must use aligned 4 bytes - 12 bytes array and argsCount = 3<br />
<br />
: ''g2d''<br />
:: false - Use pawn default buffer to draw texture.<br />
:: true - Use g2d buffer to draw texture - not supported now.<br />
<br />
'''G2D_DYNAMIC_TEXTURE_MOSAIC''' alogrithm description<br />
<br />
:So in effect named 'mosaic' we have settings of 10 parameters each one 1 byte<br />
<br />
:Noise factors :<br />
::factor x : values from 0 to 10<br />
::factor y : values from 0 to 10<br />
::factor xy : values from 0 to 10<br />
:Time factors :<br />
::factor x : values from 0 to 10<br />
::factor y : values from 0 to 10<br />
::factor xy : values from 0 to 10<br />
:Color factors :<br />
::r : values from 0 to 10<br />
::g : values from 0 to 10<br />
::b : values from 0 to 10<br />
:Zoom factor :<br />
::zoom values from 0 to 10<br />
<br />
For example we want to set all parameters above with values in order 1,2,3,4,5,6,7,8,9,10. Take in attention that each parameter is 1 byte we must make array of 32-bit values<br />
0x04030201, 0x08070605, 0x00000A09<br />
<br />
Example:<br />
mosaic_effect_settings = { 0x04030201, 0x08070605, 0x00000A09 };<br />
mosaic_effect_settings_length = 3;<br />
abi_CMD_DYNAMIC_TEXTURE(G2D_DYNAMIC_TEXTURE_MOSAIC , currentTime, mosaic_effect_settings, mosaic_effect_settings_length);<br />
<br />
===Motion sensors===<br />
====abi_MTD_GetFaceAccel(X/Y/Z)====<br />
Syntax:<br />
abi_MTD_GetFaceAccelX(const faceN)<br />
abi_MTD_GetFaceAccelY(const faceN)<br />
abi_MTD_GetFaceAccelZ(const faceN)<br />
Description:<br />
: Get the value of acceleration along the requested axis.<br />
Arguments<br />
: ''faceN''<br />
:: Number of the module face for which requested axis is belong.<br />
<br />
====abi_MTD_GetFaceGyro(X/Y/Z)====<br />
Syntax:<br />
abi_MTD_GetFaceGyroX(const faceN)<br />
abi_MTD_GetFaceGyroY(const faceN)<br />
abi_MTD_GetFaceGyroZ(const faceN)<br />
Description:<br />
: Get the gyro value around the requested axis.<br />
Arguments<br />
: ''faceN''<br />
:: Number of the module face for which requested axis is belong.<br />
<br />
====abi_MTD_GetTapFace====<br />
Syntax:<br />
abi_MTD_GetTapFace()<br />
Description:<br />
: Get the face ID which was tapped. ID is not a face number which is used for drawing in abi_CMD_G2D_BEGIN_DISPLAY or abi_CMD_REDRAW, but that number can be calculated by subtracting by one from ID value. See possible values below.<br />
Return values:<br />
: ''MTD_TAP_DIRECTION_NONE = 0''<br />
:: Indicates that the module wan not tapped.<br />
: ''MTD_TAP_DIRECTION_X = 1''<br />
: ''MTD_TAP_DIRECTION_Y = 2''<br />
: ''MTD_TAP_DIRECTION_Z = 3''<br />
:: Indicated direction of tap.<br />
<br />
====abi_MTD_IsTapOpposite====<br />
Syntax:<br />
abi_MTD_IsTapOpposite()<br />
Description:<br />
: Get the flag if the tap was detected in opposite direction.<br />
<br />
====abi_MTD_GetTapsCount====<br />
Syntax:<br />
abi_MTD_GetTapsCount()<br />
Description:<br />
: Get the count of subsequent taps. Tap is treated as a subsequent if it was detected within predefined interval (350ms). Count will be zero until sequence is finished, i.e. next tap is not detected within interval.<br />
<br />
====abi_checkShake====<br />
Syntax:<br />
abi_checkShake()<br />
Description:<br />
: Checks if the number of shakes of the cube was more than a certain threshold then exits the script <br />
<br />
<br />
====Examples====<br />
1. Flash the face on which tap was detected. Print an ID of that face. Color of the flash depends on taps count: red - one tap, green - two taps and blue - three.<br />
new delay = 0;<br />
new color = 0x000000; <br />
ONTICK() {<br />
if (!color) {<br />
switch (abi_MTD_GetTapsCount()) {<br />
case 1:<br />
color = 0xff0000;<br />
case 2:<br />
color = 0x00ff00;<br />
case 3:<br />
color = 0x0000ff;<br />
}<br />
}<br />
if (delay % 25 == 0) {<br />
for (new i = 0; i < FACES_MAX; i++) {<br />
if (i == (abi_MTD_GetTapFace() - 1)) {<br />
abi_CMD_FILL_2(color);<br />
color = 0x000000;<br />
switch (abi_MTD_GetTapFace()) {<br />
case 1:<br />
abi_CMD_TEXT(['1', '\0'], -1, 120, 120, 14, 0, 0xff, 0xff, 0xff);<br />
case 2:<br />
abi_CMD_TEXT(['2', '\0'], -1, 120, 120, 14, 0, 0xff, 0xff, 0xff);<br />
case 3:<br />
abi_CMD_TEXT(['3', '\0'], -1, 120, 120, 14, 0, 0xff, 0xff, 0xff);<br />
}<br />
} else {<br />
abi_CMD_FILL(0, 0, 0);<br />
}<br />
abi_CMD_REDRAW(i);<br />
}<br />
}<br />
delay++;<br />
}<br />
2. Exit from script<br />
ONTICK() {<br />
if (abi_cubeN == 0) {<br />
abi_checkShake();<br />
}<br />
// Script logic<br />
}<br />
<br />
===Save/load functions===<br />
<br />
====abi_CMD_SAVE_STATE====<br />
Syntax:<br />
bool:abi_CMD_SAVE_STATE(const data[], size = sizeof(data))<br />
Description:<br />
: Save maximum 256 bytes of data to wowcube flash memory.<br />
Arguments<br />
: ''data''<br />
:: Game data to save.<br />
: ''size''<br />
:: Size of game data.<br />
Return values:<br />
: ''return false''<br />
:: If size is bigger then 256 bytes.<br />
<br />
====abi_CMD_LOAD_STATE====<br />
Syntax:<br />
abi_CMD_LOAD_STATE()<br />
Description:<br />
: Sends a command requesting the platform to load script data. The response from the platform is not instantaneous and takes several milliseconds.<br />
<br />
====Examples====<br />
1. Load data at the start.<br />
// This function is called when a response is received from the platform<br />
ON_LOAD_GAME_DATA (const pkt[]) {<br />
// Deserialize pkt<br />
currentLevelNumber = pkt[1]; // Starting with 1 cause 0 pkt element holding command ID<br />
score = pkt[2];<br />
moves = pkt[3];<br />
...<br />
record = pkt[GAME_SAVE_SIZE];<br />
}<br />
ON_INIT () {<br />
abi_CMD_LOAD_STATE ();<br />
}<br />
<br />
2. Save the data after the end of the level.<br />
SaveGameState () {<br />
new saveData [GAME_SAVE_SIZE];<br />
// Assign all necessary data<br />
saveData[0] = currentLevelNumber;<br />
saveData[1] = score;<br />
saveData[2] = moves;<br />
...<br />
saveData[GAME_SAVE_SIZE - 1] = record;<br />
<br />
abi_CMD_SAVE_STATE (saveData);<br />
}<br />
ON_CHECK_ROTATE () {<br />
if (isLevelFinished) {<br />
SaveGameState();<br />
}<br />
}<br />
<br />
===Time functions===<br />
====abi_GetTime====<br />
Syntax:<br />
abi_GetTime()<br />
Description:<br />
: Get current time in milliseconds.<br />
<br />
====Examples====<br />
new previousTime = 0;<br />
new currentTime = 0;<br />
new deltaTime = 0;<br />
ON_INIT() {<br />
previousTime = abi_GetTime();<br />
}<br />
ONTICK() {<br />
currentTime = abi_GetTime();<br />
deltaTime = currentTime - previousTime;<br />
previousTime = currentTime;<br />
}<br />
<br />
<br />
===Topology functions===<br />
====get cube/face====<br />
Syntax:<br />
abi_topCubeN(const _cubeN, const _faceN)<br />
abi_topFaceN(const _cubeN, const _faceN)<br />
abi_rightCubeN(const _cubeN, const _faceN)<br />
abi_rightFaceN(const _cubeN, const _faceN)<br />
abi_bottomCubeN(const _cubeN, const _faceN)<br />
abi_bottomFaceN(const _cubeN, const _faceN)<br />
abi_leftCubeN(const _cubeN, const _faceN)<br />
abi_leftFaceN(const _cubeN, const _faceN)<br />
Description:<br />
: Returns the cube / screen located at the top / bottom / left / right of the specified in parameters.<br />
<br />
====Examples====<br />
Find diagonal face and cube<br />
new diagonalCube = CUBES_MAX;<br />
new diagonalFace = FACES_MAX;<br />
new topCube = abi_topCubeN(cube, face);<br />
new topFace = abi_topFaceN(cube, face);<br />
if (topCube < CUBES_MAX) {<br />
diagonalCube = abi_topCubeN(topCube, topFace);<br />
if (diagonalCube < CUBES_MAX) {<br />
diagonalFace = abi_topFaceN(topCube, topFace);<br />
}<br />
}<br />
<br />
<br />
===Sound functions===<br />
====abi_CMD_PLAYSND====<br />
Syntax:<br />
abi_CMD_PLAYSND(const id, const volume)<br />
Description:<br />
: Play chosen sound with a given volume.<br />
Arguments<br />
: ''id''<br />
:: Sound serial number in the application package.<br />
: ''volume''<br />
:: The sound volume.<br />
<br />
<br />
===Messages===<br />
====abi_CMD_NET_TX====<br />
Syntax:<br />
abi_CMD_NET_TX(const line_tx, const TTL, const data[])<br />
Description:<br />
: Send data through given UART line with given TTL.<br />
Arguments<br />
: ''line_tx''<br />
:: UART line for sending a message. Each module has 3 UART lines.<br />
: ''TTL''<br />
:: Message time to live. How many modules message will pass through before stopping. For example, set TTL to 0 message will transfer only to the neighbor module. Set TTL to 1 message will transfer to a neighbor of neighbor. Maximum TTL is 2.<br />
: ''data''<br />
:: Data array to send. Maximum can be sent 20 bytes. The first 4 bytes are message general information that automatically adds before sending. The maximum useful data that can be sent are 16 bytes. Taking into account net command name 15 bytes.<br />
<br />
====Examples====<br />
We want to receive data only from 0 module<br />
<br />
// define net command<br />
#define NEW_TEST_NET_COMMAND P2P_CMD_BASE_SCRIPT_1 + 1<br />
<br />
// create message to send<br />
Send_Test_Message() {<br />
new data[4];<br />
data[0] = NEW_TEST_NET_COMMAND | (abi_cubeN << 8);<br />
data[1] = add_game_data;<br />
// using bitwise operations send more data<br />
data[2] = add_script_data_1 | (add_script_data_2 << 8) | (add_script_data_3 << 16) | (add_script_data_4 << 24);<br />
data[3] = add_game_data_1 | (add_game_data_2 << 16);<br />
<br />
// send message through UART<br />
abi_CMD_NET_TX(0, NET_BROADCAST_TTL_MAX, data);<br />
abi_CMD_NET_TX(1, NET_BROADCAST_TTL_MAX, data);<br />
abi_CMD_NET_TX(2, NET_BROADCAST_TTL_MAX, data);<br />
}<br />
<br />
// process the received message<br />
ON_CMD_NET_RX (const pkt[]) {<br />
// get 4 byte from incoming packet to get net command because first 4 bytes are general info<br />
switch (abi_ByteN(pkt, 4)) {<br />
case NEW_TEST_NET_COMMAND: {<br />
if (abi_ByteN(pkt, 5) == 0) {<br />
game_data = pkt[2];<br />
script_data_1 = abi_ByteN(pkt, 12);<br />
script_data_2 = abi_ByteN(pkt, 13);<br />
script_data_3 = abi_ByteN(pkt, 14);<br />
script_data_4 = abi_ByteN(pkt, 15);<br />
game_data_1 = pkt[4] & 0xFFFF;<br />
game_data_2 = (pkt[4] >> 16) & 0xFFFF;<br />
}<br />
}<br />
}<br />
}<br />
<br />
===Physics functions===<br />
====PHYSICS_CIRCLE_DATA====<br />
Syntax:<br />
#define PHYSICS_CIRCLE_DATA .posX, .posY, .simplePosX, .simplePosY, .spdX, .spdY, .mass, .radius, .CoR, .cube, .face, .cubeT, .faceT<br />
Description:<br />
: PAWN symbolic subscript which represent stucture.<br />
Fields<br />
: ''posX''<br />
:: Circle position on X axis (fixed point)<br />
: ''posY''<br />
:: Circle position on Y axis (fixed point)<br />
: ''simplePosX''<br />
:: Circle position on X axis<br />
: ''simplePosY''<br />
:: Circle position on Y axis<br />
: ''spdX''<br />
:: Circle X speed<br />
: ''spdY''<br />
:: Circle Y speed<br />
: ''mass''<br />
:: Circle mass (fixed point)<br />
: ''radius''<br />
:: Circle radius<br />
: ''CoR''<br />
:: Coefficient of restitution (fixed point)<br />
: ''cube''<br />
:: Module owner of this circle<br />
: ''face''<br />
:: Face owner of this circle<br />
: ''cubeT''<br />
:: Cube transfer, last module owner. Can be used for resending messages<br />
: ''faceT''<br />
:: Face transfer, last face owner. Can be used for resending messages<br />
<br />
====Physics_Circle_Vs_Circle_obj====<br />
Syntax:<br />
Physics_Circle_Vs_Circle_obj(circle1[PHYSICS_CIRCLE_DATA], circle2[PHYSICS_CIRCLE_DATA])<br />
Description:<br />
: Check circle versus circle collision.<br />
Arguments:<br />
: circle1<br />
:: First circle object.<br />
: circle2<br />
:: Second circle object.<br />
<br />
====Physics_Circle_vs_AABB_obj====<br />
Syntax:<br />
Physics_Circle_vs_AABB_obj(circle[PHYSICS_CIRCLE_DATA], rectX, rectY, rectWidth, rectHeight, fakeCircle[PHYSICS_CIRCLE_DATA] = 0)<br />
Description:<br />
: Check circle versus rectangle collision.<br />
Arguments:<br />
: circle<br />
:: Circle object.<br />
: rectX<br />
:: Rectangle X coordinate.<br />
: rectY<br />
:: Rectangle Y coordinate.<br />
: rectWidth<br />
:: Rectangle width.<br />
: rectHeight<br />
:: Rectangle height.<br />
: fakeCircle<br />
:: In case of collision returns the collision point.<br />
<br />
====Physics_Circle_Vs_LineSegment====<br />
Syntax:<br />
Physics_Circle_Vs_LineSegment(circle[PHYSICS_CIRCLE_DATA], lineSX, lineSY, lineEX, lineEY, fakeCircle[PHYSICS_CIRCLE_DATA] = 0)<br />
Description:<br />
: Check circle versus line segment collision.<br />
Arguments:<br />
: circle<br />
:: Circle object.<br />
: lineSX<br />
:: Line start X coordinates.<br />
: lineSY<br />
:: Line start Y coordinate.<br />
: lineEX<br />
:: Line end X coordinate.<br />
: lineEY<br />
:: Line end Y coordinate.<br />
: fakeCircle<br />
:: In case of collision returns the collision point.<br />
<br />
====Physics_Res_CvC_Coll_Massless====<br />
Syntax:<br />
Physics_Res_CvC_Coll_Massless(circle1[PHYSICS_CIRCLE_DATA], circle2[PHYSICS_CIRCLE_DATA])<br />
Description:<br />
: Collision resolves without using object mass.<br />
Arguments:<br />
: circle1<br />
:: First circle object.<br />
: circle2<br />
:: Second circle object.<br />
<br />
====Physics_Res_CvC_Coll_Mass====<br />
Syntax:<br />
Physics_Res_CvC_Coll_Mass(circle1[PHYSICS_CIRCLE_DATA], circle2[PHYSICS_CIRCLE_DATA])<br />
Description:<br />
: Resolves collision using object mass.<br />
Arguments:<br />
: circle1<br />
:: First circle object.<br />
: circle2<br />
:: Second circle object.<br />
<br />
====Physics_DeserializeCircle====<br />
Syntax:<br />
Physics_DeserializeCircle(serializedData_1, serializedData_2, circle[PHYSICS_CIRCLE_DATA])<br />
Description:<br />
: Deserialize circle object.<br />
Arguments:<br />
: serializedData_1<br />
:: First part of serialized circle data.<br />
: serializedData_2<br />
:: Second part of serialized circle data.<br />
: circle<br />
:: Circle object where need to save deserialized data.<br />
<br />
====Physics_SerializeCircle====<br />
Syntax:<br />
Physics_SerializeCircle(obj[PHYSICS_CIRCLE_DATA], &serializedData_1, &serializedData_2)<br />
Description:<br />
: Serialize circle object.<br />
Arguments:<br />
: circle<br />
:: Circle object to serialize.<br />
: serializedData_1<br />
:: Return first part of serialized circle data.<br />
: serializedData_2<br />
:: Return second part of serialized circle data.<br />
<br />
====Physics_Overlap====<br />
Syntax:<br />
Physics_Overlap(overlap, positionDifference, distance)<br />
Description:<br />
: Returns the distance by which objects overlap.<br />
Arguments:<br />
: overlap<br />
:: Half distance between two points.<br />
: positionDifference<br />
:: Position difference between two point in one axis. Example - first point position X is 10, second is 6. Then position difference is 10-6=4.<br />
: distance<br />
:: Distance between two points.<br />
<br />
====Examples====<br />
1. Create circle object.<br />
<br />
new ball_1[PHYSICS_CIRCLE_DATA];<br />
ball_1.posX = 180 << 8;<br />
ball_1.posY = 180 << 8;<br />
ball_1.simplePosX = 200;<br />
ball_1.simplePosY = 180;<br />
ball_1.spdX = -155;<br />
ball_1.spdY = -155;<br />
ball_1.mass = 5 << 8;<br />
ball_1.radius = 16;<br />
ball_1.cube = 0;<br />
ball_1.face = 0;<br />
ball_1.CoR = 150;<br />
<br />
2. Check collision of two circles and resolve it.<br />
<br />
if (Physics_Circle_Vs_Circle_obj(ball_1, ball_2)) {<br />
// Resolve collision<br />
Physics_Res_CvC_Coll_Massless(ball_1, ball_2);<br />
}<br />
<br />
3. Check collision of circle versus rectangle and resolve it.<br />
<br />
new fakeCircle[PHYSICS_CIRCLE_DATA];<br />
if (Physics_Circle_vs_AABB_obj(ball, rectanglePosX, rectanglePosY, rectangleWidth, rectangleHeight, fakeCircle)) {<br />
// Resolve collision <br />
Physics_Res_CvC_Coll_Mass(ball, fakeCircle);<br />
}<br />
<br />
4. Sending and receiving circle object.<br />
<br />
// Sending message with ball object<br />
SendBall (const pktNumber) {<br />
new data[4];<br />
new serializedData_1, serializedData_2;<br />
// Serialize 'ball' data<br />
Physics_SerializeCircle(ball, serializedData_1, serializedData_2);<br />
// Prepare message<br />
data[0] = P2P_CMD_SEND_BALL;<br />
data[1] = serializedData_1;<br />
data[2] = serializedData_2;<br />
data[3] = pktNumber;<br />
// Broadcast message<br />
abi_CMD_NET_TX(0, NET_BROADCAST_TTL_MAX, data);<br />
abi_CMD_NET_TX(1, NET_BROADCAST_TTL_MAX, data);<br />
abi_CMD_NET_TX(2, NET_BROADCAST_TTL_MAX, data);<br />
}<br />
<br />
// Receiving message with ball object<br />
case P2P_CMD_SEND_BALL: {<br />
new packetNumberReceived = pkt[4];<br />
if ((ballPacketNumber < packetNumberReceived) || ((ballPacketNumber - packetNumberReceived) > (0x7FFFFFFF >> 1))) {<br />
ballPacketNumber = packetNumberReceived;<br />
Physics_DeserializeCircle(pkt[2], pkt[3], ball);<br />
}<br />
}</div>Raccoon piratehttps://wiki.wowcube.com/index.php?title=API&diff=16504API2022-02-10T13:48:12Z<p>Raccoon pirate: /* Physics functions */</p>
<hr />
<div>{{notice|This is a beta version, API changes can be made without warning.}}<br />
<br />
=Introduction=<br />
<br />
The main functions of the API are listed here, the features of the work of the environment are described<br />
<br />
==WOWCube Paradigms==<br />
<br />
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.<br />
<br />
==Pawn API==<br />
===Graphic functions===<br />
<br />
====Graphics 2D acceleration (G2D)====<br />
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:<br />
[[File:Cascade.png|center|G2D cascading scheme]]<br />
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.<br />
Basic coordinate principle:<br />
[[File:G2d_coordinates.png|center|G2D coordinates sceme]]<br />
Coordinates are limited from -2048 to 2047. Maximum layers size is 240x240.<br />
<br />
=====abi_CMD_G2D_BEGIN_BITMAP=====<br />
Syntax:<br />
abi_CMD_G2D_BEGIN_BITMAP(const resID, const width, const height, const bool:replace)<br />
Description:<br />
: 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.<br />
Arguments:<br />
: ''resID''<br />
:: 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.<br />
: ''width'' <br />
:: Width of the resulting resource. G2D engine can keep resource of 240px width maximum.<br />
: ''height'' <br />
:: Height of the resulting resource. G2D engine can keep resource of 240px height maximum.<br />
: ''replace'' <br />
:: If true, then an existing image will be replaced completely, otherwise it will be overwritten by reusing itself as a background layer.<br />
<br />
=====abi_CMD_G2D_BEGIN_DISPLAY=====<br />
Syntax:<br />
abi_CMD_G2D_BEGIN_DISPLAY(const display, const bool:replace)<br />
Description:<br />
: 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.<br />
Arguments:<br />
: ''display''<br />
:: ID of the display which framebuffer will be used for blending. Each module have 3 displays with ID starting from 0.<br />
: ''replace'' <br />
:: If true then an existing image will be replaced completely, otherwise it will be overwritten by reusing itself as a background layer.<br />
<br />
=====abi_CMD_G2D_ADD_SPRITE=====<br />
Syntax:<br />
abi_CMD_G2D_ADD_SPRITE(const resID, const bool:g2d, const x, const y, const alpha, const color, const rotation, const mirror)<br />
Description:<br />
: Specifies game resource which will be used as a layer for blending.<br />
Arguments:<br />
: ''resID''<br />
:: ID of the resource to be uses as a layer.<br />
: ''g2d''<br />
:: Indicates if an internal G2D resource is specified or not.<br />
: ''x'', ''y''<br />
:: Coordinates of the bitmap center to place on the layer.<br />
: ''alpha''<br />
:: Layer transparency in range between 0x00 and 0xFF, where 0x00 is a fully transparent layer.<br />
: ''color''<br />
:: Layer's source key - a color in ARGB8888 format to be avoided.<br />
: ''rotation''<br />
:: Clockwise rotation angle in degrees. It is possible to specify free angle, but only right angles have HW acceleration. Currently rotation only applicable for external resources.<br />
: ''mirror''<br />
:: Mirroring variant. Possible values are self-explained: MIRROR_BLANK, MIRROR_X, MIRROR_Y, MIRROR_XY.<br />
<br />
=====abi_CMD_G2D_ADD_RECTANGLE=====<br />
Syntax:<br />
abi_CMD_G2D_ADD_RECTANGLE(const x, const y, const width, const height, const color)<br />
Description:<br />
: 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.<br />
Arguments:<br />
: ''x'', ''y''<br />
:: Coordinates of top left rectangle corner.<br />
: ''width''<br />
:: Rectangle width.<br />
: ''height''<br />
:: Rectangle height.<br />
: ''color''<br />
:: Rectangle color in ARGB8888 format.<br />
<br />
=====abi_CMD_G2D_END=====<br />
Syntax:<br />
abi_CMD_G2D_END()<br />
Description:<br />
: 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.<br />
<br />
=====Examples=====<br />
1. Render into inner G2D resource buffer #face and display it on the display #face. Please, note that last argument of abi_CMD_BITMAP is a `true` flag, which means G2D resource should be used:<br />
...<br />
abi_CMD_G2D_BEGIN_BITMAP(face, 240, 240, true);<br />
abi_CMD_G2D_ADD_RECTANGLE(120 - animationSquareSize0, 120 - animationSquareSize0, animationSquareSize0 * 2, animationSquareSize0 * 2, 0xdfff0000);<br />
abi_CMD_G2D_ADD_RECTANGLE(120 - animationSquareSize1, 120 - animationSquareSize1, animationSquareSize1 * 2, animationSquareSize1 * 2, 0xdfffff00);<br />
abi_CMD_G2D_ADD_RECTANGLE(120 - animationSquareSize2, 120 - animationSquareSize2, animationSquareSize2 * 2, animationSquareSize2 * 2, 0xdfff00ff);<br />
abi_CMD_G2D_ADD_RECTANGLE(120 - animationSquareSize3, 120 - animationSquareSize3, animationSquareSize3 * 2, animationSquareSize3 * 2, 0xdf00ffff);<br />
abi_CMD_G2D_ADD_SPRITE(resID, false, 120, 120, animationAlpha, 0x00000000, animationAngle, MIRROR_BLANK);<br />
abi_CMD_G2D_END();<br />
...<br />
abi_CMD_BITMAP(face, 120, 120, 0, MIRROR_BLANK, true);<br />
...<br />
abi_CMD_REDRAW(face);<br />
...<br />
2. Render directly into display framebuffer #face. This will produce same result on display as example #1, but the generated image is not saved:<br />
...<br />
abi_CMD_G2D_BEGIN_DISPLAY(face, true);<br />
abi_CMD_G2D_ADD_RECTANGLE(120 - animationSquareSize0, 120 - animationSquareSize0, animationSquareSize0 * 2, animationSquareSize0 * 2, 0xdfff0000);<br />
abi_CMD_G2D_ADD_RECTANGLE(120 - animationSquareSize1, 120 - animationSquareSize1, animationSquareSize1 * 2, animationSquareSize1 * 2, 0xdfffff00);<br />
abi_CMD_G2D_ADD_RECTANGLE(120 - animationSquareSize2, 120 - animationSquareSize2, animationSquareSize2 * 2, animationSquareSize2 * 2, 0xdfff00ff);<br />
abi_CMD_G2D_ADD_RECTANGLE(120 - animationSquareSize3, 120 - animationSquareSize3, animationSquareSize3 * 2, animationSquareSize3 * 2, 0xdf00ffff);<br />
abi_CMD_G2D_ADD_SPRITE(resID, false, 120, 120, animationAlpha, 0x00000000, animationAngle, MIRROR_BLANK);<br />
abi_CMD_G2D_END();<br />
...<br />
<br />
====Font drawing functions====<br />
=====abi_CMD_TEXT=====<br />
API:<br />
abi_CMD_TEXT(const text[], const fontResID, const x, const y, const scale, const angle, const r, const g, const b)<br />
Description:<br />
: Intended to render a system font or a custom font from resources with specified coordinates, scale and rotation at an arbitrary angle.<br />
Arguments:<br />
: ''text''<br />
:: Array of chars.<br />
: ''fontResID''<br />
:: Custom font resource identifier. Provide ''-1'' to use system font resource.<br />
: ''x'', ''y''<br />
:: Coordinates of top left rectangle corner.<br />
: ''scale'', ''angle''<br />
:: Percentage scale and clockwise rotation angle in degrees. Max size of font is 200x200 px. (scale = 100%)<br />
: ''r'', ''g'', ''b''<br />
:: Font color in RGB format.<br />
<br />
Example:<br />
new text[4] = ['A', 'p', 'p', '\0'];<br />
abi_CMD_TEXT(text, RES_ID_FONT, 90, 160, 16, current_angles[face], 255, 0, 0);<br />
<br />
====TEXTURE drawing functions====<br />
=====abi_CMD_DYNAMIC_TEXTURE=====<br />
<br />
API:<br />
<br />
abi_CMD_DYNAMIC_TEXTURE(const effectId = 1, const time = any value, const args[] = {0x04030201, 0x08070605, 0x00000A09}, const argsCount = 3, const bool:g2d = false)<br />
<br />
Description:<br />
: Render a texture with chosen algorithm and parameters.<br />
Arguments:<br />
: ''effectId''<br />
:: Define algorithm to render texture. <br />
:: Available values : G2D_DYNAMIC_TEXTURE_MOSAIC <br />
<br />
: ''time ''<br />
:: Current time value. Use any fixed value to static texture or set current time value in milliseconds to make texture alive.<br />
: ''args'', ''argsCount''<br />
:: Byte stream of algorithm settings it's aligned to 4 bytes, because of pawn supports only 32-bit values.<br />
:: Size of array depends on algorithm. For example mosaic algorithm has size of settings equals 10 bytes , so we must use aligned 4 bytes - 12 bytes array and argsCount = 3<br />
<br />
: ''g2d''<br />
:: false - Use pawn default buffer to draw texture.<br />
:: true - Use g2d buffer to draw texture - not supported now.<br />
<br />
'''G2D_DYNAMIC_TEXTURE_MOSAIC''' alogrithm description<br />
<br />
:So in effect named 'mosaic' we have settings of 10 parameters each one 1 byte<br />
<br />
:Noise factors :<br />
::factor x : values from 0 to 10<br />
::factor y : values from 0 to 10<br />
::factor xy : values from 0 to 10<br />
:Time factors :<br />
::factor x : values from 0 to 10<br />
::factor y : values from 0 to 10<br />
::factor xy : values from 0 to 10<br />
:Color factors :<br />
::r : values from 0 to 10<br />
::g : values from 0 to 10<br />
::b : values from 0 to 10<br />
:Zoom factor :<br />
::zoom values from 0 to 10<br />
<br />
For example we want to set all parameters above with values in order 1,2,3,4,5,6,7,8,9,10. Take in attention that each parameter is 1 byte we must make array of 32-bit values<br />
0x04030201, 0x08070605, 0x00000A09<br />
<br />
Example:<br />
mosaic_effect_settings = { 0x04030201, 0x08070605, 0x00000A09 };<br />
mosaic_effect_settings_length = 3;<br />
abi_CMD_DYNAMIC_TEXTURE(G2D_DYNAMIC_TEXTURE_MOSAIC , currentTime, mosaic_effect_settings, mosaic_effect_settings_length);<br />
<br />
===Motion sensors===<br />
====abi_MTD_GetFaceAccel(X/Y/Z)====<br />
Syntax:<br />
abi_MTD_GetFaceAccelX(const faceN)<br />
abi_MTD_GetFaceAccelY(const faceN)<br />
abi_MTD_GetFaceAccelZ(const faceN)<br />
Description:<br />
: Get the value of acceleration along the requested axis.<br />
Arguments<br />
: ''faceN''<br />
:: Number of the module face for which requested axis is belong.<br />
<br />
====abi_MTD_GetFaceGyro(X/Y/Z)====<br />
Syntax:<br />
abi_MTD_GetFaceGyroX(const faceN)<br />
abi_MTD_GetFaceGyroY(const faceN)<br />
abi_MTD_GetFaceGyroZ(const faceN)<br />
Description:<br />
: Get the gyro value around the requested axis.<br />
Arguments<br />
: ''faceN''<br />
:: Number of the module face for which requested axis is belong.<br />
<br />
====abi_MTD_GetTapFace====<br />
Syntax:<br />
abi_MTD_GetTapFace()<br />
Description:<br />
: Get the face ID which was tapped. ID is not a face number which is used for drawing in abi_CMD_G2D_BEGIN_DISPLAY or abi_CMD_REDRAW, but that number can be calculated by subtracting by one from ID value. See possible values below.<br />
Return values:<br />
: ''MTD_TAP_DIRECTION_NONE = 0''<br />
:: Indicates that the module wan not tapped.<br />
: ''MTD_TAP_DIRECTION_X = 1''<br />
: ''MTD_TAP_DIRECTION_Y = 2''<br />
: ''MTD_TAP_DIRECTION_Z = 3''<br />
:: Indicated direction of tap.<br />
<br />
====abi_MTD_IsTapOpposite====<br />
Syntax:<br />
abi_MTD_IsTapOpposite()<br />
Description:<br />
: Get the flag if the tap was detected in opposite direction.<br />
<br />
====abi_MTD_GetTapsCount====<br />
Syntax:<br />
abi_MTD_GetTapsCount()<br />
Description:<br />
: Get the count of subsequent taps. Tap is treated as a subsequent if it was detected within predefined interval (350ms). Count will be zero until sequence is finished, i.e. next tap is not detected within interval.<br />
<br />
====abi_checkShake====<br />
Syntax:<br />
abi_checkShake()<br />
Description:<br />
: Checks if the number of shakes of the cube was more than a certain threshold then exits the script <br />
<br />
<br />
====Examples====<br />
1. Flash the face on which tap was detected. Print an ID of that face. Color of the flash depends on taps count: red - one tap, green - two taps and blue - three.<br />
new delay = 0;<br />
new color = 0x000000; <br />
ONTICK() {<br />
if (!color) {<br />
switch (abi_MTD_GetTapsCount()) {<br />
case 1:<br />
color = 0xff0000;<br />
case 2:<br />
color = 0x00ff00;<br />
case 3:<br />
color = 0x0000ff;<br />
}<br />
}<br />
if (delay % 25 == 0) {<br />
for (new i = 0; i < FACES_MAX; i++) {<br />
if (i == (abi_MTD_GetTapFace() - 1)) {<br />
abi_CMD_FILL_2(color);<br />
color = 0x000000;<br />
switch (abi_MTD_GetTapFace()) {<br />
case 1:<br />
abi_CMD_TEXT(['1', '\0'], -1, 120, 120, 14, 0, 0xff, 0xff, 0xff);<br />
case 2:<br />
abi_CMD_TEXT(['2', '\0'], -1, 120, 120, 14, 0, 0xff, 0xff, 0xff);<br />
case 3:<br />
abi_CMD_TEXT(['3', '\0'], -1, 120, 120, 14, 0, 0xff, 0xff, 0xff);<br />
}<br />
} else {<br />
abi_CMD_FILL(0, 0, 0);<br />
}<br />
abi_CMD_REDRAW(i);<br />
}<br />
}<br />
delay++;<br />
}<br />
2. Exit from script<br />
ONTICK() {<br />
if (abi_cubeN == 0) {<br />
abi_checkShake();<br />
}<br />
// Script logic<br />
}<br />
<br />
===Save/load functions===<br />
<br />
====abi_CMD_SAVE_STATE====<br />
Syntax:<br />
bool:abi_CMD_SAVE_STATE(const data[], size = sizeof(data))<br />
Description:<br />
: Save maximum 256 bytes of data to wowcube flash memory.<br />
Arguments<br />
: ''data''<br />
:: Game data to save.<br />
: ''size''<br />
:: Size of game data.<br />
Return values:<br />
: ''return false''<br />
:: If size is bigger then 256 bytes.<br />
<br />
====abi_CMD_LOAD_STATE====<br />
Syntax:<br />
abi_CMD_LOAD_STATE()<br />
Description:<br />
: Sends a command requesting the platform to load script data. The response from the platform is not instantaneous and takes several milliseconds.<br />
<br />
====Examples====<br />
1. Load data at the start.<br />
// This function is called when a response is received from the platform<br />
ON_LOAD_GAME_DATA (const pkt[]) {<br />
// Deserialize pkt<br />
currentLevelNumber = pkt[1]; // Starting with 1 cause 0 pkt element holding command ID<br />
score = pkt[2];<br />
moves = pkt[3];<br />
...<br />
record = pkt[GAME_SAVE_SIZE];<br />
}<br />
ON_INIT () {<br />
abi_CMD_LOAD_STATE ();<br />
}<br />
<br />
2. Save the data after the end of the level.<br />
SaveGameState () {<br />
new saveData [GAME_SAVE_SIZE];<br />
// Assign all necessary data<br />
saveData[0] = currentLevelNumber;<br />
saveData[1] = score;<br />
saveData[2] = moves;<br />
...<br />
saveData[GAME_SAVE_SIZE - 1] = record;<br />
<br />
abi_CMD_SAVE_STATE (saveData);<br />
}<br />
ON_CHECK_ROTATE () {<br />
if (isLevelFinished) {<br />
SaveGameState();<br />
}<br />
}<br />
<br />
===Time functions===<br />
====abi_GetTime====<br />
Syntax:<br />
abi_GetTime()<br />
Description:<br />
: Get current time in milliseconds.<br />
<br />
====Examples====<br />
new previousTime = 0;<br />
new currentTime = 0;<br />
new deltaTime = 0;<br />
ON_INIT() {<br />
previousTime = abi_GetTime();<br />
}<br />
ONTICK() {<br />
currentTime = abi_GetTime();<br />
deltaTime = currentTime - previousTime;<br />
previousTime = currentTime;<br />
}<br />
<br />
<br />
===Topology functions===<br />
====get cube/face====<br />
Syntax:<br />
abi_topCubeN(const _cubeN, const _faceN)<br />
abi_topFaceN(const _cubeN, const _faceN)<br />
abi_rightCubeN(const _cubeN, const _faceN)<br />
abi_rightFaceN(const _cubeN, const _faceN)<br />
abi_bottomCubeN(const _cubeN, const _faceN)<br />
abi_bottomFaceN(const _cubeN, const _faceN)<br />
abi_leftCubeN(const _cubeN, const _faceN)<br />
abi_leftFaceN(const _cubeN, const _faceN)<br />
Description:<br />
: Returns the cube / screen located at the top / bottom / left / right of the specified in parameters.<br />
<br />
====Examples====<br />
Find diagonal face and cube<br />
new diagonalCube = CUBES_MAX;<br />
new diagonalFace = FACES_MAX;<br />
new topCube = abi_topCubeN(cube, face);<br />
new topFace = abi_topFaceN(cube, face);<br />
if (topCube < CUBES_MAX) {<br />
diagonalCube = abi_topCubeN(topCube, topFace);<br />
if (diagonalCube < CUBES_MAX) {<br />
diagonalFace = abi_topFaceN(topCube, topFace);<br />
}<br />
}<br />
<br />
<br />
===Sound functions===<br />
====abi_CMD_PLAYSND====<br />
Syntax:<br />
abi_CMD_PLAYSND(const id, const volume)<br />
Description:<br />
: Play chosen sound with a given volume.<br />
Arguments<br />
: ''id''<br />
:: Sound serial number in the application package.<br />
: ''volume''<br />
:: The sound volume.<br />
<br />
<br />
===Messages===<br />
====abi_CMD_NET_TX====<br />
Syntax:<br />
abi_CMD_NET_TX(const line_tx, const TTL, const data[])<br />
Description:<br />
: Send data through given UART line with given TTL.<br />
Arguments<br />
: ''line_tx''<br />
:: UART line for sending a message. Each module has 3 UART lines.<br />
: ''TTL''<br />
:: Message time to live. How many modules message will pass through before stopping. For example, set TTL to 0 message will transfer only to the neighbor module. Set TTL to 1 message will transfer to a neighbor of neighbor. Maximum TTL is 2.<br />
: ''data''<br />
:: Data array to send. Maximum can be sent 20 bytes. The first 4 bytes are message general information that automatically adds before sending. The maximum useful data that can be sent are 16 bytes. Taking into account net command name 15 bytes.<br />
<br />
====Examples====<br />
We want to receive data only from 0 module<br />
<br />
// define net command<br />
#define NEW_TEST_NET_COMMAND P2P_CMD_BASE_SCRIPT_1 + 1<br />
<br />
// create message to send<br />
Send_Test_Message() {<br />
new data[4];<br />
data[0] = NEW_TEST_NET_COMMAND | (abi_cubeN << 8);<br />
data[1] = add_game_data;<br />
// using bitwise operations send more data<br />
data[2] = add_script_data_1 | (add_script_data_2 << 8) | (add_script_data_3 << 16) | (add_script_data_4 << 24);<br />
data[3] = add_game_data_1 | (add_game_data_2 << 16);<br />
<br />
// send message through UART<br />
abi_CMD_NET_TX(0, NET_BROADCAST_TTL_MAX, data);<br />
abi_CMD_NET_TX(1, NET_BROADCAST_TTL_MAX, data);<br />
abi_CMD_NET_TX(2, NET_BROADCAST_TTL_MAX, data);<br />
}<br />
<br />
// process the received message<br />
ON_CMD_NET_RX (const pkt[]) {<br />
// get 4 byte from incoming packet to get net command because first 4 bytes are general info<br />
switch (abi_ByteN(pkt, 4)) {<br />
case NEW_TEST_NET_COMMAND: {<br />
if (abi_ByteN(pkt, 5) == 0) {<br />
game_data = pkt[2];<br />
script_data_1 = abi_ByteN(pkt, 12);<br />
script_data_2 = abi_ByteN(pkt, 13);<br />
script_data_3 = abi_ByteN(pkt, 14);<br />
script_data_4 = abi_ByteN(pkt, 15);<br />
game_data_1 = pkt[4] & 0xFFFF;<br />
game_data_2 = (pkt[4] >> 16) & 0xFFFF;<br />
}<br />
}<br />
}<br />
}<br />
<br />
===Physics functions===<br />
====PHYSICS_CIRCLE_DATA====<br />
Syntax:<br />
#define PHYSICS_CIRCLE_DATA .posX, .posY, .simplePosX, .simplePosY, .spdX, .spdY, .mass, .radius, .CoR, .cube, .face, .cubeT, .faceT<br />
Description:<br />
: PAWN symbolic subscript which represent stucture.<br />
Fields<br />
: ''posX''<br />
:: Circle position on X axis (fixed point)<br />
: ''posY''<br />
:: Circle position on Y axis (fixed point)<br />
: ''simplePosX''<br />
:: Circle position on X axis<br />
: ''simplePosY''<br />
:: Circle position on Y axis<br />
: ''spdX''<br />
:: Circle X speed<br />
: ''spdY''<br />
:: Circle Y speed<br />
: ''mass''<br />
:: Circle mass (fixed point)<br />
: ''radius''<br />
:: Circle radius<br />
: ''CoR''<br />
:: Coefficient of restitution (fixed point)<br />
: ''cube''<br />
:: Module owner of this circle<br />
: ''face''<br />
:: Face owner of this circle<br />
: ''cubeT''<br />
:: Cube transfer, last module owner. Can be used for resending messages<br />
: ''faceT''<br />
:: Face transfer, last face owner. Can be used for resending messages<br />
<br />
====Physics_Circle_Vs_Circle_obj====<br />
Syntax:<br />
Physics_Circle_Vs_Circle_obj(circle1[PHYSICS_CIRCLE_DATA], circle2[PHYSICS_CIRCLE_DATA])<br />
Description:<br />
: Check circle versus circle collision.<br />
Arguments:<br />
: circle1<br />
:: First circle object.<br />
: circle2<br />
:: Second circle object.<br />
<br />
====Physics_Circle_vs_AABB_obj====<br />
Syntax:<br />
Physics_Circle_vs_AABB_obj(circle[PHYSICS_CIRCLE_DATA], rectX, rectY, rectWidth, rectHeight, fakeCircle[PHYSICS_CIRCLE_DATA] = 0)<br />
Description:<br />
: Check circle versus rectangle collision.<br />
Arguments:<br />
: circle<br />
:: Circle object.<br />
: rectX<br />
:: Rectangle X coordinate.<br />
: rectY<br />
:: Rectangle Y coordinate.<br />
: rectWidth<br />
:: Rectangle width.<br />
: rectHeight<br />
:: Rectangle height.<br />
: fakeCircle<br />
:: In case of collision returns the collision point.<br />
<br />
====Physics_Circle_Vs_LineSegment====<br />
Syntax:<br />
Physics_Circle_Vs_LineSegment(circle[PHYSICS_CIRCLE_DATA], lineSX, lineSY, lineEX, lineEY, fakeCircle[PHYSICS_CIRCLE_DATA] = 0)<br />
Description:<br />
: Check circle versus line segment collision.<br />
Arguments:<br />
: circle<br />
:: Circle object.<br />
: lineSX<br />
:: Line start X coordinates.<br />
: lineSY<br />
:: Line start Y coordinate.<br />
: lineEX<br />
:: Line end X coordinate.<br />
: lineEY<br />
:: Line end Y coordinate.<br />
: fakeCircle<br />
:: In case of collision returns the collision point.<br />
<br />
====Physics_Res_CvC_Coll_Massless====<br />
Syntax:<br />
Physics_Res_CvC_Coll_Massless(circle1[PHYSICS_CIRCLE_DATA], circle2[PHYSICS_CIRCLE_DATA])<br />
Description:<br />
: Collision resolves without using object mass.<br />
Arguments:<br />
: circle1<br />
:: First circle object.<br />
: circle2<br />
:: Second circle object.<br />
<br />
====Physics_Res_CvC_Coll_Mass====<br />
Syntax:<br />
Physics_Res_CvC_Coll_Mass(circle1[PHYSICS_CIRCLE_DATA], circle2[PHYSICS_CIRCLE_DATA])<br />
Description:<br />
: Resolves collision using object mass.<br />
Arguments:<br />
: circle1<br />
:: First circle object.<br />
: circle2<br />
:: Second circle object.<br />
<br />
====Physics_DeserializeCircle====<br />
Syntax:<br />
Physics_DeserializeCircle(serializedData_1, serializedData_2, circle[PHYSICS_CIRCLE_DATA])<br />
Description:<br />
: Deserialize circle object.<br />
Arguments:<br />
: serializedData_1<br />
:: First part of serialized circle data.<br />
: serializedData_2<br />
:: Second part of serialized circle data.<br />
: circle<br />
:: Circle object where need to save deserialized data.<br />
<br />
====Physics_SerializeCircle====<br />
Syntax:<br />
Physics_SerializeCircle(obj[PHYSICS_CIRCLE_DATA], &serializedData_1, &serializedData_2)<br />
Description:<br />
: Serialize circle object.<br />
Arguments:<br />
: circle<br />
:: Circle object to serialize.<br />
: serializedData_1<br />
:: Return first part of serialized circle data.<br />
: serializedData_2<br />
:: Return second part of serialized circle data.<br />
<br />
====Physics_Overlap====<br />
Syntax:<br />
Physics_Overlap(overlap, positionDifference, distance)<br />
Description:<br />
: Returns the distance by which objects overlap.<br />
Arguments:<br />
: overlap<br />
:: Half distance between two points.<br />
: positionDifference<br />
:: Position difference between two point in one axis. Example - first point position X is 10, second is 6. Then position difference is 10-6=4.<br />
: distance<br />
:: Distance between two points.<br />
<br />
====Examples====<br />
1. Create circle object.<br />
<br />
new ball_1[PHYSICS_CIRCLE_DATA];<br />
ball_1.posX = 180 << 8;<br />
ball_1.posY = 180 << 8;<br />
ball_1.simplePosX = 200;<br />
ball_1.simplePosY = 180;<br />
ball_1.spdX = -155;<br />
ball_1.spdY = -155;<br />
ball_1.mass = 5 << 8;<br />
ball_1.radius = 16;<br />
ball_1.cube = 0;<br />
ball_1.face = 0;<br />
ball_1.CoR = 150;<br />
<br />
2. Check collision of two circles and resolve it.<br />
<br />
if (Physics_Circle_Vs_Circle_obj(ball_1, ball_2)) {<br />
// Resolve collision<br />
Physics_Res_CvC_Coll_Massless(ball_1, ball_2);<br />
}</div>Raccoon piratehttps://wiki.wowcube.com/index.php?title=API&diff=16503API2022-02-10T12:00:46Z<p>Raccoon pirate: /* Messages */</p>
<hr />
<div>{{notice|This is a beta version, API changes can be made without warning.}}<br />
<br />
=Introduction=<br />
<br />
The main functions of the API are listed here, the features of the work of the environment are described<br />
<br />
==WOWCube Paradigms==<br />
<br />
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.<br />
<br />
==Pawn API==<br />
===Graphic functions===<br />
<br />
====Graphics 2D acceleration (G2D)====<br />
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:<br />
[[File:Cascade.png|center|G2D cascading scheme]]<br />
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.<br />
Basic coordinate principle:<br />
[[File:G2d_coordinates.png|center|G2D coordinates sceme]]<br />
Coordinates are limited from -2048 to 2047. Maximum layers size is 240x240.<br />
<br />
=====abi_CMD_G2D_BEGIN_BITMAP=====<br />
Syntax:<br />
abi_CMD_G2D_BEGIN_BITMAP(const resID, const width, const height, const bool:replace)<br />
Description:<br />
: 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.<br />
Arguments:<br />
: ''resID''<br />
:: 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.<br />
: ''width'' <br />
:: Width of the resulting resource. G2D engine can keep resource of 240px width maximum.<br />
: ''height'' <br />
:: Height of the resulting resource. G2D engine can keep resource of 240px height maximum.<br />
: ''replace'' <br />
:: If true, then an existing image will be replaced completely, otherwise it will be overwritten by reusing itself as a background layer.<br />
<br />
=====abi_CMD_G2D_BEGIN_DISPLAY=====<br />
Syntax:<br />
abi_CMD_G2D_BEGIN_DISPLAY(const display, const bool:replace)<br />
Description:<br />
: 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.<br />
Arguments:<br />
: ''display''<br />
:: ID of the display which framebuffer will be used for blending. Each module have 3 displays with ID starting from 0.<br />
: ''replace'' <br />
:: If true then an existing image will be replaced completely, otherwise it will be overwritten by reusing itself as a background layer.<br />
<br />
=====abi_CMD_G2D_ADD_SPRITE=====<br />
Syntax:<br />
abi_CMD_G2D_ADD_SPRITE(const resID, const bool:g2d, const x, const y, const alpha, const color, const rotation, const mirror)<br />
Description:<br />
: Specifies game resource which will be used as a layer for blending.<br />
Arguments:<br />
: ''resID''<br />
:: ID of the resource to be uses as a layer.<br />
: ''g2d''<br />
:: Indicates if an internal G2D resource is specified or not.<br />
: ''x'', ''y''<br />
:: Coordinates of the bitmap center to place on the layer.<br />
: ''alpha''<br />
:: Layer transparency in range between 0x00 and 0xFF, where 0x00 is a fully transparent layer.<br />
: ''color''<br />
:: Layer's source key - a color in ARGB8888 format to be avoided.<br />
: ''rotation''<br />
:: Clockwise rotation angle in degrees. It is possible to specify free angle, but only right angles have HW acceleration. Currently rotation only applicable for external resources.<br />
: ''mirror''<br />
:: Mirroring variant. Possible values are self-explained: MIRROR_BLANK, MIRROR_X, MIRROR_Y, MIRROR_XY.<br />
<br />
=====abi_CMD_G2D_ADD_RECTANGLE=====<br />
Syntax:<br />
abi_CMD_G2D_ADD_RECTANGLE(const x, const y, const width, const height, const color)<br />
Description:<br />
: 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.<br />
Arguments:<br />
: ''x'', ''y''<br />
:: Coordinates of top left rectangle corner.<br />
: ''width''<br />
:: Rectangle width.<br />
: ''height''<br />
:: Rectangle height.<br />
: ''color''<br />
:: Rectangle color in ARGB8888 format.<br />
<br />
=====abi_CMD_G2D_END=====<br />
Syntax:<br />
abi_CMD_G2D_END()<br />
Description:<br />
: 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.<br />
<br />
=====Examples=====<br />
1. Render into inner G2D resource buffer #face and display it on the display #face. Please, note that last argument of abi_CMD_BITMAP is a `true` flag, which means G2D resource should be used:<br />
...<br />
abi_CMD_G2D_BEGIN_BITMAP(face, 240, 240, true);<br />
abi_CMD_G2D_ADD_RECTANGLE(120 - animationSquareSize0, 120 - animationSquareSize0, animationSquareSize0 * 2, animationSquareSize0 * 2, 0xdfff0000);<br />
abi_CMD_G2D_ADD_RECTANGLE(120 - animationSquareSize1, 120 - animationSquareSize1, animationSquareSize1 * 2, animationSquareSize1 * 2, 0xdfffff00);<br />
abi_CMD_G2D_ADD_RECTANGLE(120 - animationSquareSize2, 120 - animationSquareSize2, animationSquareSize2 * 2, animationSquareSize2 * 2, 0xdfff00ff);<br />
abi_CMD_G2D_ADD_RECTANGLE(120 - animationSquareSize3, 120 - animationSquareSize3, animationSquareSize3 * 2, animationSquareSize3 * 2, 0xdf00ffff);<br />
abi_CMD_G2D_ADD_SPRITE(resID, false, 120, 120, animationAlpha, 0x00000000, animationAngle, MIRROR_BLANK);<br />
abi_CMD_G2D_END();<br />
...<br />
abi_CMD_BITMAP(face, 120, 120, 0, MIRROR_BLANK, true);<br />
...<br />
abi_CMD_REDRAW(face);<br />
...<br />
2. Render directly into display framebuffer #face. This will produce same result on display as example #1, but the generated image is not saved:<br />
...<br />
abi_CMD_G2D_BEGIN_DISPLAY(face, true);<br />
abi_CMD_G2D_ADD_RECTANGLE(120 - animationSquareSize0, 120 - animationSquareSize0, animationSquareSize0 * 2, animationSquareSize0 * 2, 0xdfff0000);<br />
abi_CMD_G2D_ADD_RECTANGLE(120 - animationSquareSize1, 120 - animationSquareSize1, animationSquareSize1 * 2, animationSquareSize1 * 2, 0xdfffff00);<br />
abi_CMD_G2D_ADD_RECTANGLE(120 - animationSquareSize2, 120 - animationSquareSize2, animationSquareSize2 * 2, animationSquareSize2 * 2, 0xdfff00ff);<br />
abi_CMD_G2D_ADD_RECTANGLE(120 - animationSquareSize3, 120 - animationSquareSize3, animationSquareSize3 * 2, animationSquareSize3 * 2, 0xdf00ffff);<br />
abi_CMD_G2D_ADD_SPRITE(resID, false, 120, 120, animationAlpha, 0x00000000, animationAngle, MIRROR_BLANK);<br />
abi_CMD_G2D_END();<br />
...<br />
<br />
====Font drawing functions====<br />
=====abi_CMD_TEXT=====<br />
API:<br />
abi_CMD_TEXT(const text[], const fontResID, const x, const y, const scale, const angle, const r, const g, const b)<br />
Description:<br />
: Intended to render a system font or a custom font from resources with specified coordinates, scale and rotation at an arbitrary angle.<br />
Arguments:<br />
: ''text''<br />
:: Array of chars.<br />
: ''fontResID''<br />
:: Custom font resource identifier. Provide ''-1'' to use system font resource.<br />
: ''x'', ''y''<br />
:: Coordinates of top left rectangle corner.<br />
: ''scale'', ''angle''<br />
:: Percentage scale and clockwise rotation angle in degrees. Max size of font is 200x200 px. (scale = 100%)<br />
: ''r'', ''g'', ''b''<br />
:: Font color in RGB format.<br />
<br />
Example:<br />
new text[4] = ['A', 'p', 'p', '\0'];<br />
abi_CMD_TEXT(text, RES_ID_FONT, 90, 160, 16, current_angles[face], 255, 0, 0);<br />
<br />
====TEXTURE drawing functions====<br />
=====abi_CMD_DYNAMIC_TEXTURE=====<br />
<br />
API:<br />
<br />
abi_CMD_DYNAMIC_TEXTURE(const effectId = 1, const time = any value, const args[] = {0x04030201, 0x08070605, 0x00000A09}, const argsCount = 3, const bool:g2d = false)<br />
<br />
Description:<br />
: Render a texture with chosen algorithm and parameters.<br />
Arguments:<br />
: ''effectId''<br />
:: Define algorithm to render texture. <br />
:: Available values : G2D_DYNAMIC_TEXTURE_MOSAIC <br />
<br />
: ''time ''<br />
:: Current time value. Use any fixed value to static texture or set current time value in milliseconds to make texture alive.<br />
: ''args'', ''argsCount''<br />
:: Byte stream of algorithm settings it's aligned to 4 bytes, because of pawn supports only 32-bit values.<br />
:: Size of array depends on algorithm. For example mosaic algorithm has size of settings equals 10 bytes , so we must use aligned 4 bytes - 12 bytes array and argsCount = 3<br />
<br />
: ''g2d''<br />
:: false - Use pawn default buffer to draw texture.<br />
:: true - Use g2d buffer to draw texture - not supported now.<br />
<br />
'''G2D_DYNAMIC_TEXTURE_MOSAIC''' alogrithm description<br />
<br />
:So in effect named 'mosaic' we have settings of 10 parameters each one 1 byte<br />
<br />
:Noise factors :<br />
::factor x : values from 0 to 10<br />
::factor y : values from 0 to 10<br />
::factor xy : values from 0 to 10<br />
:Time factors :<br />
::factor x : values from 0 to 10<br />
::factor y : values from 0 to 10<br />
::factor xy : values from 0 to 10<br />
:Color factors :<br />
::r : values from 0 to 10<br />
::g : values from 0 to 10<br />
::b : values from 0 to 10<br />
:Zoom factor :<br />
::zoom values from 0 to 10<br />
<br />
For example we want to set all parameters above with values in order 1,2,3,4,5,6,7,8,9,10. Take in attention that each parameter is 1 byte we must make array of 32-bit values<br />
0x04030201, 0x08070605, 0x00000A09<br />
<br />
Example:<br />
mosaic_effect_settings = { 0x04030201, 0x08070605, 0x00000A09 };<br />
mosaic_effect_settings_length = 3;<br />
abi_CMD_DYNAMIC_TEXTURE(G2D_DYNAMIC_TEXTURE_MOSAIC , currentTime, mosaic_effect_settings, mosaic_effect_settings_length);<br />
<br />
===Motion sensors===<br />
====abi_MTD_GetFaceAccel(X/Y/Z)====<br />
Syntax:<br />
abi_MTD_GetFaceAccelX(const faceN)<br />
abi_MTD_GetFaceAccelY(const faceN)<br />
abi_MTD_GetFaceAccelZ(const faceN)<br />
Description:<br />
: Get the value of acceleration along the requested axis.<br />
Arguments<br />
: ''faceN''<br />
:: Number of the module face for which requested axis is belong.<br />
<br />
====abi_MTD_GetFaceGyro(X/Y/Z)====<br />
Syntax:<br />
abi_MTD_GetFaceGyroX(const faceN)<br />
abi_MTD_GetFaceGyroY(const faceN)<br />
abi_MTD_GetFaceGyroZ(const faceN)<br />
Description:<br />
: Get the gyro value around the requested axis.<br />
Arguments<br />
: ''faceN''<br />
:: Number of the module face for which requested axis is belong.<br />
<br />
====abi_MTD_GetTapFace====<br />
Syntax:<br />
abi_MTD_GetTapFace()<br />
Description:<br />
: Get the face ID which was tapped. ID is not a face number which is used for drawing in abi_CMD_G2D_BEGIN_DISPLAY or abi_CMD_REDRAW, but that number can be calculated by subtracting by one from ID value. See possible values below.<br />
Return values:<br />
: ''MTD_TAP_DIRECTION_NONE = 0''<br />
:: Indicates that the module wan not tapped.<br />
: ''MTD_TAP_DIRECTION_X = 1''<br />
: ''MTD_TAP_DIRECTION_Y = 2''<br />
: ''MTD_TAP_DIRECTION_Z = 3''<br />
:: Indicated direction of tap.<br />
<br />
====abi_MTD_IsTapOpposite====<br />
Syntax:<br />
abi_MTD_IsTapOpposite()<br />
Description:<br />
: Get the flag if the tap was detected in opposite direction.<br />
<br />
====abi_MTD_GetTapsCount====<br />
Syntax:<br />
abi_MTD_GetTapsCount()<br />
Description:<br />
: Get the count of subsequent taps. Tap is treated as a subsequent if it was detected within predefined interval (350ms). Count will be zero until sequence is finished, i.e. next tap is not detected within interval.<br />
<br />
====abi_checkShake====<br />
Syntax:<br />
abi_checkShake()<br />
Description:<br />
: Checks if the number of shakes of the cube was more than a certain threshold then exits the script <br />
<br />
<br />
====Examples====<br />
1. Flash the face on which tap was detected. Print an ID of that face. Color of the flash depends on taps count: red - one tap, green - two taps and blue - three.<br />
new delay = 0;<br />
new color = 0x000000; <br />
ONTICK() {<br />
if (!color) {<br />
switch (abi_MTD_GetTapsCount()) {<br />
case 1:<br />
color = 0xff0000;<br />
case 2:<br />
color = 0x00ff00;<br />
case 3:<br />
color = 0x0000ff;<br />
}<br />
}<br />
if (delay % 25 == 0) {<br />
for (new i = 0; i < FACES_MAX; i++) {<br />
if (i == (abi_MTD_GetTapFace() - 1)) {<br />
abi_CMD_FILL_2(color);<br />
color = 0x000000;<br />
switch (abi_MTD_GetTapFace()) {<br />
case 1:<br />
abi_CMD_TEXT(['1', '\0'], -1, 120, 120, 14, 0, 0xff, 0xff, 0xff);<br />
case 2:<br />
abi_CMD_TEXT(['2', '\0'], -1, 120, 120, 14, 0, 0xff, 0xff, 0xff);<br />
case 3:<br />
abi_CMD_TEXT(['3', '\0'], -1, 120, 120, 14, 0, 0xff, 0xff, 0xff);<br />
}<br />
} else {<br />
abi_CMD_FILL(0, 0, 0);<br />
}<br />
abi_CMD_REDRAW(i);<br />
}<br />
}<br />
delay++;<br />
}<br />
2. Exit from script<br />
ONTICK() {<br />
if (abi_cubeN == 0) {<br />
abi_checkShake();<br />
}<br />
// Script logic<br />
}<br />
<br />
===Save/load functions===<br />
<br />
====abi_CMD_SAVE_STATE====<br />
Syntax:<br />
bool:abi_CMD_SAVE_STATE(const data[], size = sizeof(data))<br />
Description:<br />
: Save maximum 256 bytes of data to wowcube flash memory.<br />
Arguments<br />
: ''data''<br />
:: Game data to save.<br />
: ''size''<br />
:: Size of game data.<br />
Return values:<br />
: ''return false''<br />
:: If size is bigger then 256 bytes.<br />
<br />
====abi_CMD_LOAD_STATE====<br />
Syntax:<br />
abi_CMD_LOAD_STATE()<br />
Description:<br />
: Sends a command requesting the platform to load script data. The response from the platform is not instantaneous and takes several milliseconds.<br />
<br />
====Examples====<br />
1. Load data at the start.<br />
// This function is called when a response is received from the platform<br />
ON_LOAD_GAME_DATA (const pkt[]) {<br />
// Deserialize pkt<br />
currentLevelNumber = pkt[1]; // Starting with 1 cause 0 pkt element holding command ID<br />
score = pkt[2];<br />
moves = pkt[3];<br />
...<br />
record = pkt[GAME_SAVE_SIZE];<br />
}<br />
ON_INIT () {<br />
abi_CMD_LOAD_STATE ();<br />
}<br />
<br />
2. Save the data after the end of the level.<br />
SaveGameState () {<br />
new saveData [GAME_SAVE_SIZE];<br />
// Assign all necessary data<br />
saveData[0] = currentLevelNumber;<br />
saveData[1] = score;<br />
saveData[2] = moves;<br />
...<br />
saveData[GAME_SAVE_SIZE - 1] = record;<br />
<br />
abi_CMD_SAVE_STATE (saveData);<br />
}<br />
ON_CHECK_ROTATE () {<br />
if (isLevelFinished) {<br />
SaveGameState();<br />
}<br />
}<br />
<br />
===Time functions===<br />
====abi_GetTime====<br />
Syntax:<br />
abi_GetTime()<br />
Description:<br />
: Get current time in milliseconds.<br />
<br />
====Examples====<br />
new previousTime = 0;<br />
new currentTime = 0;<br />
new deltaTime = 0;<br />
ON_INIT() {<br />
previousTime = abi_GetTime();<br />
}<br />
ONTICK() {<br />
currentTime = abi_GetTime();<br />
deltaTime = currentTime - previousTime;<br />
previousTime = currentTime;<br />
}<br />
<br />
<br />
===Topology functions===<br />
====get cube/face====<br />
Syntax:<br />
abi_topCubeN(const _cubeN, const _faceN)<br />
abi_topFaceN(const _cubeN, const _faceN)<br />
abi_rightCubeN(const _cubeN, const _faceN)<br />
abi_rightFaceN(const _cubeN, const _faceN)<br />
abi_bottomCubeN(const _cubeN, const _faceN)<br />
abi_bottomFaceN(const _cubeN, const _faceN)<br />
abi_leftCubeN(const _cubeN, const _faceN)<br />
abi_leftFaceN(const _cubeN, const _faceN)<br />
Description:<br />
: Returns the cube / screen located at the top / bottom / left / right of the specified in parameters.<br />
<br />
====Examples====<br />
Find diagonal face and cube<br />
new diagonalCube = CUBES_MAX;<br />
new diagonalFace = FACES_MAX;<br />
new topCube = abi_topCubeN(cube, face);<br />
new topFace = abi_topFaceN(cube, face);<br />
if (topCube < CUBES_MAX) {<br />
diagonalCube = abi_topCubeN(topCube, topFace);<br />
if (diagonalCube < CUBES_MAX) {<br />
diagonalFace = abi_topFaceN(topCube, topFace);<br />
}<br />
}<br />
<br />
<br />
===Sound functions===<br />
====abi_CMD_PLAYSND====<br />
Syntax:<br />
abi_CMD_PLAYSND(const id, const volume)<br />
Description:<br />
: Play chosen sound with a given volume.<br />
Arguments<br />
: ''id''<br />
:: Sound serial number in the application package.<br />
: ''volume''<br />
:: The sound volume.<br />
<br />
<br />
===Messages===<br />
====abi_CMD_NET_TX====<br />
Syntax:<br />
abi_CMD_NET_TX(const line_tx, const TTL, const data[])<br />
Description:<br />
: Send data through given UART line with given TTL.<br />
Arguments<br />
: ''line_tx''<br />
:: UART line for sending a message. Each module has 3 UART lines.<br />
: ''TTL''<br />
:: Message time to live. How many modules message will pass through before stopping. For example, set TTL to 0 message will transfer only to the neighbor module. Set TTL to 1 message will transfer to a neighbor of neighbor. Maximum TTL is 2.<br />
: ''data''<br />
:: Data array to send. Maximum can be sent 20 bytes. The first 4 bytes are message general information that automatically adds before sending. The maximum useful data that can be sent are 16 bytes. Taking into account net command name 15 bytes.<br />
<br />
====Examples====<br />
We want to receive data only from 0 module<br />
<br />
// define net command<br />
#define NEW_TEST_NET_COMMAND P2P_CMD_BASE_SCRIPT_1 + 1<br />
<br />
// create message to send<br />
Send_Test_Message() {<br />
new data[4];<br />
data[0] = NEW_TEST_NET_COMMAND | (abi_cubeN << 8);<br />
data[1] = add_game_data;<br />
// using bitwise operations send more data<br />
data[2] = add_script_data_1 | (add_script_data_2 << 8) | (add_script_data_3 << 16) | (add_script_data_4 << 24);<br />
data[3] = add_game_data_1 | (add_game_data_2 << 16);<br />
<br />
// send message through UART<br />
abi_CMD_NET_TX(0, NET_BROADCAST_TTL_MAX, data);<br />
abi_CMD_NET_TX(1, NET_BROADCAST_TTL_MAX, data);<br />
abi_CMD_NET_TX(2, NET_BROADCAST_TTL_MAX, data);<br />
}<br />
<br />
// process the received message<br />
ON_CMD_NET_RX (const pkt[]) {<br />
// get 4 byte from incoming packet to get net command because first 4 bytes are general info<br />
switch (abi_ByteN(pkt, 4)) {<br />
case NEW_TEST_NET_COMMAND: {<br />
if (abi_ByteN(pkt, 5) == 0) {<br />
game_data = pkt[2];<br />
script_data_1 = abi_ByteN(pkt, 12);<br />
script_data_2 = abi_ByteN(pkt, 13);<br />
script_data_3 = abi_ByteN(pkt, 14);<br />
script_data_4 = abi_ByteN(pkt, 15);<br />
game_data_1 = pkt[4] & 0xFFFF;<br />
game_data_2 = (pkt[4] >> 16) & 0xFFFF;<br />
}<br />
}<br />
}<br />
}<br />
<br />
===Physics functions===<br />
====PHYSICS_CIRCLE_DATA====<br />
Syntax:<br />
#define PHYSICS_CIRCLE_DATA .posX, .posY, .simplePosX, .simplePosY, .spdX, .spdY, .mass, .radius, .CoR, .cube, .face, .cubeT, .faceT<br />
Description:<br />
: PAWN symbolic subscript which represent stucture.<br />
Fields<br />
: ''posX''<br />
:: Circle position on X axis (fixed point)<br />
: ''posY''<br />
:: Circle position on Y axis (fixed point)<br />
: ''simplePosX''<br />
:: Circle position on X axis<br />
: ''simplePosY''<br />
:: Circle position on Y axis<br />
: ''spdX''<br />
:: Circle X speed<br />
: ''spdY''<br />
:: Circle Y speed<br />
: ''mass''<br />
:: Circle mass (fixed point)<br />
: ''radius''<br />
:: Circle radius<br />
: ''CoR''<br />
:: Coefficient of restitution (fixed point)<br />
: ''cube''<br />
:: Module owner of this circle<br />
: ''face''<br />
:: Face owner of this circle<br />
: ''cubeT''<br />
:: Cube transfer, last module owner. Can be used for resending messages<br />
: ''faceT''<br />
:: Face transfer, last face owner. Can be used for resending messages<br />
<br />
====Physics_Circle_Vs_Circle_obj====<br />
Syntax:<br />
Physics_Circle_Vs_Circle_obj(circle1[PHYSICS_CIRCLE_DATA], circle2[PHYSICS_CIRCLE_DATA])<br />
Description:<br />
: Check if two circles collide<br />
Arguments:<br />
: circle1<br />
:: First circle object.<br />
: circle2<br />
:: Second circle object.</div>Raccoon piratehttps://wiki.wowcube.com/index.php?title=API&diff=16502API2022-02-10T12:00:09Z<p>Raccoon pirate: /* Physics functions */</p>
<hr />
<div>{{notice|This is a beta version, API changes can be made without warning.}}<br />
<br />
=Introduction=<br />
<br />
The main functions of the API are listed here, the features of the work of the environment are described<br />
<br />
==WOWCube Paradigms==<br />
<br />
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.<br />
<br />
==Pawn API==<br />
===Graphic functions===<br />
<br />
====Graphics 2D acceleration (G2D)====<br />
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:<br />
[[File:Cascade.png|center|G2D cascading scheme]]<br />
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.<br />
Basic coordinate principle:<br />
[[File:G2d_coordinates.png|center|G2D coordinates sceme]]<br />
Coordinates are limited from -2048 to 2047. Maximum layers size is 240x240.<br />
<br />
=====abi_CMD_G2D_BEGIN_BITMAP=====<br />
Syntax:<br />
abi_CMD_G2D_BEGIN_BITMAP(const resID, const width, const height, const bool:replace)<br />
Description:<br />
: 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.<br />
Arguments:<br />
: ''resID''<br />
:: 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.<br />
: ''width'' <br />
:: Width of the resulting resource. G2D engine can keep resource of 240px width maximum.<br />
: ''height'' <br />
:: Height of the resulting resource. G2D engine can keep resource of 240px height maximum.<br />
: ''replace'' <br />
:: If true, then an existing image will be replaced completely, otherwise it will be overwritten by reusing itself as a background layer.<br />
<br />
=====abi_CMD_G2D_BEGIN_DISPLAY=====<br />
Syntax:<br />
abi_CMD_G2D_BEGIN_DISPLAY(const display, const bool:replace)<br />
Description:<br />
: 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.<br />
Arguments:<br />
: ''display''<br />
:: ID of the display which framebuffer will be used for blending. Each module have 3 displays with ID starting from 0.<br />
: ''replace'' <br />
:: If true then an existing image will be replaced completely, otherwise it will be overwritten by reusing itself as a background layer.<br />
<br />
=====abi_CMD_G2D_ADD_SPRITE=====<br />
Syntax:<br />
abi_CMD_G2D_ADD_SPRITE(const resID, const bool:g2d, const x, const y, const alpha, const color, const rotation, const mirror)<br />
Description:<br />
: Specifies game resource which will be used as a layer for blending.<br />
Arguments:<br />
: ''resID''<br />
:: ID of the resource to be uses as a layer.<br />
: ''g2d''<br />
:: Indicates if an internal G2D resource is specified or not.<br />
: ''x'', ''y''<br />
:: Coordinates of the bitmap center to place on the layer.<br />
: ''alpha''<br />
:: Layer transparency in range between 0x00 and 0xFF, where 0x00 is a fully transparent layer.<br />
: ''color''<br />
:: Layer's source key - a color in ARGB8888 format to be avoided.<br />
: ''rotation''<br />
:: Clockwise rotation angle in degrees. It is possible to specify free angle, but only right angles have HW acceleration. Currently rotation only applicable for external resources.<br />
: ''mirror''<br />
:: Mirroring variant. Possible values are self-explained: MIRROR_BLANK, MIRROR_X, MIRROR_Y, MIRROR_XY.<br />
<br />
=====abi_CMD_G2D_ADD_RECTANGLE=====<br />
Syntax:<br />
abi_CMD_G2D_ADD_RECTANGLE(const x, const y, const width, const height, const color)<br />
Description:<br />
: 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.<br />
Arguments:<br />
: ''x'', ''y''<br />
:: Coordinates of top left rectangle corner.<br />
: ''width''<br />
:: Rectangle width.<br />
: ''height''<br />
:: Rectangle height.<br />
: ''color''<br />
:: Rectangle color in ARGB8888 format.<br />
<br />
=====abi_CMD_G2D_END=====<br />
Syntax:<br />
abi_CMD_G2D_END()<br />
Description:<br />
: 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.<br />
<br />
=====Examples=====<br />
1. Render into inner G2D resource buffer #face and display it on the display #face. Please, note that last argument of abi_CMD_BITMAP is a `true` flag, which means G2D resource should be used:<br />
...<br />
abi_CMD_G2D_BEGIN_BITMAP(face, 240, 240, true);<br />
abi_CMD_G2D_ADD_RECTANGLE(120 - animationSquareSize0, 120 - animationSquareSize0, animationSquareSize0 * 2, animationSquareSize0 * 2, 0xdfff0000);<br />
abi_CMD_G2D_ADD_RECTANGLE(120 - animationSquareSize1, 120 - animationSquareSize1, animationSquareSize1 * 2, animationSquareSize1 * 2, 0xdfffff00);<br />
abi_CMD_G2D_ADD_RECTANGLE(120 - animationSquareSize2, 120 - animationSquareSize2, animationSquareSize2 * 2, animationSquareSize2 * 2, 0xdfff00ff);<br />
abi_CMD_G2D_ADD_RECTANGLE(120 - animationSquareSize3, 120 - animationSquareSize3, animationSquareSize3 * 2, animationSquareSize3 * 2, 0xdf00ffff);<br />
abi_CMD_G2D_ADD_SPRITE(resID, false, 120, 120, animationAlpha, 0x00000000, animationAngle, MIRROR_BLANK);<br />
abi_CMD_G2D_END();<br />
...<br />
abi_CMD_BITMAP(face, 120, 120, 0, MIRROR_BLANK, true);<br />
...<br />
abi_CMD_REDRAW(face);<br />
...<br />
2. Render directly into display framebuffer #face. This will produce same result on display as example #1, but the generated image is not saved:<br />
...<br />
abi_CMD_G2D_BEGIN_DISPLAY(face, true);<br />
abi_CMD_G2D_ADD_RECTANGLE(120 - animationSquareSize0, 120 - animationSquareSize0, animationSquareSize0 * 2, animationSquareSize0 * 2, 0xdfff0000);<br />
abi_CMD_G2D_ADD_RECTANGLE(120 - animationSquareSize1, 120 - animationSquareSize1, animationSquareSize1 * 2, animationSquareSize1 * 2, 0xdfffff00);<br />
abi_CMD_G2D_ADD_RECTANGLE(120 - animationSquareSize2, 120 - animationSquareSize2, animationSquareSize2 * 2, animationSquareSize2 * 2, 0xdfff00ff);<br />
abi_CMD_G2D_ADD_RECTANGLE(120 - animationSquareSize3, 120 - animationSquareSize3, animationSquareSize3 * 2, animationSquareSize3 * 2, 0xdf00ffff);<br />
abi_CMD_G2D_ADD_SPRITE(resID, false, 120, 120, animationAlpha, 0x00000000, animationAngle, MIRROR_BLANK);<br />
abi_CMD_G2D_END();<br />
...<br />
<br />
====Font drawing functions====<br />
=====abi_CMD_TEXT=====<br />
API:<br />
abi_CMD_TEXT(const text[], const fontResID, const x, const y, const scale, const angle, const r, const g, const b)<br />
Description:<br />
: Intended to render a system font or a custom font from resources with specified coordinates, scale and rotation at an arbitrary angle.<br />
Arguments:<br />
: ''text''<br />
:: Array of chars.<br />
: ''fontResID''<br />
:: Custom font resource identifier. Provide ''-1'' to use system font resource.<br />
: ''x'', ''y''<br />
:: Coordinates of top left rectangle corner.<br />
: ''scale'', ''angle''<br />
:: Percentage scale and clockwise rotation angle in degrees. Max size of font is 200x200 px. (scale = 100%)<br />
: ''r'', ''g'', ''b''<br />
:: Font color in RGB format.<br />
<br />
Example:<br />
new text[4] = ['A', 'p', 'p', '\0'];<br />
abi_CMD_TEXT(text, RES_ID_FONT, 90, 160, 16, current_angles[face], 255, 0, 0);<br />
<br />
====TEXTURE drawing functions====<br />
=====abi_CMD_DYNAMIC_TEXTURE=====<br />
<br />
API:<br />
<br />
abi_CMD_DYNAMIC_TEXTURE(const effectId = 1, const time = any value, const args[] = {0x04030201, 0x08070605, 0x00000A09}, const argsCount = 3, const bool:g2d = false)<br />
<br />
Description:<br />
: Render a texture with chosen algorithm and parameters.<br />
Arguments:<br />
: ''effectId''<br />
:: Define algorithm to render texture. <br />
:: Available values : G2D_DYNAMIC_TEXTURE_MOSAIC <br />
<br />
: ''time ''<br />
:: Current time value. Use any fixed value to static texture or set current time value in milliseconds to make texture alive.<br />
: ''args'', ''argsCount''<br />
:: Byte stream of algorithm settings it's aligned to 4 bytes, because of pawn supports only 32-bit values.<br />
:: Size of array depends on algorithm. For example mosaic algorithm has size of settings equals 10 bytes , so we must use aligned 4 bytes - 12 bytes array and argsCount = 3<br />
<br />
: ''g2d''<br />
:: false - Use pawn default buffer to draw texture.<br />
:: true - Use g2d buffer to draw texture - not supported now.<br />
<br />
'''G2D_DYNAMIC_TEXTURE_MOSAIC''' alogrithm description<br />
<br />
:So in effect named 'mosaic' we have settings of 10 parameters each one 1 byte<br />
<br />
:Noise factors :<br />
::factor x : values from 0 to 10<br />
::factor y : values from 0 to 10<br />
::factor xy : values from 0 to 10<br />
:Time factors :<br />
::factor x : values from 0 to 10<br />
::factor y : values from 0 to 10<br />
::factor xy : values from 0 to 10<br />
:Color factors :<br />
::r : values from 0 to 10<br />
::g : values from 0 to 10<br />
::b : values from 0 to 10<br />
:Zoom factor :<br />
::zoom values from 0 to 10<br />
<br />
For example we want to set all parameters above with values in order 1,2,3,4,5,6,7,8,9,10. Take in attention that each parameter is 1 byte we must make array of 32-bit values<br />
0x04030201, 0x08070605, 0x00000A09<br />
<br />
Example:<br />
mosaic_effect_settings = { 0x04030201, 0x08070605, 0x00000A09 };<br />
mosaic_effect_settings_length = 3;<br />
abi_CMD_DYNAMIC_TEXTURE(G2D_DYNAMIC_TEXTURE_MOSAIC , currentTime, mosaic_effect_settings, mosaic_effect_settings_length);<br />
<br />
===Motion sensors===<br />
====abi_MTD_GetFaceAccel(X/Y/Z)====<br />
Syntax:<br />
abi_MTD_GetFaceAccelX(const faceN)<br />
abi_MTD_GetFaceAccelY(const faceN)<br />
abi_MTD_GetFaceAccelZ(const faceN)<br />
Description:<br />
: Get the value of acceleration along the requested axis.<br />
Arguments<br />
: ''faceN''<br />
:: Number of the module face for which requested axis is belong.<br />
<br />
====abi_MTD_GetFaceGyro(X/Y/Z)====<br />
Syntax:<br />
abi_MTD_GetFaceGyroX(const faceN)<br />
abi_MTD_GetFaceGyroY(const faceN)<br />
abi_MTD_GetFaceGyroZ(const faceN)<br />
Description:<br />
: Get the gyro value around the requested axis.<br />
Arguments<br />
: ''faceN''<br />
:: Number of the module face for which requested axis is belong.<br />
<br />
====abi_MTD_GetTapFace====<br />
Syntax:<br />
abi_MTD_GetTapFace()<br />
Description:<br />
: Get the face ID which was tapped. ID is not a face number which is used for drawing in abi_CMD_G2D_BEGIN_DISPLAY or abi_CMD_REDRAW, but that number can be calculated by subtracting by one from ID value. See possible values below.<br />
Return values:<br />
: ''MTD_TAP_DIRECTION_NONE = 0''<br />
:: Indicates that the module wan not tapped.<br />
: ''MTD_TAP_DIRECTION_X = 1''<br />
: ''MTD_TAP_DIRECTION_Y = 2''<br />
: ''MTD_TAP_DIRECTION_Z = 3''<br />
:: Indicated direction of tap.<br />
<br />
====abi_MTD_IsTapOpposite====<br />
Syntax:<br />
abi_MTD_IsTapOpposite()<br />
Description:<br />
: Get the flag if the tap was detected in opposite direction.<br />
<br />
====abi_MTD_GetTapsCount====<br />
Syntax:<br />
abi_MTD_GetTapsCount()<br />
Description:<br />
: Get the count of subsequent taps. Tap is treated as a subsequent if it was detected within predefined interval (350ms). Count will be zero until sequence is finished, i.e. next tap is not detected within interval.<br />
<br />
====abi_checkShake====<br />
Syntax:<br />
abi_checkShake()<br />
Description:<br />
: Checks if the number of shakes of the cube was more than a certain threshold then exits the script <br />
<br />
<br />
====Examples====<br />
1. Flash the face on which tap was detected. Print an ID of that face. Color of the flash depends on taps count: red - one tap, green - two taps and blue - three.<br />
new delay = 0;<br />
new color = 0x000000; <br />
ONTICK() {<br />
if (!color) {<br />
switch (abi_MTD_GetTapsCount()) {<br />
case 1:<br />
color = 0xff0000;<br />
case 2:<br />
color = 0x00ff00;<br />
case 3:<br />
color = 0x0000ff;<br />
}<br />
}<br />
if (delay % 25 == 0) {<br />
for (new i = 0; i < FACES_MAX; i++) {<br />
if (i == (abi_MTD_GetTapFace() - 1)) {<br />
abi_CMD_FILL_2(color);<br />
color = 0x000000;<br />
switch (abi_MTD_GetTapFace()) {<br />
case 1:<br />
abi_CMD_TEXT(['1', '\0'], -1, 120, 120, 14, 0, 0xff, 0xff, 0xff);<br />
case 2:<br />
abi_CMD_TEXT(['2', '\0'], -1, 120, 120, 14, 0, 0xff, 0xff, 0xff);<br />
case 3:<br />
abi_CMD_TEXT(['3', '\0'], -1, 120, 120, 14, 0, 0xff, 0xff, 0xff);<br />
}<br />
} else {<br />
abi_CMD_FILL(0, 0, 0);<br />
}<br />
abi_CMD_REDRAW(i);<br />
}<br />
}<br />
delay++;<br />
}<br />
2. Exit from script<br />
ONTICK() {<br />
if (abi_cubeN == 0) {<br />
abi_checkShake();<br />
}<br />
// Script logic<br />
}<br />
<br />
===Save/load functions===<br />
<br />
====abi_CMD_SAVE_STATE====<br />
Syntax:<br />
bool:abi_CMD_SAVE_STATE(const data[], size = sizeof(data))<br />
Description:<br />
: Save maximum 256 bytes of data to wowcube flash memory.<br />
Arguments<br />
: ''data''<br />
:: Game data to save.<br />
: ''size''<br />
:: Size of game data.<br />
Return values:<br />
: ''return false''<br />
:: If size is bigger then 256 bytes.<br />
<br />
====abi_CMD_LOAD_STATE====<br />
Syntax:<br />
abi_CMD_LOAD_STATE()<br />
Description:<br />
: Sends a command requesting the platform to load script data. The response from the platform is not instantaneous and takes several milliseconds.<br />
<br />
====Examples====<br />
1. Load data at the start.<br />
// This function is called when a response is received from the platform<br />
ON_LOAD_GAME_DATA (const pkt[]) {<br />
// Deserialize pkt<br />
currentLevelNumber = pkt[1]; // Starting with 1 cause 0 pkt element holding command ID<br />
score = pkt[2];<br />
moves = pkt[3];<br />
...<br />
record = pkt[GAME_SAVE_SIZE];<br />
}<br />
ON_INIT () {<br />
abi_CMD_LOAD_STATE ();<br />
}<br />
<br />
2. Save the data after the end of the level.<br />
SaveGameState () {<br />
new saveData [GAME_SAVE_SIZE];<br />
// Assign all necessary data<br />
saveData[0] = currentLevelNumber;<br />
saveData[1] = score;<br />
saveData[2] = moves;<br />
...<br />
saveData[GAME_SAVE_SIZE - 1] = record;<br />
<br />
abi_CMD_SAVE_STATE (saveData);<br />
}<br />
ON_CHECK_ROTATE () {<br />
if (isLevelFinished) {<br />
SaveGameState();<br />
}<br />
}<br />
<br />
===Time functions===<br />
====abi_GetTime====<br />
Syntax:<br />
abi_GetTime()<br />
Description:<br />
: Get current time in milliseconds.<br />
<br />
====Examples====<br />
new previousTime = 0;<br />
new currentTime = 0;<br />
new deltaTime = 0;<br />
ON_INIT() {<br />
previousTime = abi_GetTime();<br />
}<br />
ONTICK() {<br />
currentTime = abi_GetTime();<br />
deltaTime = currentTime - previousTime;<br />
previousTime = currentTime;<br />
}<br />
<br />
<br />
===Topology functions===<br />
====get cube/face====<br />
Syntax:<br />
abi_topCubeN(const _cubeN, const _faceN)<br />
abi_topFaceN(const _cubeN, const _faceN)<br />
abi_rightCubeN(const _cubeN, const _faceN)<br />
abi_rightFaceN(const _cubeN, const _faceN)<br />
abi_bottomCubeN(const _cubeN, const _faceN)<br />
abi_bottomFaceN(const _cubeN, const _faceN)<br />
abi_leftCubeN(const _cubeN, const _faceN)<br />
abi_leftFaceN(const _cubeN, const _faceN)<br />
Description:<br />
: Returns the cube / screen located at the top / bottom / left / right of the specified in parameters.<br />
<br />
====Examples====<br />
Find diagonal face and cube<br />
new diagonalCube = CUBES_MAX;<br />
new diagonalFace = FACES_MAX;<br />
new topCube = abi_topCubeN(cube, face);<br />
new topFace = abi_topFaceN(cube, face);<br />
if (topCube < CUBES_MAX) {<br />
diagonalCube = abi_topCubeN(topCube, topFace);<br />
if (diagonalCube < CUBES_MAX) {<br />
diagonalFace = abi_topFaceN(topCube, topFace);<br />
}<br />
}<br />
<br />
<br />
===Sound functions===<br />
====abi_CMD_PLAYSND====<br />
Syntax:<br />
abi_CMD_PLAYSND(const id, const volume)<br />
Description:<br />
: Play chosen sound with a given volume.<br />
Arguments<br />
: ''id''<br />
:: Sound serial number in the application package.<br />
: ''volume''<br />
:: The sound volume.<br />
<br />
<br />
===Messages===<br />
====abi_CMD_NET_TX====<br />
Syntax:<br />
abi_CMD_NET_TX(const line_tx, const TTL, const data[])<br />
Description:<br />
: Send data through given UART line with given TTL. Ge<br />
Arguments<br />
: ''line_tx''<br />
:: UART line for sending a message. Each module has 3 UART lines.<br />
: ''TTL''<br />
:: Message time to live. How many modules message will pass through before stopping. For example, set TTL to 0 message will transfer only to the neighbor module. Set TTL to 1 message will transfer to a neighbor of neighbor. Maximum TTL is 2.<br />
: ''data''<br />
:: Data array to send. Maximum can be sent 20 bytes. The first 4 bytes are message general information that automatically adds before sending. The maximum useful data that can be sent are 16 bytes. Taking into account net command name 15 bytes.<br />
<br />
====Examples====<br />
We want to receive data only from 0 module<br />
<br />
// define net command<br />
#define NEW_TEST_NET_COMMAND P2P_CMD_BASE_SCRIPT_1 + 1<br />
<br />
// create message to send<br />
Send_Test_Message() {<br />
new data[4];<br />
data[0] = NEW_TEST_NET_COMMAND | (abi_cubeN << 8);<br />
data[1] = add_game_data;<br />
// using bitwise operations send more data<br />
data[2] = add_script_data_1 | (add_script_data_2 << 8) | (add_script_data_3 << 16) | (add_script_data_4 << 24);<br />
data[3] = add_game_data_1 | (add_game_data_2 << 16);<br />
<br />
// send message through UART<br />
abi_CMD_NET_TX(0, NET_BROADCAST_TTL_MAX, data);<br />
abi_CMD_NET_TX(1, NET_BROADCAST_TTL_MAX, data);<br />
abi_CMD_NET_TX(2, NET_BROADCAST_TTL_MAX, data);<br />
}<br />
<br />
// process the received message<br />
ON_CMD_NET_RX (const pkt[]) {<br />
// get 4 byte from incoming packet to get net command because first 4 bytes are general info<br />
switch (abi_ByteN(pkt, 4)) {<br />
case NEW_TEST_NET_COMMAND: {<br />
if (abi_ByteN(pkt, 5) == 0) {<br />
game_data = pkt[2];<br />
script_data_1 = abi_ByteN(pkt, 12);<br />
script_data_2 = abi_ByteN(pkt, 13);<br />
script_data_3 = abi_ByteN(pkt, 14);<br />
script_data_4 = abi_ByteN(pkt, 15);<br />
game_data_1 = pkt[4] & 0xFFFF;<br />
game_data_2 = (pkt[4] >> 16) & 0xFFFF;<br />
}<br />
}<br />
}<br />
}<br />
<br />
<br />
===Physics functions===<br />
====PHYSICS_CIRCLE_DATA====<br />
Syntax:<br />
#define PHYSICS_CIRCLE_DATA .posX, .posY, .simplePosX, .simplePosY, .spdX, .spdY, .mass, .radius, .CoR, .cube, .face, .cubeT, .faceT<br />
Description:<br />
: PAWN symbolic subscript which represent stucture.<br />
Fields<br />
: ''posX''<br />
:: Circle position on X axis (fixed point)<br />
: ''posY''<br />
:: Circle position on Y axis (fixed point)<br />
: ''simplePosX''<br />
:: Circle position on X axis<br />
: ''simplePosY''<br />
:: Circle position on Y axis<br />
: ''spdX''<br />
:: Circle X speed<br />
: ''spdY''<br />
:: Circle Y speed<br />
: ''mass''<br />
:: Circle mass (fixed point)<br />
: ''radius''<br />
:: Circle radius<br />
: ''CoR''<br />
:: Coefficient of restitution (fixed point)<br />
: ''cube''<br />
:: Module owner of this circle<br />
: ''face''<br />
:: Face owner of this circle<br />
: ''cubeT''<br />
:: Cube transfer, last module owner. Can be used for resending messages<br />
: ''faceT''<br />
:: Face transfer, last face owner. Can be used for resending messages<br />
<br />
====Physics_Circle_Vs_Circle_obj====<br />
Syntax:<br />
Physics_Circle_Vs_Circle_obj(circle1[PHYSICS_CIRCLE_DATA], circle2[PHYSICS_CIRCLE_DATA])<br />
Description:<br />
: Check if two circles collide<br />
Arguments:<br />
: circle1<br />
:: First circle object.<br />
: circle2<br />
:: Second circle object.</div>Raccoon piratehttps://wiki.wowcube.com/index.php?title=API&diff=16501API2022-02-10T11:53:53Z<p>Raccoon pirate: </p>
<hr />
<div>{{notice|This is a beta version, API changes can be made without warning.}}<br />
<br />
=Introduction=<br />
<br />
The main functions of the API are listed here, the features of the work of the environment are described<br />
<br />
==WOWCube Paradigms==<br />
<br />
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.<br />
<br />
==Pawn API==<br />
===Graphic functions===<br />
<br />
====Graphics 2D acceleration (G2D)====<br />
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:<br />
[[File:Cascade.png|center|G2D cascading scheme]]<br />
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.<br />
Basic coordinate principle:<br />
[[File:G2d_coordinates.png|center|G2D coordinates sceme]]<br />
Coordinates are limited from -2048 to 2047. Maximum layers size is 240x240.<br />
<br />
=====abi_CMD_G2D_BEGIN_BITMAP=====<br />
Syntax:<br />
abi_CMD_G2D_BEGIN_BITMAP(const resID, const width, const height, const bool:replace)<br />
Description:<br />
: 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.<br />
Arguments:<br />
: ''resID''<br />
:: 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.<br />
: ''width'' <br />
:: Width of the resulting resource. G2D engine can keep resource of 240px width maximum.<br />
: ''height'' <br />
:: Height of the resulting resource. G2D engine can keep resource of 240px height maximum.<br />
: ''replace'' <br />
:: If true, then an existing image will be replaced completely, otherwise it will be overwritten by reusing itself as a background layer.<br />
<br />
=====abi_CMD_G2D_BEGIN_DISPLAY=====<br />
Syntax:<br />
abi_CMD_G2D_BEGIN_DISPLAY(const display, const bool:replace)<br />
Description:<br />
: 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.<br />
Arguments:<br />
: ''display''<br />
:: ID of the display which framebuffer will be used for blending. Each module have 3 displays with ID starting from 0.<br />
: ''replace'' <br />
:: If true then an existing image will be replaced completely, otherwise it will be overwritten by reusing itself as a background layer.<br />
<br />
=====abi_CMD_G2D_ADD_SPRITE=====<br />
Syntax:<br />
abi_CMD_G2D_ADD_SPRITE(const resID, const bool:g2d, const x, const y, const alpha, const color, const rotation, const mirror)<br />
Description:<br />
: Specifies game resource which will be used as a layer for blending.<br />
Arguments:<br />
: ''resID''<br />
:: ID of the resource to be uses as a layer.<br />
: ''g2d''<br />
:: Indicates if an internal G2D resource is specified or not.<br />
: ''x'', ''y''<br />
:: Coordinates of the bitmap center to place on the layer.<br />
: ''alpha''<br />
:: Layer transparency in range between 0x00 and 0xFF, where 0x00 is a fully transparent layer.<br />
: ''color''<br />
:: Layer's source key - a color in ARGB8888 format to be avoided.<br />
: ''rotation''<br />
:: Clockwise rotation angle in degrees. It is possible to specify free angle, but only right angles have HW acceleration. Currently rotation only applicable for external resources.<br />
: ''mirror''<br />
:: Mirroring variant. Possible values are self-explained: MIRROR_BLANK, MIRROR_X, MIRROR_Y, MIRROR_XY.<br />
<br />
=====abi_CMD_G2D_ADD_RECTANGLE=====<br />
Syntax:<br />
abi_CMD_G2D_ADD_RECTANGLE(const x, const y, const width, const height, const color)<br />
Description:<br />
: 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.<br />
Arguments:<br />
: ''x'', ''y''<br />
:: Coordinates of top left rectangle corner.<br />
: ''width''<br />
:: Rectangle width.<br />
: ''height''<br />
:: Rectangle height.<br />
: ''color''<br />
:: Rectangle color in ARGB8888 format.<br />
<br />
=====abi_CMD_G2D_END=====<br />
Syntax:<br />
abi_CMD_G2D_END()<br />
Description:<br />
: 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.<br />
<br />
=====Examples=====<br />
1. Render into inner G2D resource buffer #face and display it on the display #face. Please, note that last argument of abi_CMD_BITMAP is a `true` flag, which means G2D resource should be used:<br />
...<br />
abi_CMD_G2D_BEGIN_BITMAP(face, 240, 240, true);<br />
abi_CMD_G2D_ADD_RECTANGLE(120 - animationSquareSize0, 120 - animationSquareSize0, animationSquareSize0 * 2, animationSquareSize0 * 2, 0xdfff0000);<br />
abi_CMD_G2D_ADD_RECTANGLE(120 - animationSquareSize1, 120 - animationSquareSize1, animationSquareSize1 * 2, animationSquareSize1 * 2, 0xdfffff00);<br />
abi_CMD_G2D_ADD_RECTANGLE(120 - animationSquareSize2, 120 - animationSquareSize2, animationSquareSize2 * 2, animationSquareSize2 * 2, 0xdfff00ff);<br />
abi_CMD_G2D_ADD_RECTANGLE(120 - animationSquareSize3, 120 - animationSquareSize3, animationSquareSize3 * 2, animationSquareSize3 * 2, 0xdf00ffff);<br />
abi_CMD_G2D_ADD_SPRITE(resID, false, 120, 120, animationAlpha, 0x00000000, animationAngle, MIRROR_BLANK);<br />
abi_CMD_G2D_END();<br />
...<br />
abi_CMD_BITMAP(face, 120, 120, 0, MIRROR_BLANK, true);<br />
...<br />
abi_CMD_REDRAW(face);<br />
...<br />
2. Render directly into display framebuffer #face. This will produce same result on display as example #1, but the generated image is not saved:<br />
...<br />
abi_CMD_G2D_BEGIN_DISPLAY(face, true);<br />
abi_CMD_G2D_ADD_RECTANGLE(120 - animationSquareSize0, 120 - animationSquareSize0, animationSquareSize0 * 2, animationSquareSize0 * 2, 0xdfff0000);<br />
abi_CMD_G2D_ADD_RECTANGLE(120 - animationSquareSize1, 120 - animationSquareSize1, animationSquareSize1 * 2, animationSquareSize1 * 2, 0xdfffff00);<br />
abi_CMD_G2D_ADD_RECTANGLE(120 - animationSquareSize2, 120 - animationSquareSize2, animationSquareSize2 * 2, animationSquareSize2 * 2, 0xdfff00ff);<br />
abi_CMD_G2D_ADD_RECTANGLE(120 - animationSquareSize3, 120 - animationSquareSize3, animationSquareSize3 * 2, animationSquareSize3 * 2, 0xdf00ffff);<br />
abi_CMD_G2D_ADD_SPRITE(resID, false, 120, 120, animationAlpha, 0x00000000, animationAngle, MIRROR_BLANK);<br />
abi_CMD_G2D_END();<br />
...<br />
<br />
====Font drawing functions====<br />
=====abi_CMD_TEXT=====<br />
API:<br />
abi_CMD_TEXT(const text[], const fontResID, const x, const y, const scale, const angle, const r, const g, const b)<br />
Description:<br />
: Intended to render a system font or a custom font from resources with specified coordinates, scale and rotation at an arbitrary angle.<br />
Arguments:<br />
: ''text''<br />
:: Array of chars.<br />
: ''fontResID''<br />
:: Custom font resource identifier. Provide ''-1'' to use system font resource.<br />
: ''x'', ''y''<br />
:: Coordinates of top left rectangle corner.<br />
: ''scale'', ''angle''<br />
:: Percentage scale and clockwise rotation angle in degrees. Max size of font is 200x200 px. (scale = 100%)<br />
: ''r'', ''g'', ''b''<br />
:: Font color in RGB format.<br />
<br />
Example:<br />
new text[4] = ['A', 'p', 'p', '\0'];<br />
abi_CMD_TEXT(text, RES_ID_FONT, 90, 160, 16, current_angles[face], 255, 0, 0);<br />
<br />
====TEXTURE drawing functions====<br />
=====abi_CMD_DYNAMIC_TEXTURE=====<br />
<br />
API:<br />
<br />
abi_CMD_DYNAMIC_TEXTURE(const effectId = 1, const time = any value, const args[] = {0x04030201, 0x08070605, 0x00000A09}, const argsCount = 3, const bool:g2d = false)<br />
<br />
Description:<br />
: Render a texture with chosen algorithm and parameters.<br />
Arguments:<br />
: ''effectId''<br />
:: Define algorithm to render texture. <br />
:: Available values : G2D_DYNAMIC_TEXTURE_MOSAIC <br />
<br />
: ''time ''<br />
:: Current time value. Use any fixed value to static texture or set current time value in milliseconds to make texture alive.<br />
: ''args'', ''argsCount''<br />
:: Byte stream of algorithm settings it's aligned to 4 bytes, because of pawn supports only 32-bit values.<br />
:: Size of array depends on algorithm. For example mosaic algorithm has size of settings equals 10 bytes , so we must use aligned 4 bytes - 12 bytes array and argsCount = 3<br />
<br />
: ''g2d''<br />
:: false - Use pawn default buffer to draw texture.<br />
:: true - Use g2d buffer to draw texture - not supported now.<br />
<br />
'''G2D_DYNAMIC_TEXTURE_MOSAIC''' alogrithm description<br />
<br />
:So in effect named 'mosaic' we have settings of 10 parameters each one 1 byte<br />
<br />
:Noise factors :<br />
::factor x : values from 0 to 10<br />
::factor y : values from 0 to 10<br />
::factor xy : values from 0 to 10<br />
:Time factors :<br />
::factor x : values from 0 to 10<br />
::factor y : values from 0 to 10<br />
::factor xy : values from 0 to 10<br />
:Color factors :<br />
::r : values from 0 to 10<br />
::g : values from 0 to 10<br />
::b : values from 0 to 10<br />
:Zoom factor :<br />
::zoom values from 0 to 10<br />
<br />
For example we want to set all parameters above with values in order 1,2,3,4,5,6,7,8,9,10. Take in attention that each parameter is 1 byte we must make array of 32-bit values<br />
0x04030201, 0x08070605, 0x00000A09<br />
<br />
Example:<br />
mosaic_effect_settings = { 0x04030201, 0x08070605, 0x00000A09 };<br />
mosaic_effect_settings_length = 3;<br />
abi_CMD_DYNAMIC_TEXTURE(G2D_DYNAMIC_TEXTURE_MOSAIC , currentTime, mosaic_effect_settings, mosaic_effect_settings_length);<br />
<br />
===Motion sensors===<br />
====abi_MTD_GetFaceAccel(X/Y/Z)====<br />
Syntax:<br />
abi_MTD_GetFaceAccelX(const faceN)<br />
abi_MTD_GetFaceAccelY(const faceN)<br />
abi_MTD_GetFaceAccelZ(const faceN)<br />
Description:<br />
: Get the value of acceleration along the requested axis.<br />
Arguments<br />
: ''faceN''<br />
:: Number of the module face for which requested axis is belong.<br />
<br />
====abi_MTD_GetFaceGyro(X/Y/Z)====<br />
Syntax:<br />
abi_MTD_GetFaceGyroX(const faceN)<br />
abi_MTD_GetFaceGyroY(const faceN)<br />
abi_MTD_GetFaceGyroZ(const faceN)<br />
Description:<br />
: Get the gyro value around the requested axis.<br />
Arguments<br />
: ''faceN''<br />
:: Number of the module face for which requested axis is belong.<br />
<br />
====abi_MTD_GetTapFace====<br />
Syntax:<br />
abi_MTD_GetTapFace()<br />
Description:<br />
: Get the face ID which was tapped. ID is not a face number which is used for drawing in abi_CMD_G2D_BEGIN_DISPLAY or abi_CMD_REDRAW, but that number can be calculated by subtracting by one from ID value. See possible values below.<br />
Return values:<br />
: ''MTD_TAP_DIRECTION_NONE = 0''<br />
:: Indicates that the module wan not tapped.<br />
: ''MTD_TAP_DIRECTION_X = 1''<br />
: ''MTD_TAP_DIRECTION_Y = 2''<br />
: ''MTD_TAP_DIRECTION_Z = 3''<br />
:: Indicated direction of tap.<br />
<br />
====abi_MTD_IsTapOpposite====<br />
Syntax:<br />
abi_MTD_IsTapOpposite()<br />
Description:<br />
: Get the flag if the tap was detected in opposite direction.<br />
<br />
====abi_MTD_GetTapsCount====<br />
Syntax:<br />
abi_MTD_GetTapsCount()<br />
Description:<br />
: Get the count of subsequent taps. Tap is treated as a subsequent if it was detected within predefined interval (350ms). Count will be zero until sequence is finished, i.e. next tap is not detected within interval.<br />
<br />
====abi_checkShake====<br />
Syntax:<br />
abi_checkShake()<br />
Description:<br />
: Checks if the number of shakes of the cube was more than a certain threshold then exits the script <br />
<br />
<br />
====Examples====<br />
1. Flash the face on which tap was detected. Print an ID of that face. Color of the flash depends on taps count: red - one tap, green - two taps and blue - three.<br />
new delay = 0;<br />
new color = 0x000000; <br />
ONTICK() {<br />
if (!color) {<br />
switch (abi_MTD_GetTapsCount()) {<br />
case 1:<br />
color = 0xff0000;<br />
case 2:<br />
color = 0x00ff00;<br />
case 3:<br />
color = 0x0000ff;<br />
}<br />
}<br />
if (delay % 25 == 0) {<br />
for (new i = 0; i < FACES_MAX; i++) {<br />
if (i == (abi_MTD_GetTapFace() - 1)) {<br />
abi_CMD_FILL_2(color);<br />
color = 0x000000;<br />
switch (abi_MTD_GetTapFace()) {<br />
case 1:<br />
abi_CMD_TEXT(['1', '\0'], -1, 120, 120, 14, 0, 0xff, 0xff, 0xff);<br />
case 2:<br />
abi_CMD_TEXT(['2', '\0'], -1, 120, 120, 14, 0, 0xff, 0xff, 0xff);<br />
case 3:<br />
abi_CMD_TEXT(['3', '\0'], -1, 120, 120, 14, 0, 0xff, 0xff, 0xff);<br />
}<br />
} else {<br />
abi_CMD_FILL(0, 0, 0);<br />
}<br />
abi_CMD_REDRAW(i);<br />
}<br />
}<br />
delay++;<br />
}<br />
2. Exit from script<br />
ONTICK() {<br />
if (abi_cubeN == 0) {<br />
abi_checkShake();<br />
}<br />
// Script logic<br />
}<br />
<br />
===Save/load functions===<br />
<br />
====abi_CMD_SAVE_STATE====<br />
Syntax:<br />
bool:abi_CMD_SAVE_STATE(const data[], size = sizeof(data))<br />
Description:<br />
: Save maximum 256 bytes of data to wowcube flash memory.<br />
Arguments<br />
: ''data''<br />
:: Game data to save.<br />
: ''size''<br />
:: Size of game data.<br />
Return values:<br />
: ''return false''<br />
:: If size is bigger then 256 bytes.<br />
<br />
====abi_CMD_LOAD_STATE====<br />
Syntax:<br />
abi_CMD_LOAD_STATE()<br />
Description:<br />
: Sends a command requesting the platform to load script data. The response from the platform is not instantaneous and takes several milliseconds.<br />
<br />
====Examples====<br />
1. Load data at the start.<br />
// This function is called when a response is received from the platform<br />
ON_LOAD_GAME_DATA (const pkt[]) {<br />
// Deserialize pkt<br />
currentLevelNumber = pkt[1]; // Starting with 1 cause 0 pkt element holding command ID<br />
score = pkt[2];<br />
moves = pkt[3];<br />
...<br />
record = pkt[GAME_SAVE_SIZE];<br />
}<br />
ON_INIT () {<br />
abi_CMD_LOAD_STATE ();<br />
}<br />
<br />
2. Save the data after the end of the level.<br />
SaveGameState () {<br />
new saveData [GAME_SAVE_SIZE];<br />
// Assign all necessary data<br />
saveData[0] = currentLevelNumber;<br />
saveData[1] = score;<br />
saveData[2] = moves;<br />
...<br />
saveData[GAME_SAVE_SIZE - 1] = record;<br />
<br />
abi_CMD_SAVE_STATE (saveData);<br />
}<br />
ON_CHECK_ROTATE () {<br />
if (isLevelFinished) {<br />
SaveGameState();<br />
}<br />
}<br />
<br />
===Time functions===<br />
====abi_GetTime====<br />
Syntax:<br />
abi_GetTime()<br />
Description:<br />
: Get current time in milliseconds.<br />
<br />
====Examples====<br />
new previousTime = 0;<br />
new currentTime = 0;<br />
new deltaTime = 0;<br />
ON_INIT() {<br />
previousTime = abi_GetTime();<br />
}<br />
ONTICK() {<br />
currentTime = abi_GetTime();<br />
deltaTime = currentTime - previousTime;<br />
previousTime = currentTime;<br />
}<br />
<br />
<br />
===Topology functions===<br />
====get cube/face====<br />
Syntax:<br />
abi_topCubeN(const _cubeN, const _faceN)<br />
abi_topFaceN(const _cubeN, const _faceN)<br />
abi_rightCubeN(const _cubeN, const _faceN)<br />
abi_rightFaceN(const _cubeN, const _faceN)<br />
abi_bottomCubeN(const _cubeN, const _faceN)<br />
abi_bottomFaceN(const _cubeN, const _faceN)<br />
abi_leftCubeN(const _cubeN, const _faceN)<br />
abi_leftFaceN(const _cubeN, const _faceN)<br />
Description:<br />
: Returns the cube / screen located at the top / bottom / left / right of the specified in parameters.<br />
<br />
====Examples====<br />
Find diagonal face and cube<br />
new diagonalCube = CUBES_MAX;<br />
new diagonalFace = FACES_MAX;<br />
new topCube = abi_topCubeN(cube, face);<br />
new topFace = abi_topFaceN(cube, face);<br />
if (topCube < CUBES_MAX) {<br />
diagonalCube = abi_topCubeN(topCube, topFace);<br />
if (diagonalCube < CUBES_MAX) {<br />
diagonalFace = abi_topFaceN(topCube, topFace);<br />
}<br />
}<br />
<br />
<br />
===Sound functions===<br />
====abi_CMD_PLAYSND====<br />
Syntax:<br />
abi_CMD_PLAYSND(const id, const volume)<br />
Description:<br />
: Play chosen sound with a given volume.<br />
Arguments<br />
: ''id''<br />
:: Sound serial number in the application package.<br />
: ''volume''<br />
:: The sound volume.<br />
<br />
<br />
===Messages===<br />
====abi_CMD_NET_TX====<br />
Syntax:<br />
abi_CMD_NET_TX(const line_tx, const TTL, const data[])<br />
Description:<br />
: Send data through given UART line with given TTL. Ge<br />
Arguments<br />
: ''line_tx''<br />
:: UART line for sending a message. Each module has 3 UART lines.<br />
: ''TTL''<br />
:: Message time to live. How many modules message will pass through before stopping. For example, set TTL to 0 message will transfer only to the neighbor module. Set TTL to 1 message will transfer to a neighbor of neighbor. Maximum TTL is 2.<br />
: ''data''<br />
:: Data array to send. Maximum can be sent 20 bytes. The first 4 bytes are message general information that automatically adds before sending. The maximum useful data that can be sent are 16 bytes. Taking into account net command name 15 bytes.<br />
<br />
====Examples====<br />
We want to receive data only from 0 module<br />
<br />
// define net command<br />
#define NEW_TEST_NET_COMMAND P2P_CMD_BASE_SCRIPT_1 + 1<br />
<br />
// create message to send<br />
Send_Test_Message() {<br />
new data[4];<br />
data[0] = NEW_TEST_NET_COMMAND | (abi_cubeN << 8);<br />
data[1] = add_game_data;<br />
// using bitwise operations send more data<br />
data[2] = add_script_data_1 | (add_script_data_2 << 8) | (add_script_data_3 << 16) | (add_script_data_4 << 24);<br />
data[3] = add_game_data_1 | (add_game_data_2 << 16);<br />
<br />
// send message through UART<br />
abi_CMD_NET_TX(0, NET_BROADCAST_TTL_MAX, data);<br />
abi_CMD_NET_TX(1, NET_BROADCAST_TTL_MAX, data);<br />
abi_CMD_NET_TX(2, NET_BROADCAST_TTL_MAX, data);<br />
}<br />
<br />
// process the received message<br />
ON_CMD_NET_RX (const pkt[]) {<br />
// get 4 byte from incoming packet to get net command because first 4 bytes are general info<br />
switch (abi_ByteN(pkt, 4)) {<br />
case NEW_TEST_NET_COMMAND: {<br />
if (abi_ByteN(pkt, 5) == 0) {<br />
game_data = pkt[2];<br />
script_data_1 = abi_ByteN(pkt, 12);<br />
script_data_2 = abi_ByteN(pkt, 13);<br />
script_data_3 = abi_ByteN(pkt, 14);<br />
script_data_4 = abi_ByteN(pkt, 15);<br />
game_data_1 = pkt[4] & 0xFFFF;<br />
game_data_2 = (pkt[4] >> 16) & 0xFFFF;<br />
}<br />
}<br />
}<br />
}<br />
<br />
<br />
===Physics functions===<br />
====PHYSICS_CIRCLE_DATA====<br />
Syntax:<br />
#define PHYSICS_CIRCLE_DATA .posX, .posY, .simplePosX, .simplePosY, .spdX, .spdY, .mass, .radius, .CoR, .cube, .face, .cubeT, .faceT<br />
Description:<br />
: PAWN symbolic subscript which represent stucture.<br />
Fields<br />
: ''posX''<br />
:: Circle position on X axis (fixed point)<br />
: ''posY''<br />
:: Circle position on Y axis (fixed point)<br />
: ''simplePosX''<br />
:: Circle position on X axis<br />
: ''simplePosY''<br />
:: Circle position on Y axis<br />
: ''spdX''<br />
:: Circle X speed<br />
: ''spdY''<br />
:: Circle Y speed<br />
: ''mass''<br />
:: Circle mass (fixed point)<br />
: ''radius''<br />
:: Circle radius<br />
: ''CoR''<br />
:: Coefficient of restitution (fixed point)<br />
: ''cube''<br />
:: Module owner of this circle<br />
: ''face''<br />
:: Face owner of this circle<br />
: ''cubeT''<br />
:: Cube transfer, last module owner. Can be used for resending messages<br />
: ''faceT''<br />
:: Face transfer, last face owner. Can be used for resending messages</div>Raccoon piratehttps://wiki.wowcube.com/index.php?title=API&diff=181API2021-07-30T09:43:58Z<p>Raccoon pirate: /* Examples */</p>
<hr />
<div>{{notice|This is a beta version, API changes can be made without warning.}}<br />
<br />
=Introduction=<br />
<br />
The main functions of the API are listed here, the features of the work of the environment are described<br />
<br />
==WOWCube Paradigms==<br />
<br />
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.<br />
<br />
==Pawn API==<br />
===Graphic functions===<br />
<br />
====Graphics 2D acceleration (G2D)====<br />
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:<br />
[[File:Cascade.png|center|G2D cascading scheme]]<br />
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.<br />
Basic coordinate principle:<br />
[[File:G2d_coordinates.png|center|G2D coordinates sceme]]<br />
Coordinates are limited from -2048 to 2047. Maximum layers size is 240x240.<br />
<br />
=====abi_CMD_G2D_BEGIN_BITMAP=====<br />
Syntax:<br />
abi_CMD_G2D_BEGIN_BITMAP(const resID, const width, const height, const bool:replace)<br />
Description:<br />
: 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.<br />
Arguments:<br />
: ''resID''<br />
:: 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.<br />
: ''width'' <br />
:: Width of the resulting resource. G2D engine can keep resource of 240px width maximum.<br />
: ''height'' <br />
:: Height of the resulting resource. G2D engine can keep resource of 240px height maximum.<br />
: ''replace'' <br />
:: If true, then an existing image will be replaced completely, otherwise it will be overwritten by reusing itself as a background layer.<br />
<br />
=====abi_CMD_G2D_BEGIN_DISPLAY=====<br />
Syntax:<br />
abi_CMD_G2D_BEGIN_DISPLAY(const display, const bool:replace)<br />
Description:<br />
: 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.<br />
Arguments:<br />
: ''display''<br />
:: ID of the display which framebuffer will be used for blending. Each module have 3 displays with ID starting from 0.<br />
: ''replace'' <br />
:: If true then an existing image will be replaced completely, otherwise it will be overwritten by reusing itself as a background layer.<br />
<br />
=====abi_CMD_G2D_ADD_SPRITE=====<br />
Syntax:<br />
abi_CMD_G2D_ADD_SPRITE(const resID, const bool:g2d, const x, const y, const alpha, const color, const rotation, const mirror)<br />
Description:<br />
: Specifies game resource which will be used as a layer for blending.<br />
Arguments:<br />
: ''resID''<br />
:: ID of the resource to be uses as a layer.<br />
: ''g2d''<br />
:: Indicates if an internal G2D resource is specified or not.<br />
: ''x'', ''y''<br />
:: Coordinates of the bitmap center to place on the layer.<br />
: ''alpha''<br />
:: Layer transparency in range between 0x00 and 0xFF, where 0x00 is a fully transparent layer.<br />
: ''color''<br />
:: Layer's source key - a color in ARGB8888 format to be avoided.<br />
: ''rotation''<br />
:: Clockwise rotation angle in degrees. It is possible to specify free angle, but only right angles have HW acceleration. Currently rotation only applicable for external resources.<br />
: ''mirror''<br />
:: Mirroring variant. Possible values are self-explained: MIRROR_BLANK, MIRROR_X, MIRROR_Y, MIRROR_XY.<br />
<br />
=====abi_CMD_G2D_ADD_RECTANGLE=====<br />
Syntax:<br />
abi_CMD_G2D_ADD_RECTANGLE(const x, const y, const width, const height, const color)<br />
Description:<br />
: 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.<br />
Arguments:<br />
: ''x'', ''y''<br />
:: Coordinates of top left rectangle corner.<br />
: ''width''<br />
:: Rectangle width.<br />
: ''height''<br />
:: Rectangle height.<br />
: ''color''<br />
:: Rectangle color in ARGB8888 format.<br />
<br />
=====abi_CMD_G2D_END=====<br />
Syntax:<br />
abi_CMD_G2D_END()<br />
Description:<br />
: 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.<br />
<br />
=====Examples=====<br />
1. Render into inner G2D resource buffer #face and display it on the display #face. Please, note that last argument of abi_CMD_BITMAP is a `true` flag, which means G2D resource should be used:<br />
...<br />
abi_CMD_G2D_BEGIN_BITMAP(face, 240, 240, true);<br />
abi_CMD_G2D_ADD_RECTANGLE(120 - animationSquareSize0, 120 - animationSquareSize0, animationSquareSize0 * 2, animationSquareSize0 * 2, 0xdfff0000);<br />
abi_CMD_G2D_ADD_RECTANGLE(120 - animationSquareSize1, 120 - animationSquareSize1, animationSquareSize1 * 2, animationSquareSize1 * 2, 0xdfffff00);<br />
abi_CMD_G2D_ADD_RECTANGLE(120 - animationSquareSize2, 120 - animationSquareSize2, animationSquareSize2 * 2, animationSquareSize2 * 2, 0xdfff00ff);<br />
abi_CMD_G2D_ADD_RECTANGLE(120 - animationSquareSize3, 120 - animationSquareSize3, animationSquareSize3 * 2, animationSquareSize3 * 2, 0xdf00ffff);<br />
abi_CMD_G2D_ADD_SPRITE(resID, false, 120, 120, animationAlpha, 0x00000000, animationAngle, MIRROR_BLANK);<br />
abi_CMD_G2D_END();<br />
...<br />
abi_CMD_BITMAP(face, 120, 120, 0, MIRROR_BLANK, true);<br />
...<br />
abi_CMD_REDRAW(face);<br />
...<br />
2. Render directly into display framebuffer #face. This will produce same result on display as example #1, but the generated image is not saved:<br />
...<br />
abi_CMD_G2D_BEGIN_DISPLAY(face, true);<br />
abi_CMD_G2D_ADD_RECTANGLE(120 - animationSquareSize0, 120 - animationSquareSize0, animationSquareSize0 * 2, animationSquareSize0 * 2, 0xdfff0000);<br />
abi_CMD_G2D_ADD_RECTANGLE(120 - animationSquareSize1, 120 - animationSquareSize1, animationSquareSize1 * 2, animationSquareSize1 * 2, 0xdfffff00);<br />
abi_CMD_G2D_ADD_RECTANGLE(120 - animationSquareSize2, 120 - animationSquareSize2, animationSquareSize2 * 2, animationSquareSize2 * 2, 0xdfff00ff);<br />
abi_CMD_G2D_ADD_RECTANGLE(120 - animationSquareSize3, 120 - animationSquareSize3, animationSquareSize3 * 2, animationSquareSize3 * 2, 0xdf00ffff);<br />
abi_CMD_G2D_ADD_SPRITE(resID, false, 120, 120, animationAlpha, 0x00000000, animationAngle, MIRROR_BLANK);<br />
abi_CMD_G2D_END();<br />
...<br />
<br />
====Font drawing functions====<br />
=====abi_CMD_TEXT=====<br />
API:<br />
abi_CMD_TEXT(const text[], const fontResID, const x, const y, const scale, const angle, const r, const g, const b)<br />
Description:<br />
: Intended to render a system font or a custom font from resources with specified coordinates, scale and rotation at an arbitrary angle.<br />
Arguments:<br />
: ''text''<br />
:: Array of chars.<br />
: ''fontResID''<br />
:: Custom font resource identifier. Provide ''-1'' to use system font resource.<br />
: ''x'', ''y''<br />
:: Coordinates of top left rectangle corner.<br />
: ''scale'', ''angle''<br />
:: Percentage scale and clockwise rotation angle in degrees. Max size of font is 200x200 px. (scale = 100%)<br />
: ''r'', ''g'', ''b''<br />
:: Font color in RGB format.<br />
<br />
Example:<br />
new text[4] = ['A', 'p', 'p', '\0'];<br />
abi_CMD_TEXT(text, RES_ID_FONT, 90, 160, 16, current_angles[face], 255, 0, 0);<br />
<br />
====TEXTURE drawing functions====<br />
=====abi_CMD_DYNAMIC_TEXTURE=====<br />
<br />
API:<br />
<br />
abi_CMD_DYNAMIC_TEXTURE(const effectId = 1, const time = any value, const args[] = {0x04030201, 0x08070605, 0x00000A09}, const argsCount = 3, const bool:g2d = false)<br />
<br />
Description:<br />
: Render a texture with chosen algorithm and parameters.<br />
Arguments:<br />
: ''effectId''<br />
:: Define algorithm to render texture. <br />
:: Available values : G2D_DYNAMIC_TEXTURE_MOSAIC <br />
<br />
: ''time ''<br />
:: Current time value. Use any fixed value to static texture or set current time value in milliseconds to make texture alive.<br />
: ''args'', ''argsCount''<br />
:: Byte stream of algorithm settings it's aligned to 4 bytes, because of pawn supports only 32-bit values.<br />
:: Size of array depends on algorithm. For example mosaic algorithm has size of settings equals 10 bytes , so we must use aligned 4 bytes - 12 bytes array and argsCount = 3<br />
<br />
: ''g2d''<br />
:: false - Use pawn default buffer to draw texture.<br />
:: true - Use g2d buffer to draw texture - not supported now.<br />
<br />
'''G2D_DYNAMIC_TEXTURE_MOSAIC''' alogrithm description<br />
<br />
:So in effect named 'mosaic' we have settings of 10 parameters each one 1 byte<br />
<br />
:Noise factors :<br />
::factor x : values from 0 to 10<br />
::factor y : values from 0 to 10<br />
::factor xy : values from 0 to 10<br />
:Time factors :<br />
::factor x : values from 0 to 10<br />
::factor y : values from 0 to 10<br />
::factor xy : values from 0 to 10<br />
:Color factors :<br />
::r : values from 0 to 10<br />
::g : values from 0 to 10<br />
::b : values from 0 to 10<br />
:Zoom factor :<br />
::zoom values from 0 to 10<br />
<br />
For example we want to set all parameters above with values in order 1,2,3,4,5,6,7,8,9,10. Take in attention that each parameter is 1 byte we must make array of 32-bit values<br />
0x04030201, 0x08070605, 0x00000A09<br />
<br />
Example:<br />
mosaic_effect_settings = { 0x04030201, 0x08070605, 0x00000A09 };<br />
mosaic_effect_settings_length = 3;<br />
abi_CMD_DYNAMIC_TEXTURE(G2D_DYNAMIC_TEXTURE_MOSAIC , currentTime, mosaic_effect_settings, mosaic_effect_settings_length);<br />
<br />
===Motion sensors===<br />
====abi_MTD_GetFaceAccel(X/Y/Z)====<br />
Syntax:<br />
abi_MTD_GetFaceAccelX(const faceN)<br />
abi_MTD_GetFaceAccelY(const faceN)<br />
abi_MTD_GetFaceAccelZ(const faceN)<br />
Description:<br />
: Get the value of acceleration along the requested axis.<br />
Arguments<br />
: ''faceN''<br />
:: Number of the module face for which requested axis is belong.<br />
<br />
====abi_MTD_GetFaceGyro(X/Y/Z)====<br />
Syntax:<br />
abi_MTD_GetFaceGyroX(const faceN)<br />
abi_MTD_GetFaceGyroY(const faceN)<br />
abi_MTD_GetFaceGyroZ(const faceN)<br />
Description:<br />
: Get the gyro value around the requested axis.<br />
Arguments<br />
: ''faceN''<br />
:: Number of the module face for which requested axis is belong.<br />
<br />
====abi_MTD_GetTapFace====<br />
Syntax:<br />
abi_MTD_GetTapFace()<br />
Description:<br />
: Get the face ID which was tapped. ID is not a face number which is used for drawing in abi_CMD_G2D_BEGIN_DISPLAY or abi_CMD_REDRAW, but that number can be calculated by subtracting by one from ID value. See possible values below.<br />
Return values:<br />
: ''MTD_TAP_DIRECTION_NONE = 0''<br />
:: Indicates that the module wan not tapped.<br />
: ''MTD_TAP_DIRECTION_X = 1''<br />
: ''MTD_TAP_DIRECTION_Y = 2''<br />
: ''MTD_TAP_DIRECTION_Z = 3''<br />
:: Indicated direction of tap.<br />
<br />
====abi_MTD_IsTapOpposite====<br />
Syntax:<br />
abi_MTD_IsTapOpposite()<br />
Description:<br />
: Get the flag if the tap was detected in opposite direction.<br />
<br />
====abi_MTD_GetTapsCount====<br />
Syntax:<br />
abi_MTD_GetTapsCount()<br />
Description:<br />
: Get the count of subsequent taps. Tap is treated as a subsequent if it was detected within predefined interval (350ms). Count will be zero until sequence is finished, i.e. next tap is not detected within interval.<br />
<br />
====abi_checkShake====<br />
Syntax:<br />
abi_checkShake()<br />
Description:<br />
: Checks if the number of shakes of the cube was more than a certain threshold then exits the script <br />
<br />
<br />
====Examples====<br />
1. Flash the face on which tap was detected. Print an ID of that face. Color of the flash depends on taps count: red - one tap, green - two taps and blue - three.<br />
new delay = 0;<br />
new color = 0x000000; <br />
ONTICK() {<br />
if (!color) {<br />
switch (abi_MTD_GetTapsCount()) {<br />
case 1:<br />
color = 0xff0000;<br />
case 2:<br />
color = 0x00ff00;<br />
case 3:<br />
color = 0x0000ff;<br />
}<br />
}<br />
if (delay % 25 == 0) {<br />
for (new i = 0; i < FACES_MAX; i++) {<br />
if (i == (abi_MTD_GetTapFace() - 1)) {<br />
abi_CMD_FILL_2(color);<br />
color = 0x000000;<br />
switch (abi_MTD_GetTapFace()) {<br />
case 1:<br />
abi_CMD_TEXT(['1', '\0'], -1, 120, 120, 14, 0, 0xff, 0xff, 0xff);<br />
case 2:<br />
abi_CMD_TEXT(['2', '\0'], -1, 120, 120, 14, 0, 0xff, 0xff, 0xff);<br />
case 3:<br />
abi_CMD_TEXT(['3', '\0'], -1, 120, 120, 14, 0, 0xff, 0xff, 0xff);<br />
}<br />
} else {<br />
abi_CMD_FILL(0, 0, 0);<br />
}<br />
abi_CMD_REDRAW(i);<br />
}<br />
}<br />
delay++;<br />
}<br />
2. Exit from script<br />
ONTICK() {<br />
if (abi_cubeN == 0) {<br />
abi_checkShake();<br />
}<br />
// Script logic<br />
}<br />
<br />
===Save/load functions===<br />
<br />
====abi_CMD_SAVE_STATE====<br />
Syntax:<br />
bool:abi_CMD_SAVE_STATE(const data[], size = sizeof(data))<br />
Description:<br />
: Save maximum 256 bytes of data to wowcube flash memory.<br />
Arguments<br />
: ''data''<br />
:: Game data to save.<br />
: ''size''<br />
:: Size of game data.<br />
Return values:<br />
: ''return false''<br />
:: If size is bigger then 256 bytes.<br />
<br />
====abi_CMD_LOAD_STATE====<br />
Syntax:<br />
abi_CMD_LOAD_STATE()<br />
Description:<br />
: Sends a command requesting the platform to load script data. The response from the platform is not instantaneous and takes several milliseconds.<br />
<br />
====Examples====<br />
1. Load data at the start.<br />
// This function is called when a response is received from the platform<br />
ON_LOAD_GAME_DATA (const pkt[]) {<br />
// Deserialize pkt<br />
currentLevelNumber = pkt[1]; // Starting with 1 cause 0 pkt element holding command ID<br />
score = pkt[2];<br />
moves = pkt[3];<br />
...<br />
record = pkt[GAME_SAVE_SIZE];<br />
}<br />
ON_INIT () {<br />
abi_CMD_LOAD_STATE ();<br />
}<br />
<br />
2. Save the data after the end of the level.<br />
SaveGameState () {<br />
new saveData [GAME_SAVE_SIZE];<br />
// Assign all necessary data<br />
saveData[0] = currentLevelNumber;<br />
saveData[1] = score;<br />
saveData[2] = moves;<br />
...<br />
saveData[GAME_SAVE_SIZE - 1] = record;<br />
<br />
abi_CMD_SAVE_STATE (saveData);<br />
}<br />
ON_CHECK_ROTATE () {<br />
if (isLevelFinished) {<br />
SaveGameState();<br />
}<br />
}<br />
<br />
===Time functions===<br />
====abi_GetTime====<br />
Syntax:<br />
abi_GetTime()<br />
Description:<br />
: Get current time in milliseconds.<br />
<br />
====Examples====<br />
new previousTime = 0;<br />
new currentTime = 0;<br />
new deltaTime = 0;<br />
ON_INIT() {<br />
previousTime = abi_GetTime();<br />
}<br />
ONTICK() {<br />
currentTime = abi_GetTime();<br />
deltaTime = currentTime - previousTime;<br />
previousTime = currentTime;<br />
}<br />
<br />
<br />
===Topology functions===<br />
====get cube/face====<br />
Syntax:<br />
abi_topCubeN(const _cubeN, const _faceN)<br />
abi_topFaceN(const _cubeN, const _faceN)<br />
abi_rightCubeN(const _cubeN, const _faceN)<br />
abi_rightFaceN(const _cubeN, const _faceN)<br />
abi_bottomCubeN(const _cubeN, const _faceN)<br />
abi_bottomFaceN(const _cubeN, const _faceN)<br />
abi_leftCubeN(const _cubeN, const _faceN)<br />
abi_leftFaceN(const _cubeN, const _faceN)<br />
Description:<br />
: Returns the cube / screen located at the top / bottom / left / right of the specified in parameters.<br />
<br />
====Examples====<br />
Find diagonal face and cube<br />
new diagonalCube = CUBES_MAX;<br />
new diagonalFace = FACES_MAX;<br />
new topCube = abi_topCubeN(cube, face);<br />
new topFace = abi_topFaceN(cube, face);<br />
if (topCube < CUBES_MAX) {<br />
diagonalCube = abi_topCubeN(topCube, topFace);<br />
if (diagonalCube < CUBES_MAX) {<br />
diagonalFace = abi_topFaceN(topCube, topFace);<br />
}<br />
}<br />
<br />
<br />
===Sound functions===<br />
====abi_CMD_PLAYSND====<br />
Syntax:<br />
abi_CMD_PLAYSND(const id, const volume)<br />
Description:<br />
: Play chosen sound with a given volume.<br />
Arguments<br />
: ''id''<br />
:: Sound serial number in the application package.<br />
: ''volume''<br />
:: The sound volume.<br />
<br />
<br />
===Messages===<br />
====abi_CMD_NET_TX====<br />
Syntax:<br />
abi_CMD_NET_TX(const line_tx, const TTL, const data[])<br />
Description:<br />
: Send data through given UART line with given TTL. Ge<br />
Arguments<br />
: ''line_tx''<br />
:: UART line for sending a message. Each module has 3 UART lines.<br />
: ''TTL''<br />
:: Message time to live. How many modules message will pass through before stopping. For example, set TTL to 0 message will transfer only to the neighbor module. Set TTL to 1 message will transfer to a neighbor of neighbor. Maximum TTL is 2.<br />
: ''data''<br />
:: Data array to send. Maximum can be sent 20 bytes. The first 4 bytes are message general information that automatically adds before sending. The maximum useful data that can be sent are 16 bytes. Taking into account net command name 15 bytes.<br />
<br />
====Examples====<br />
We want to receive data only from 0 module<br />
<br />
// define net command<br />
#define NEW_TEST_NET_COMMAND P2P_CMD_BASE_SCRIPT_1 + 1<br />
<br />
// create message to send<br />
Send_Test_Message() {<br />
new data[4];<br />
data[0] = NEW_TEST_NET_COMMAND | (abi_cubeN << 8);<br />
data[1] = add_game_data;<br />
// using bitwise operations send more data<br />
data[2] = add_script_data_1 | (add_script_data_2 << 8) | (add_script_data_3 << 16) | (add_script_data_4 << 24);<br />
data[3] = add_game_data_1 | (add_game_data_2 << 16);<br />
<br />
// send message through UART<br />
abi_CMD_NET_TX(0, NET_BROADCAST_TTL_MAX, data);<br />
abi_CMD_NET_TX(1, NET_BROADCAST_TTL_MAX, data);<br />
abi_CMD_NET_TX(2, NET_BROADCAST_TTL_MAX, data);<br />
}<br />
<br />
// process the received message<br />
ON_CMD_NET_RX (const pkt[]) {<br />
// get 4 byte from incoming packet to get net command because first 4 bytes are general info<br />
switch (abi_ByteN(pkt, 4)) {<br />
case NEW_TEST_NET_COMMAND: {<br />
if (abi_ByteN(pkt, 5) == 0) {<br />
game_data = pkt[2];<br />
script_data_1 = abi_ByteN(pkt, 12);<br />
script_data_2 = abi_ByteN(pkt, 13);<br />
script_data_3 = abi_ByteN(pkt, 14);<br />
script_data_4 = abi_ByteN(pkt, 15);<br />
game_data_1 = pkt[4] & 0xFFFF;<br />
game_data_2 = (pkt[4] >> 16) & 0xFFFF;<br />
}<br />
}<br />
}<br />
}</div>Raccoon piratehttps://wiki.wowcube.com/index.php?title=API&diff=180API2021-07-30T09:30:57Z<p>Raccoon pirate: </p>
<hr />
<div>{{notice|This is a beta version, API changes can be made without warning.}}<br />
<br />
=Introduction=<br />
<br />
The main functions of the API are listed here, the features of the work of the environment are described<br />
<br />
==WOWCube Paradigms==<br />
<br />
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.<br />
<br />
==Pawn API==<br />
===Graphic functions===<br />
<br />
====Graphics 2D acceleration (G2D)====<br />
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:<br />
[[File:Cascade.png|center|G2D cascading scheme]]<br />
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.<br />
Basic coordinate principle:<br />
[[File:G2d_coordinates.png|center|G2D coordinates sceme]]<br />
Coordinates are limited from -2048 to 2047. Maximum layers size is 240x240.<br />
<br />
=====abi_CMD_G2D_BEGIN_BITMAP=====<br />
Syntax:<br />
abi_CMD_G2D_BEGIN_BITMAP(const resID, const width, const height, const bool:replace)<br />
Description:<br />
: 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.<br />
Arguments:<br />
: ''resID''<br />
:: 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.<br />
: ''width'' <br />
:: Width of the resulting resource. G2D engine can keep resource of 240px width maximum.<br />
: ''height'' <br />
:: Height of the resulting resource. G2D engine can keep resource of 240px height maximum.<br />
: ''replace'' <br />
:: If true, then an existing image will be replaced completely, otherwise it will be overwritten by reusing itself as a background layer.<br />
<br />
=====abi_CMD_G2D_BEGIN_DISPLAY=====<br />
Syntax:<br />
abi_CMD_G2D_BEGIN_DISPLAY(const display, const bool:replace)<br />
Description:<br />
: 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.<br />
Arguments:<br />
: ''display''<br />
:: ID of the display which framebuffer will be used for blending. Each module have 3 displays with ID starting from 0.<br />
: ''replace'' <br />
:: If true then an existing image will be replaced completely, otherwise it will be overwritten by reusing itself as a background layer.<br />
<br />
=====abi_CMD_G2D_ADD_SPRITE=====<br />
Syntax:<br />
abi_CMD_G2D_ADD_SPRITE(const resID, const bool:g2d, const x, const y, const alpha, const color, const rotation, const mirror)<br />
Description:<br />
: Specifies game resource which will be used as a layer for blending.<br />
Arguments:<br />
: ''resID''<br />
:: ID of the resource to be uses as a layer.<br />
: ''g2d''<br />
:: Indicates if an internal G2D resource is specified or not.<br />
: ''x'', ''y''<br />
:: Coordinates of the bitmap center to place on the layer.<br />
: ''alpha''<br />
:: Layer transparency in range between 0x00 and 0xFF, where 0x00 is a fully transparent layer.<br />
: ''color''<br />
:: Layer's source key - a color in ARGB8888 format to be avoided.<br />
: ''rotation''<br />
:: Clockwise rotation angle in degrees. It is possible to specify free angle, but only right angles have HW acceleration. Currently rotation only applicable for external resources.<br />
: ''mirror''<br />
:: Mirroring variant. Possible values are self-explained: MIRROR_BLANK, MIRROR_X, MIRROR_Y, MIRROR_XY.<br />
<br />
=====abi_CMD_G2D_ADD_RECTANGLE=====<br />
Syntax:<br />
abi_CMD_G2D_ADD_RECTANGLE(const x, const y, const width, const height, const color)<br />
Description:<br />
: 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.<br />
Arguments:<br />
: ''x'', ''y''<br />
:: Coordinates of top left rectangle corner.<br />
: ''width''<br />
:: Rectangle width.<br />
: ''height''<br />
:: Rectangle height.<br />
: ''color''<br />
:: Rectangle color in ARGB8888 format.<br />
<br />
=====abi_CMD_G2D_END=====<br />
Syntax:<br />
abi_CMD_G2D_END()<br />
Description:<br />
: 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.<br />
<br />
=====Examples=====<br />
1. Render into inner G2D resource buffer #face and display it on the display #face. Please, note that last argument of abi_CMD_BITMAP is a `true` flag, which means G2D resource should be used:<br />
...<br />
abi_CMD_G2D_BEGIN_BITMAP(face, 240, 240, true);<br />
abi_CMD_G2D_ADD_RECTANGLE(120 - animationSquareSize0, 120 - animationSquareSize0, animationSquareSize0 * 2, animationSquareSize0 * 2, 0xdfff0000);<br />
abi_CMD_G2D_ADD_RECTANGLE(120 - animationSquareSize1, 120 - animationSquareSize1, animationSquareSize1 * 2, animationSquareSize1 * 2, 0xdfffff00);<br />
abi_CMD_G2D_ADD_RECTANGLE(120 - animationSquareSize2, 120 - animationSquareSize2, animationSquareSize2 * 2, animationSquareSize2 * 2, 0xdfff00ff);<br />
abi_CMD_G2D_ADD_RECTANGLE(120 - animationSquareSize3, 120 - animationSquareSize3, animationSquareSize3 * 2, animationSquareSize3 * 2, 0xdf00ffff);<br />
abi_CMD_G2D_ADD_SPRITE(resID, false, 120, 120, animationAlpha, 0x00000000, animationAngle, MIRROR_BLANK);<br />
abi_CMD_G2D_END();<br />
...<br />
abi_CMD_BITMAP(face, 120, 120, 0, MIRROR_BLANK, true);<br />
...<br />
abi_CMD_REDRAW(face);<br />
...<br />
2. Render directly into display framebuffer #face. This will produce same result on display as example #1, but the generated image is not saved:<br />
...<br />
abi_CMD_G2D_BEGIN_DISPLAY(face, true);<br />
abi_CMD_G2D_ADD_RECTANGLE(120 - animationSquareSize0, 120 - animationSquareSize0, animationSquareSize0 * 2, animationSquareSize0 * 2, 0xdfff0000);<br />
abi_CMD_G2D_ADD_RECTANGLE(120 - animationSquareSize1, 120 - animationSquareSize1, animationSquareSize1 * 2, animationSquareSize1 * 2, 0xdfffff00);<br />
abi_CMD_G2D_ADD_RECTANGLE(120 - animationSquareSize2, 120 - animationSquareSize2, animationSquareSize2 * 2, animationSquareSize2 * 2, 0xdfff00ff);<br />
abi_CMD_G2D_ADD_RECTANGLE(120 - animationSquareSize3, 120 - animationSquareSize3, animationSquareSize3 * 2, animationSquareSize3 * 2, 0xdf00ffff);<br />
abi_CMD_G2D_ADD_SPRITE(resID, false, 120, 120, animationAlpha, 0x00000000, animationAngle, MIRROR_BLANK);<br />
abi_CMD_G2D_END();<br />
...<br />
<br />
====Font drawing functions====<br />
=====abi_CMD_TEXT=====<br />
API:<br />
abi_CMD_TEXT(const text[], const fontResID, const x, const y, const scale, const angle, const r, const g, const b)<br />
Description:<br />
: Intended to render a system font or a custom font from resources with specified coordinates, scale and rotation at an arbitrary angle.<br />
Arguments:<br />
: ''text''<br />
:: Array of chars.<br />
: ''fontResID''<br />
:: Custom font resource identifier. Provide ''-1'' to use system font resource.<br />
: ''x'', ''y''<br />
:: Coordinates of top left rectangle corner.<br />
: ''scale'', ''angle''<br />
:: Percentage scale and clockwise rotation angle in degrees. Max size of font is 200x200 px. (scale = 100%)<br />
: ''r'', ''g'', ''b''<br />
:: Font color in RGB format.<br />
<br />
Example:<br />
new text[4] = ['A', 'p', 'p', '\0'];<br />
abi_CMD_TEXT(text, RES_ID_FONT, 90, 160, 16, current_angles[face], 255, 0, 0);<br />
<br />
====TEXTURE drawing functions====<br />
=====abi_CMD_DYNAMIC_TEXTURE=====<br />
<br />
API:<br />
<br />
abi_CMD_DYNAMIC_TEXTURE(const effectId = 1, const time = any value, const args[] = {0x04030201, 0x08070605, 0x00000A09}, const argsCount = 3, const bool:g2d = false)<br />
<br />
Description:<br />
: Render a texture with chosen algorithm and parameters.<br />
Arguments:<br />
: ''effectId''<br />
:: Define algorithm to render texture. <br />
:: Available values : G2D_DYNAMIC_TEXTURE_MOSAIC <br />
<br />
: ''time ''<br />
:: Current time value. Use any fixed value to static texture or set current time value in milliseconds to make texture alive.<br />
: ''args'', ''argsCount''<br />
:: Byte stream of algorithm settings it's aligned to 4 bytes, because of pawn supports only 32-bit values.<br />
:: Size of array depends on algorithm. For example mosaic algorithm has size of settings equals 10 bytes , so we must use aligned 4 bytes - 12 bytes array and argsCount = 3<br />
<br />
: ''g2d''<br />
:: false - Use pawn default buffer to draw texture.<br />
:: true - Use g2d buffer to draw texture - not supported now.<br />
<br />
'''G2D_DYNAMIC_TEXTURE_MOSAIC''' alogrithm description<br />
<br />
:So in effect named 'mosaic' we have settings of 10 parameters each one 1 byte<br />
<br />
:Noise factors :<br />
::factor x : values from 0 to 10<br />
::factor y : values from 0 to 10<br />
::factor xy : values from 0 to 10<br />
:Time factors :<br />
::factor x : values from 0 to 10<br />
::factor y : values from 0 to 10<br />
::factor xy : values from 0 to 10<br />
:Color factors :<br />
::r : values from 0 to 10<br />
::g : values from 0 to 10<br />
::b : values from 0 to 10<br />
:Zoom factor :<br />
::zoom values from 0 to 10<br />
<br />
For example we want to set all parameters above with values in order 1,2,3,4,5,6,7,8,9,10. Take in attention that each parameter is 1 byte we must make array of 32-bit values<br />
0x04030201, 0x08070605, 0x00000A09<br />
<br />
Example:<br />
mosaic_effect_settings = { 0x04030201, 0x08070605, 0x00000A09 };<br />
mosaic_effect_settings_length = 3;<br />
abi_CMD_DYNAMIC_TEXTURE(G2D_DYNAMIC_TEXTURE_MOSAIC , currentTime, mosaic_effect_settings, mosaic_effect_settings_length);<br />
<br />
===Motion sensors===<br />
====abi_MTD_GetFaceAccel(X/Y/Z)====<br />
Syntax:<br />
abi_MTD_GetFaceAccelX(const faceN)<br />
abi_MTD_GetFaceAccelY(const faceN)<br />
abi_MTD_GetFaceAccelZ(const faceN)<br />
Description:<br />
: Get the value of acceleration along the requested axis.<br />
Arguments<br />
: ''faceN''<br />
:: Number of the module face for which requested axis is belong.<br />
<br />
====abi_MTD_GetFaceGyro(X/Y/Z)====<br />
Syntax:<br />
abi_MTD_GetFaceGyroX(const faceN)<br />
abi_MTD_GetFaceGyroY(const faceN)<br />
abi_MTD_GetFaceGyroZ(const faceN)<br />
Description:<br />
: Get the gyro value around the requested axis.<br />
Arguments<br />
: ''faceN''<br />
:: Number of the module face for which requested axis is belong.<br />
<br />
====abi_MTD_GetTapFace====<br />
Syntax:<br />
abi_MTD_GetTapFace()<br />
Description:<br />
: Get the face ID which was tapped. ID is not a face number which is used for drawing in abi_CMD_G2D_BEGIN_DISPLAY or abi_CMD_REDRAW, but that number can be calculated by subtracting by one from ID value. See possible values below.<br />
Return values:<br />
: ''MTD_TAP_DIRECTION_NONE = 0''<br />
:: Indicates that the module wan not tapped.<br />
: ''MTD_TAP_DIRECTION_X = 1''<br />
: ''MTD_TAP_DIRECTION_Y = 2''<br />
: ''MTD_TAP_DIRECTION_Z = 3''<br />
:: Indicated direction of tap.<br />
<br />
====abi_MTD_IsTapOpposite====<br />
Syntax:<br />
abi_MTD_IsTapOpposite()<br />
Description:<br />
: Get the flag if the tap was detected in opposite direction.<br />
<br />
====abi_MTD_GetTapsCount====<br />
Syntax:<br />
abi_MTD_GetTapsCount()<br />
Description:<br />
: Get the count of subsequent taps. Tap is treated as a subsequent if it was detected within predefined interval (350ms). Count will be zero until sequence is finished, i.e. next tap is not detected within interval.<br />
<br />
====abi_checkShake====<br />
Syntax:<br />
abi_checkShake()<br />
Description:<br />
: Checks if the number of shakes of the cube was more than a certain threshold then exits the script <br />
<br />
<br />
====Examples====<br />
1. Flash the face on which tap was detected. Print an ID of that face. Color of the flash depends on taps count: red - one tap, green - two taps and blue - three.<br />
new delay = 0;<br />
new color = 0x000000; <br />
ONTICK() {<br />
if (!color) {<br />
switch (abi_MTD_GetTapsCount()) {<br />
case 1:<br />
color = 0xff0000;<br />
case 2:<br />
color = 0x00ff00;<br />
case 3:<br />
color = 0x0000ff;<br />
}<br />
}<br />
if (delay % 25 == 0) {<br />
for (new i = 0; i < FACES_MAX; i++) {<br />
if (i == (abi_MTD_GetTapFace() - 1)) {<br />
abi_CMD_FILL_2(color);<br />
color = 0x000000;<br />
switch (abi_MTD_GetTapFace()) {<br />
case 1:<br />
abi_CMD_TEXT(['1', '\0'], -1, 120, 120, 14, 0, 0xff, 0xff, 0xff);<br />
case 2:<br />
abi_CMD_TEXT(['2', '\0'], -1, 120, 120, 14, 0, 0xff, 0xff, 0xff);<br />
case 3:<br />
abi_CMD_TEXT(['3', '\0'], -1, 120, 120, 14, 0, 0xff, 0xff, 0xff);<br />
}<br />
} else {<br />
abi_CMD_FILL(0, 0, 0);<br />
}<br />
abi_CMD_REDRAW(i);<br />
}<br />
}<br />
delay++;<br />
}<br />
2. Exit from script<br />
ONTICK() {<br />
if (abi_cubeN == 0) {<br />
abi_checkShake();<br />
}<br />
// Script logic<br />
}<br />
<br />
===Save/load functions===<br />
<br />
====abi_CMD_SAVE_STATE====<br />
Syntax:<br />
bool:abi_CMD_SAVE_STATE(const data[], size = sizeof(data))<br />
Description:<br />
: Save maximum 256 bytes of data to wowcube flash memory.<br />
Arguments<br />
: ''data''<br />
:: Game data to save.<br />
: ''size''<br />
:: Size of game data.<br />
Return values:<br />
: ''return false''<br />
:: If size is bigger then 256 bytes.<br />
<br />
====abi_CMD_LOAD_STATE====<br />
Syntax:<br />
abi_CMD_LOAD_STATE()<br />
Description:<br />
: Sends a command requesting the platform to load script data. The response from the platform is not instantaneous and takes several milliseconds.<br />
<br />
====Examples====<br />
1. Load data at the start.<br />
// This function is called when a response is received from the platform<br />
ON_LOAD_GAME_DATA (const pkt[]) {<br />
// Deserialize pkt<br />
currentLevelNumber = pkt[1]; // Starting with 1 cause 0 pkt element holding command ID<br />
score = pkt[2];<br />
moves = pkt[3];<br />
...<br />
record = pkt[GAME_SAVE_SIZE];<br />
}<br />
ON_INIT () {<br />
abi_CMD_LOAD_STATE ();<br />
}<br />
<br />
2. Save the data after the end of the level.<br />
SaveGameState () {<br />
new saveData [GAME_SAVE_SIZE];<br />
// Assign all necessary data<br />
saveData[0] = currentLevelNumber;<br />
saveData[1] = score;<br />
saveData[2] = moves;<br />
...<br />
saveData[GAME_SAVE_SIZE - 1] = record;<br />
<br />
abi_CMD_SAVE_STATE (saveData);<br />
}<br />
ON_CHECK_ROTATE () {<br />
if (isLevelFinished) {<br />
SaveGameState();<br />
}<br />
}<br />
<br />
===Time functions===<br />
====abi_GetTime====<br />
Syntax:<br />
abi_GetTime()<br />
Description:<br />
: Get current time in milliseconds.<br />
<br />
====Examples====<br />
new previousTime = 0;<br />
new currentTime = 0;<br />
new deltaTime = 0;<br />
ON_INIT() {<br />
previousTime = abi_GetTime();<br />
}<br />
ONTICK() {<br />
currentTime = abi_GetTime();<br />
deltaTime = currentTime - previousTime;<br />
previousTime = currentTime;<br />
}<br />
<br />
<br />
===Topology functions===<br />
====get cube/face====<br />
Syntax:<br />
abi_topCubeN(const _cubeN, const _faceN)<br />
abi_topFaceN(const _cubeN, const _faceN)<br />
abi_rightCubeN(const _cubeN, const _faceN)<br />
abi_rightFaceN(const _cubeN, const _faceN)<br />
abi_bottomCubeN(const _cubeN, const _faceN)<br />
abi_bottomFaceN(const _cubeN, const _faceN)<br />
abi_leftCubeN(const _cubeN, const _faceN)<br />
abi_leftFaceN(const _cubeN, const _faceN)<br />
Description:<br />
: Returns the cube / screen located at the top / bottom / left / right of the specified in parameters.<br />
<br />
====Examples====<br />
Find diagonal face and cube<br />
new diagonalCube = CUBES_MAX;<br />
new diagonalFace = FACES_MAX;<br />
new topCube = abi_topCubeN(cube, face);<br />
new topFace = abi_topFaceN(cube, face);<br />
if (topCube < CUBES_MAX) {<br />
diagonalCube = abi_topCubeN(topCube, topFace);<br />
if (diagonalCube < CUBES_MAX) {<br />
diagonalFace = abi_topFaceN(topCube, topFace);<br />
}<br />
}<br />
<br />
<br />
===Sound functions===<br />
====abi_CMD_PLAYSND====<br />
Syntax:<br />
abi_CMD_PLAYSND(const id, const volume)<br />
Description:<br />
: Play chosen sound with a given volume.<br />
Arguments<br />
: ''id''<br />
:: Sound serial number in the application package.<br />
: ''volume''<br />
:: The sound volume.<br />
<br />
<br />
===Messages===<br />
====abi_CMD_NET_TX====<br />
Syntax:<br />
abi_CMD_NET_TX(const line_tx, const TTL, const data[])<br />
Description:<br />
: Send data through given UART line with given TTL. Ge<br />
Arguments<br />
: ''line_tx''<br />
:: UART line for sending a message. Each module has 3 UART lines.<br />
: ''TTL''<br />
:: Message time to live. How many modules message will pass through before stopping. For example, set TTL to 0 message will transfer only to the neighbor module. Set TTL to 1 message will transfer to a neighbor of neighbor. Maximum TTL is 2.<br />
: ''data''<br />
:: Data array to send. Maximum can be sent 20 bytes. The first 4 bytes are message general information that automatically adds before sending. The maximum useful data that can be sent are 16 bytes. Taking into account net command name 15 bytes.<br />
<br />
====Examples====<br />
// define net command<br />
#define NEW_TEST_NET_COMMAND P2P_CMD_BASE_SCRIPT_1 + 1<br />
<br />
// create message to send<br />
Send_Test_Message() {<br />
new data[4];<br />
data[0] = NEW_TEST_NET_COMMAND | (abi_cubeN << 8);<br />
data[1] = add_game_data;<br />
// using bitwise operations send more data<br />
data[2] = add_script_data_1 | (add_script_data_2 << 8) | (add_script_data_3 << 16) | (add_script_data_4 << 24);<br />
data[3] = add_game_data_1 | (add_game_data_2 << 16);<br />
<br />
// send message through UART<br />
abi_CMD_NET_TX(0, NET_BROADCAST_TTL_MAX, data);<br />
abi_CMD_NET_TX(1, NET_BROADCAST_TTL_MAX, data);<br />
abi_CMD_NET_TX(2, NET_BROADCAST_TTL_MAX, data);<br />
}<br />
<br />
// process the received message<br />
ON_CMD_NET_RX (const pkt[]) {<br />
// get 4 byte from incoming packet to get net command because first 4 bytes are general info<br />
switch (abi_ByteN(pkt, 4)) {<br />
case NEW_TEST_NET_COMMAND: {<br />
if (abi_ByteN(pkt, 5) == 0) {<br />
game_data = pkt[2];<br />
script_data_1 = abi_ByteN(pkt, 12);<br />
script_data_2 = abi_ByteN(pkt, 13);<br />
script_data_3 = abi_ByteN(pkt, 14);<br />
script_data_4 = abi_ByteN(pkt, 15);<br />
game_data_1 = pkt[4] & 0xFFFF;<br />
game_data_2 = (pkt[4] >> 16) & 0xFFFF;<br />
}<br />
}<br />
}<br />
}</div>Raccoon piratehttps://wiki.wowcube.com/index.php?title=SDK&diff=177SDK2021-06-22T11:51:37Z<p>Raccoon pirate: /* General settings */</p>
<hr />
<div>SDK/Framework<br />
<br />
*[[pawn]]<br />
<br />
==WOWCube Emulator installation==<br />
<br />
===Windows===<br />
Launch the wowcube-sdk.exe installer and follow the steps of the installer.<br />
<br />
Installing Dependencies (for Pawn Application Developers) <br />
To run scripts written in the Pawn language, you need to install Python 3, Pip, IntelHex, and Pillow.<br />
<br />
<br />
'''Installing Python'''<br />
<br />
Go to the site https://www.python.org/downloads/windows/, click on the "Latest Python 3 Release" link, wait for the download to complete.<br />
[[File:Highlight_Latest_Python_3_Release_link.png]]<br />
<br />
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".<br />
[[File:Python_installation_configuration.png]]<br />
<br />
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.<br />
[[File:Python_disable_path_length_limit.png]]<br />
<br />
<br />
'''Installing libraries'''<br />
<br />
To install the dependencies, you need to start the terminal. Go to Start menu (or press Windows key + X) and select Windows PowerShell.<br />
<br />
[[File:Start_menu_with_PowerShell.png]]<br />
<br />
Type command "pip install intelhex pillow" and press enter. <br />
[[File:Intelhex_and_pillow_installation.png]]<br />
<br />
This command will download and install the IntelHex and Pillow dependencies. If the installation is successful, a corresponding message will be displayed. <br />
<br />
If your company uses a proxy, then you need to add the --proxy option to the command above. The option has the following format:<br />
<br />
[user: password @] proxy.server: port<br />
<br />
For example:<br />
<br />
''pip install --proxy = http: //proxy.jf.intel.com: 911 intelhex pillow''<br />
<br />
===macOS===<br />
<br />
Open the .dmg file, drag the WOWCube Emulator application into the Applications folder. <br />
[[File:Installation_on_macOS.png]]<br />
<br />
If the .dmg file was downloaded not in the App Store, then an error will pop up when starting the application.<br />
[[File:Error_message_macOS_emulator_installation.png]]<br />
<br />
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.<br />
<br />
[[File:Terminal_window_in_macOS.png]]<br />
<br />
In the terminal, write the command ''/ Applications / WOWCube \ Emulator.app/Contents/MacOS/bin/wowcube'' and press enter.<br />
<br />
If the following error occurs<br />
<br />
''/ usr / bin / env: bad interpreter: Operation not permitted, or zsh: operation not permitted: / Applications / WOWCube Emulator.app/Contents/MacOS/bin/wowcube''<br />
<br />
Then run the following command ''xattr -rd com.apple.quarantine / Applications / WOWCube \ Emulator.app/''. It will output errors Permission Denied, but they are expected.<br />
<br />
<br />
'''Installing Python'''<br />
<br />
For macOS version below Catalina open a terminal, install and download Homebrew<br />
<br />
''/ bin / bash -c "$ (curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"''<br />
<br />
Homebrew is a package manager that lets you install Open Source applications.<br />
<br />
Next, install Python 3 and Pip<br />
<br />
''brew install python3''<br />
<br />
''brew cask install python3''<br />
<br />
<br />
For macOS by Catalina. First you need to make sure that python is installed and that it is the correct version.<br />
<br />
''python3 -V''<br />
<br />
This command should print “Python 3.x.x”. If the command did not display anything, or was not found, try to execute<br />
<br />
''python -V''<br />
<br />
If it displays “Python 2.x.x”, then Python 3 is not installed.<br />
<br />
<br />
Install pip:<br />
<br />
''curl -fsSL https://bootstrap.pypa.io/get-pip.py | python3''<br />
<br />
[[File:Check_for_python_and_installing_pip.png]]<br />
<br />
<br />
'''Installing labraries'''<br />
<br />
Install IntelHex and Pillow libraries.<br />
<br />
''pip3 install pillow intelhex''<br />
<br />
==Starting WOWCube Emulator==<br />
<br />
===Windows===<br />
<br />
Launch WOWCube Emulator by clicking on shortcut on desktop.<br />
<br />
[[File:WOWCube_Emulator_shortcut_windows.png]]<br />
<br />
On first launch, a warning from the firewall will appear.<br />
<br />
[[File:Windows_security_alert_first_emulator_launch.png]]<br />
<br />
Allow access. WOWCube Emulator uses local ports for communication between the processes it creates, as well as for projector mode.<br />
<br />
===macOS===<br />
<br />
Open terminal and enter ''WOWCube Emulator'' then and press Enter.<br />
<br />
==WOWCube Emulator interface==<br />
<br />
===General view===<br />
<br />
There are 4 main groups of widgets in the WOWCube Emulator interface.<br />
<br />
[[File:WOWCube_Emulator_UI.png]]<br />
<br />
===Cube model interactions===<br />
<br />
Contains links for interacting with the cube module. Buttons from left to right:<br />
<br />
* simulates the shaking of a cube<br />
* returns the cube module to its original state (restoring rotations and position)<br />
* open code redactor (does not work in version 2.2.0 and below)<br />
* rotates a random side of the cube<br />
<br />
===Emulation progress control===<br />
<br />
Serves to interact with the progress of the script. Buttons from left to right:<br />
<br />
* start emulation of the selected pawn script. Аfter startup is replaced by the emulation restart button<br />
* stops pawn script emulation<br />
* loading a script to a physical cube using the bluetooth protocol (does not work in version 2.2.0 and below)<br />
<br />
===General settings===<br />
<br />
====Project tab====<br />
<br />
In this tab you can choose one of two modes of operation:<br />
<br />
* Pawn;<br />
* Projector.<br />
<br />
''Projector mode''<br />
<br />
The projector is used to transfer images from a computer or mobile device to the WOWCube via the Bluetooth protocol.<br />
<br />
The projector in the WOWCube Emulator is used for prototyping and faster development of web-projector applications.<br />
<br />
''Pawn Mode''<br />
<br />
In this mode, you can:<br />
<br />
* select the path to the projects folder<br />
* select a startup project<br />
* view additional data for a running project<br />
<br />
====View tab====<br />
<br />
The Sound adjusts the overall volume.<br />
<br />
[[File:WOWCube_Emulator_view_tab_sound.png]]<br />
<br />
In the Emulation, the transparency of the overlay is adjusted. The overlay displays on each module its current number, screen and adjacent modules.<br />
<br />
The Limit FPS slider allows you to limit the frame rate in the application running on the emulator.<br />
<br />
If necessary, it is possible to configure the simulation of lost packets during transmission.<br />
<br />
[[File:WOWCube_Emulator_view_tab_emulation.png]]<br />
<br />
In the CubeNet, the transparency and the size of the cube unfolding are configured.<br />
<br />
[[File:WOWCube_Emulator_view_tab_CubeNet.png]]<br />
<br />
In the Scene, the removal of the camera, the field of view, the backdrop are configured.<br />
<br />
ABI calls - displays abi function calls to the console.<br />
<br />
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.<br />
<br />
[[File:WOWCube_Emulator_view_tab_scene.png]]<br />
<br />
====Settings Tab====<br />
<br />
This is where the PAWN compiler path and python path are selected. <br />
<br />
[[File:WOWCube_Emulator_settings_tab.png]]<br />
<br />
===Console and logs===<br />
<br />
Contains tabs for displaying script assembly logs and tabs with the console of each module separately.<br />
<br />
===Controls===<br />
<br />
LMB on a cube - rotation of the sides.<br />
<br />
RMB (or Ctrl + LMB) on a cube - tilt the cube.<br />
<br />
RMB (or Ctrl + LMB) past the cube - rotate the camera.<br />
<br />
Mouse wheel - zoom out / zoom in the camera.<br />
<br />
==Quick start==<br />
<br />
Go to https://github.com/wowcube/WOWCube_apps_examples<br />
<br />
Clone or download to the necessary folder.<br />
<br />
Launch WOWCube Emulator.<br />
<br />
In ''Project'' tab switch Pawn mode.<br />
<br />
Specify ''Project path'' to the folder with examples.<br />
<br />
[[File:WOWCube_emulator_path_to_examples.png]]<br />
<br />
Under ''Run configuration'' choose example project.<br />
<br />
[[File:WOWCube_emulator_choose_example.png]]<br />
<br />
You can press 'i' button to watch what resources loaded for each script<br />
<br />
[[File:WOWCube_emulator_resources_for_scripts.png]]<br />
<br />
Press ''Start button'' to launch emulation<br />
<br />
[[File:WOWCube_emulator_launched_first_example.png]]<br />
<br />
In order to make changes in examples you need:<br />
<br />
* Go to folder where your WOWCube examples located<br />
* Open file 'example1.pwn' with any text redactor<br />
* make what changes you need</div>Raccoon piratehttps://wiki.wowcube.com/index.php?title=SDK&diff=176SDK2021-06-22T11:50:27Z<p>Raccoon pirate: /* WOWCube Emulator interface */</p>
<hr />
<div>SDK/Framework<br />
<br />
*[[pawn]]<br />
<br />
==WOWCube Emulator installation==<br />
<br />
===Windows===<br />
Launch the wowcube-sdk.exe installer and follow the steps of the installer.<br />
<br />
Installing Dependencies (for Pawn Application Developers) <br />
To run scripts written in the Pawn language, you need to install Python 3, Pip, IntelHex, and Pillow.<br />
<br />
<br />
'''Installing Python'''<br />
<br />
Go to the site https://www.python.org/downloads/windows/, click on the "Latest Python 3 Release" link, wait for the download to complete.<br />
[[File:Highlight_Latest_Python_3_Release_link.png]]<br />
<br />
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".<br />
[[File:Python_installation_configuration.png]]<br />
<br />
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.<br />
[[File:Python_disable_path_length_limit.png]]<br />
<br />
<br />
'''Installing libraries'''<br />
<br />
To install the dependencies, you need to start the terminal. Go to Start menu (or press Windows key + X) and select Windows PowerShell.<br />
<br />
[[File:Start_menu_with_PowerShell.png]]<br />
<br />
Type command "pip install intelhex pillow" and press enter. <br />
[[File:Intelhex_and_pillow_installation.png]]<br />
<br />
This command will download and install the IntelHex and Pillow dependencies. If the installation is successful, a corresponding message will be displayed. <br />
<br />
If your company uses a proxy, then you need to add the --proxy option to the command above. The option has the following format:<br />
<br />
[user: password @] proxy.server: port<br />
<br />
For example:<br />
<br />
''pip install --proxy = http: //proxy.jf.intel.com: 911 intelhex pillow''<br />
<br />
===macOS===<br />
<br />
Open the .dmg file, drag the WOWCube Emulator application into the Applications folder. <br />
[[File:Installation_on_macOS.png]]<br />
<br />
If the .dmg file was downloaded not in the App Store, then an error will pop up when starting the application.<br />
[[File:Error_message_macOS_emulator_installation.png]]<br />
<br />
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.<br />
<br />
[[File:Terminal_window_in_macOS.png]]<br />
<br />
In the terminal, write the command ''/ Applications / WOWCube \ Emulator.app/Contents/MacOS/bin/wowcube'' and press enter.<br />
<br />
If the following error occurs<br />
<br />
''/ usr / bin / env: bad interpreter: Operation not permitted, or zsh: operation not permitted: / Applications / WOWCube Emulator.app/Contents/MacOS/bin/wowcube''<br />
<br />
Then run the following command ''xattr -rd com.apple.quarantine / Applications / WOWCube \ Emulator.app/''. It will output errors Permission Denied, but they are expected.<br />
<br />
<br />
'''Installing Python'''<br />
<br />
For macOS version below Catalina open a terminal, install and download Homebrew<br />
<br />
''/ bin / bash -c "$ (curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"''<br />
<br />
Homebrew is a package manager that lets you install Open Source applications.<br />
<br />
Next, install Python 3 and Pip<br />
<br />
''brew install python3''<br />
<br />
''brew cask install python3''<br />
<br />
<br />
For macOS by Catalina. First you need to make sure that python is installed and that it is the correct version.<br />
<br />
''python3 -V''<br />
<br />
This command should print “Python 3.x.x”. If the command did not display anything, or was not found, try to execute<br />
<br />
''python -V''<br />
<br />
If it displays “Python 2.x.x”, then Python 3 is not installed.<br />
<br />
<br />
Install pip:<br />
<br />
''curl -fsSL https://bootstrap.pypa.io/get-pip.py | python3''<br />
<br />
[[File:Check_for_python_and_installing_pip.png]]<br />
<br />
<br />
'''Installing labraries'''<br />
<br />
Install IntelHex and Pillow libraries.<br />
<br />
''pip3 install pillow intelhex''<br />
<br />
==Starting WOWCube Emulator==<br />
<br />
===Windows===<br />
<br />
Launch WOWCube Emulator by clicking on shortcut on desktop.<br />
<br />
[[File:WOWCube_Emulator_shortcut_windows.png]]<br />
<br />
On first launch, a warning from the firewall will appear.<br />
<br />
[[File:Windows_security_alert_first_emulator_launch.png]]<br />
<br />
Allow access. WOWCube Emulator uses local ports for communication between the processes it creates, as well as for projector mode.<br />
<br />
===macOS===<br />
<br />
Open terminal and enter ''WOWCube Emulator'' then and press Enter.<br />
<br />
==WOWCube Emulator interface==<br />
<br />
===General view===<br />
<br />
There are 4 main groups of widgets in the WOWCube Emulator interface.<br />
<br />
[[File:WOWCube_Emulator_UI.png]]<br />
<br />
===Cube model interactions===<br />
<br />
Contains links for interacting with the cube module. Buttons from left to right:<br />
<br />
* simulates the shaking of a cube<br />
* returns the cube module to its original state (restoring rotations and position)<br />
* open code redactor (does not work in version 2.2.0 and below)<br />
* rotates a random side of the cube<br />
<br />
===Emulation progress control===<br />
<br />
Serves to interact with the progress of the script. Buttons from left to right:<br />
<br />
* start emulation of the selected pawn script. Аfter startup is replaced by the emulation restart button<br />
* stops pawn script emulation<br />
* loading a script to a physical cube using the bluetooth protocol (does not work in version 2.2.0 and below)<br />
<br />
===General settings===<br />
<br />
'''''Project tab'''''<br />
<br />
In this tab you can choose one of two modes of operation:<br />
<br />
* Pawn;<br />
* Projector.<br />
<br />
''Projector mode''<br />
<br />
The projector is used to transfer images from a computer or mobile device to the WOWCube via the Bluetooth protocol.<br />
<br />
The projector in the WOWCube Emulator is used for prototyping and faster development of web-projector applications.<br />
<br />
''Pawn Mode''<br />
<br />
In this mode, you can:<br />
<br />
* select the path to the projects folder<br />
* select a startup project<br />
* view additional data for a running project<br />
<br />
'''''View tab'''''<br />
<br />
The Sound adjusts the overall volume.<br />
<br />
[[File:WOWCube_Emulator_view_tab_sound.png]]<br />
<br />
In the Emulation, the transparency of the overlay is adjusted. The overlay displays on each module its current number, screen and adjacent modules.<br />
<br />
The Limit FPS slider allows you to limit the frame rate in the application running on the emulator.<br />
<br />
If necessary, it is possible to configure the simulation of lost packets during transmission.<br />
<br />
[[File:WOWCube_Emulator_view_tab_emulation.png]]<br />
<br />
In the CubeNet, the transparency and the size of the cube unfolding are configured.<br />
<br />
[[File:WOWCube_Emulator_view_tab_CubeNet.png]]<br />
<br />
In the Scene, the removal of the camera, the field of view, the backdrop are configured.<br />
<br />
ABI calls - displays abi function calls to the console.<br />
<br />
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.<br />
<br />
[[File:WOWCube_Emulator_view_tab_scene.png]]<br />
<br />
'''''Settings Tab'''''<br />
<br />
This is where the PAWN compiler path and python path are selected. <br />
<br />
[[File:WOWCube_Emulator_settings_tab.png]]<br />
<br />
===Console and logs===<br />
<br />
Contains tabs for displaying script assembly logs and tabs with the console of each module separately.<br />
<br />
===Controls===<br />
<br />
LMB on a cube - rotation of the sides.<br />
<br />
RMB (or Ctrl + LMB) on a cube - tilt the cube.<br />
<br />
RMB (or Ctrl + LMB) past the cube - rotate the camera.<br />
<br />
Mouse wheel - zoom out / zoom in the camera.<br />
<br />
==Quick start==<br />
<br />
Go to https://github.com/wowcube/WOWCube_apps_examples<br />
<br />
Clone or download to the necessary folder.<br />
<br />
Launch WOWCube Emulator.<br />
<br />
In ''Project'' tab switch Pawn mode.<br />
<br />
Specify ''Project path'' to the folder with examples.<br />
<br />
[[File:WOWCube_emulator_path_to_examples.png]]<br />
<br />
Under ''Run configuration'' choose example project.<br />
<br />
[[File:WOWCube_emulator_choose_example.png]]<br />
<br />
You can press 'i' button to watch what resources loaded for each script<br />
<br />
[[File:WOWCube_emulator_resources_for_scripts.png]]<br />
<br />
Press ''Start button'' to launch emulation<br />
<br />
[[File:WOWCube_emulator_launched_first_example.png]]<br />
<br />
In order to make changes in examples you need:<br />
<br />
* Go to folder where your WOWCube examples located<br />
* Open file 'example1.pwn' with any text redactor<br />
* make what changes you need</div>Raccoon piratehttps://wiki.wowcube.com/index.php?title=SDK&diff=175SDK2021-06-22T10:59:03Z<p>Raccoon pirate: /* WOWCube Emulator interface */</p>
<hr />
<div>SDK/Framework<br />
<br />
*[[pawn]]<br />
<br />
==WOWCube Emulator installation==<br />
<br />
===Windows===<br />
Launch the wowcube-sdk.exe installer and follow the steps of the installer.<br />
<br />
Installing Dependencies (for Pawn Application Developers) <br />
To run scripts written in the Pawn language, you need to install Python 3, Pip, IntelHex, and Pillow.<br />
<br />
<br />
'''Installing Python'''<br />
<br />
Go to the site https://www.python.org/downloads/windows/, click on the "Latest Python 3 Release" link, wait for the download to complete.<br />
[[File:Highlight_Latest_Python_3_Release_link.png]]<br />
<br />
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".<br />
[[File:Python_installation_configuration.png]]<br />
<br />
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.<br />
[[File:Python_disable_path_length_limit.png]]<br />
<br />
<br />
'''Installing libraries'''<br />
<br />
To install the dependencies, you need to start the terminal. Go to Start menu (or press Windows key + X) and select Windows PowerShell.<br />
<br />
[[File:Start_menu_with_PowerShell.png]]<br />
<br />
Type command "pip install intelhex pillow" and press enter. <br />
[[File:Intelhex_and_pillow_installation.png]]<br />
<br />
This command will download and install the IntelHex and Pillow dependencies. If the installation is successful, a corresponding message will be displayed. <br />
<br />
If your company uses a proxy, then you need to add the --proxy option to the command above. The option has the following format:<br />
<br />
[user: password @] proxy.server: port<br />
<br />
For example:<br />
<br />
''pip install --proxy = http: //proxy.jf.intel.com: 911 intelhex pillow''<br />
<br />
===macOS===<br />
<br />
Open the .dmg file, drag the WOWCube Emulator application into the Applications folder. <br />
[[File:Installation_on_macOS.png]]<br />
<br />
If the .dmg file was downloaded not in the App Store, then an error will pop up when starting the application.<br />
[[File:Error_message_macOS_emulator_installation.png]]<br />
<br />
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.<br />
<br />
[[File:Terminal_window_in_macOS.png]]<br />
<br />
In the terminal, write the command ''/ Applications / WOWCube \ Emulator.app/Contents/MacOS/bin/wowcube'' and press enter.<br />
<br />
If the following error occurs<br />
<br />
''/ usr / bin / env: bad interpreter: Operation not permitted, or zsh: operation not permitted: / Applications / WOWCube Emulator.app/Contents/MacOS/bin/wowcube''<br />
<br />
Then run the following command ''xattr -rd com.apple.quarantine / Applications / WOWCube \ Emulator.app/''. It will output errors Permission Denied, but they are expected.<br />
<br />
<br />
'''Installing Python'''<br />
<br />
For macOS version below Catalina open a terminal, install and download Homebrew<br />
<br />
''/ bin / bash -c "$ (curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"''<br />
<br />
Homebrew is a package manager that lets you install Open Source applications.<br />
<br />
Next, install Python 3 and Pip<br />
<br />
''brew install python3''<br />
<br />
''brew cask install python3''<br />
<br />
<br />
For macOS by Catalina. First you need to make sure that python is installed and that it is the correct version.<br />
<br />
''python3 -V''<br />
<br />
This command should print “Python 3.x.x”. If the command did not display anything, or was not found, try to execute<br />
<br />
''python -V''<br />
<br />
If it displays “Python 2.x.x”, then Python 3 is not installed.<br />
<br />
<br />
Install pip:<br />
<br />
''curl -fsSL https://bootstrap.pypa.io/get-pip.py | python3''<br />
<br />
[[File:Check_for_python_and_installing_pip.png]]<br />
<br />
<br />
'''Installing labraries'''<br />
<br />
Install IntelHex and Pillow libraries.<br />
<br />
''pip3 install pillow intelhex''<br />
<br />
==Starting WOWCube Emulator==<br />
<br />
===Windows===<br />
<br />
Launch WOWCube Emulator by clicking on shortcut on desktop.<br />
<br />
[[File:WOWCube_Emulator_shortcut_windows.png]]<br />
<br />
On first launch, a warning from the firewall will appear.<br />
<br />
[[File:Windows_security_alert_first_emulator_launch.png]]<br />
<br />
Allow access. WOWCube Emulator uses local ports for communication between the processes it creates, as well as for projector mode.<br />
<br />
===macOS===<br />
<br />
Open terminal and enter ''WOWCube Emulator'' then and press Enter.<br />
<br />
==WOWCube Emulator interface==<br />
<br />
There are 4 main groups of widgets in the WOWCube Emulator interface.<br />
<br />
[[File:WOWCube_Emulator_UI.png]]<br />
<br />
'''First group'''<br />
<br />
Contains links for interacting with the cube module. Buttons from left to right:<br />
<br />
* simulates the shaking of a cube<br />
* returns the cube module to its original state (restoring rotations and position)<br />
* rotates a random side of the cube<br />
<br />
'''Second group'''<br />
<br />
Serves to interact with the progress of the script. Buttons from left to right:<br />
<br />
* start emulation of the selected pawn script. Аfter startup is replaced by the emulation restart button<br />
* stops pawn script emulation<br />
* loading a script to a physical cube using the bluetooth protocol (does not work in version 2.2.0 and below)<br />
<br />
'''Third group'''<br />
<br />
'''''Project tab'''''<br />
<br />
In this tab you can choose one of two modes of operation:<br />
<br />
* Pawn;<br />
* Projector.<br />
<br />
''Projector mode''<br />
<br />
The projector is used to transfer images from a computer or mobile device to the WOWCube via the Bluetooth protocol.<br />
<br />
The projector in the WOWCube Emulator is used for prototyping and faster development of web-projector applications.<br />
<br />
''Pawn Mode''<br />
<br />
In this mode, you can:<br />
<br />
* select the path to the projects folder<br />
* select a startup project<br />
* view additional data for a running project<br />
<br />
'''''View tab'''''<br />
<br />
The Sound adjusts the overall volume.<br />
<br />
[[File:WOWCube_Emulator_view_tab_sound.png]]<br />
<br />
In the Emulation, the transparency of the overlay is adjusted. The overlay displays on each module its current number, screen and adjacent modules.<br />
<br />
The Limit FPS slider allows you to limit the frame rate in the application running on the emulator.<br />
<br />
If necessary, it is possible to configure the simulation of lost packets during transmission.<br />
<br />
[[File:WOWCube_Emulator_view_tab_emulation.png]]<br />
<br />
In the CubeNet, the transparency and the size of the cube unfolding are configured.<br />
<br />
[[File:WOWCube_Emulator_view_tab_CubeNet.png]]<br />
<br />
In the Scene, the removal of the camera, the field of view, the backdrop are configured.<br />
<br />
ABI calls - displays abi function calls to the console.<br />
<br />
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.<br />
<br />
[[File:WOWCube_Emulator_view_tab_scene.png]]<br />
<br />
'''''Settings Tab'''''<br />
<br />
This is where the PAWN compiler path and python path are selected. <br />
<br />
[[File:WOWCube_Emulator_settings_tab.png]]<br />
<br />
'''Fourth group'''<br />
<br />
Contains tabs for displaying script assembly logs and tabs with the console of each module separately.<br />
<br />
===Controls===<br />
<br />
LMB on a cube - rotation of the sides.<br />
<br />
RMB (or Ctrl + LMB) on a cube - tilt the cube.<br />
<br />
RMB (or Ctrl + LMB) past the cube - rotate the camera.<br />
<br />
Mouse wheel - zoom out / zoom in the camera.<br />
<br />
==Quick start==<br />
<br />
Go to https://github.com/wowcube/WOWCube_apps_examples<br />
<br />
Clone or download to the necessary folder.<br />
<br />
Launch WOWCube Emulator.<br />
<br />
In ''Project'' tab switch Pawn mode.<br />
<br />
Specify ''Project path'' to the folder with examples.<br />
<br />
[[File:WOWCube_emulator_path_to_examples.png]]<br />
<br />
Under ''Run configuration'' choose example project.<br />
<br />
[[File:WOWCube_emulator_choose_example.png]]<br />
<br />
You can press 'i' button to watch what resources loaded for each script<br />
<br />
[[File:WOWCube_emulator_resources_for_scripts.png]]<br />
<br />
Press ''Start button'' to launch emulation<br />
<br />
[[File:WOWCube_emulator_launched_first_example.png]]<br />
<br />
In order to make changes in examples you need:<br />
<br />
* Go to folder where your WOWCube examples located<br />
* Open file 'example1.pwn' with any text redactor<br />
* make what changes you need</div>Raccoon piratehttps://wiki.wowcube.com/index.php?title=SDK&diff=174SDK2021-06-22T10:47:51Z<p>Raccoon pirate: /* Quick start */</p>
<hr />
<div>SDK/Framework<br />
<br />
*[[pawn]]<br />
<br />
==WOWCube Emulator installation==<br />
<br />
===Windows===<br />
Launch the wowcube-sdk.exe installer and follow the steps of the installer.<br />
<br />
Installing Dependencies (for Pawn Application Developers) <br />
To run scripts written in the Pawn language, you need to install Python 3, Pip, IntelHex, and Pillow.<br />
<br />
<br />
'''Installing Python'''<br />
<br />
Go to the site https://www.python.org/downloads/windows/, click on the "Latest Python 3 Release" link, wait for the download to complete.<br />
[[File:Highlight_Latest_Python_3_Release_link.png]]<br />
<br />
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".<br />
[[File:Python_installation_configuration.png]]<br />
<br />
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.<br />
[[File:Python_disable_path_length_limit.png]]<br />
<br />
<br />
'''Installing libraries'''<br />
<br />
To install the dependencies, you need to start the terminal. Go to Start menu (or press Windows key + X) and select Windows PowerShell.<br />
<br />
[[File:Start_menu_with_PowerShell.png]]<br />
<br />
Type command "pip install intelhex pillow" and press enter. <br />
[[File:Intelhex_and_pillow_installation.png]]<br />
<br />
This command will download and install the IntelHex and Pillow dependencies. If the installation is successful, a corresponding message will be displayed. <br />
<br />
If your company uses a proxy, then you need to add the --proxy option to the command above. The option has the following format:<br />
<br />
[user: password @] proxy.server: port<br />
<br />
For example:<br />
<br />
''pip install --proxy = http: //proxy.jf.intel.com: 911 intelhex pillow''<br />
<br />
===macOS===<br />
<br />
Open the .dmg file, drag the WOWCube Emulator application into the Applications folder. <br />
[[File:Installation_on_macOS.png]]<br />
<br />
If the .dmg file was downloaded not in the App Store, then an error will pop up when starting the application.<br />
[[File:Error_message_macOS_emulator_installation.png]]<br />
<br />
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.<br />
<br />
[[File:Terminal_window_in_macOS.png]]<br />
<br />
In the terminal, write the command ''/ Applications / WOWCube \ Emulator.app/Contents/MacOS/bin/wowcube'' and press enter.<br />
<br />
If the following error occurs<br />
<br />
''/ usr / bin / env: bad interpreter: Operation not permitted, or zsh: operation not permitted: / Applications / WOWCube Emulator.app/Contents/MacOS/bin/wowcube''<br />
<br />
Then run the following command ''xattr -rd com.apple.quarantine / Applications / WOWCube \ Emulator.app/''. It will output errors Permission Denied, but they are expected.<br />
<br />
<br />
'''Installing Python'''<br />
<br />
For macOS version below Catalina open a terminal, install and download Homebrew<br />
<br />
''/ bin / bash -c "$ (curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"''<br />
<br />
Homebrew is a package manager that lets you install Open Source applications.<br />
<br />
Next, install Python 3 and Pip<br />
<br />
''brew install python3''<br />
<br />
''brew cask install python3''<br />
<br />
<br />
For macOS by Catalina. First you need to make sure that python is installed and that it is the correct version.<br />
<br />
''python3 -V''<br />
<br />
This command should print “Python 3.x.x”. If the command did not display anything, or was not found, try to execute<br />
<br />
''python -V''<br />
<br />
If it displays “Python 2.x.x”, then Python 3 is not installed.<br />
<br />
<br />
Install pip:<br />
<br />
''curl -fsSL https://bootstrap.pypa.io/get-pip.py | python3''<br />
<br />
[[File:Check_for_python_and_installing_pip.png]]<br />
<br />
<br />
'''Installing labraries'''<br />
<br />
Install IntelHex and Pillow libraries.<br />
<br />
''pip3 install pillow intelhex''<br />
<br />
==Starting WOWCube Emulator==<br />
<br />
===Windows===<br />
<br />
Launch WOWCube Emulator by clicking on shortcut on desktop.<br />
<br />
[[File:WOWCube_Emulator_shortcut_windows.png]]<br />
<br />
On first launch, a warning from the firewall will appear.<br />
<br />
[[File:Windows_security_alert_first_emulator_launch.png]]<br />
<br />
Allow access. WOWCube Emulator uses local ports for communication between the processes it creates, as well as for projector mode.<br />
<br />
===macOS===<br />
<br />
Open terminal and enter ''WOWCube Emulator'' then and press Enter.<br />
<br />
==WOWCube Emulator interface==<br />
<br />
There are 4 main groups of widgets in the WOWCube Emulator interface.<br />
<br />
[[File:WOWCube_Emulator_UI.png]]<br />
<br />
'''First group'''<br />
<br />
Contains links for interacting with the cube module. Buttons from left to right:<br />
<br />
* simulates the shaking of a cube<br />
* returns the cube module to its original state (restoring rotations and position)<br />
* rotates a random side of the cube<br />
<br />
'''Second group'''<br />
<br />
Serves to interact with the progress of the script. Buttons from left to right:<br />
<br />
* start emulation of the selected pawn script. Аfter startup is replaced by the emulation restart button<br />
* stops pawn script emulation<br />
* loading a script to a physical cube using the bluetooth protocol (does not work in version 2.2.0 and below)<br />
<br />
'''Third group'''<br />
<br />
'''''Project tab'''''<br />
<br />
In this tab you can choose one of two modes of operation:<br />
<br />
* Pawn;<br />
* Projector.<br />
<br />
''Projector mode''<br />
<br />
The projector is used to transfer images from a computer or mobile device to the WOWCube via the Bluetooth protocol.<br />
<br />
The projector in the WOWCube Emulator is used for prototyping and faster development of web-projector applications.<br />
<br />
''Pawn Mode''<br />
<br />
In this mode, you can:<br />
<br />
* select the path to the projects folder<br />
* select a startup project<br />
* view additional data for a running project<br />
<br />
'''''View tab'''''<br />
<br />
The Sound adjusts the overall volume.<br />
<br />
[[File:WOWCube_Emulator_view_tab_sound.png]]<br />
<br />
In the Emulation, the transparency of the overlay is adjusted. The overlay displays on each module its current number, screen and adjacent modules.<br />
<br />
The Limit FPS slider allows you to limit the frame rate in the application running on the emulator.<br />
<br />
If necessary, it is possible to configure the simulation of lost packets during transmission.<br />
<br />
[[File:WOWCube_Emulator_view_tab_emulation.png]]<br />
<br />
In the CubeNet, the transparency and the size of the cube unfolding are configured.<br />
<br />
[[File:WOWCube_Emulator_view_tab_CubeNet.png]]<br />
<br />
In the Scene, the removal of the camera, the field of view, the backdrop are configured.<br />
<br />
[[File:WOWCube_Emulator_view_tab_scene.png]]<br />
<br />
'''''Settings Tab'''''<br />
<br />
This is where the PAWN compiler path and python path are selected. <br />
<br />
[[File:WOWCube_Emulator_settings_tab.png]]<br />
<br />
'''Fourth group'''<br />
<br />
Contains tabs for displaying script assembly logs and tabs with the console of each module separately.<br />
<br />
===Controls===<br />
<br />
LMB on a cube - rotation of the sides.<br />
<br />
RMB (or Ctrl + LMB) on a cube - tilt the cube.<br />
<br />
RMB (or Ctrl + LMB) past the cube - rotate the camera.<br />
<br />
Mouse wheel - zoom out / zoom in the camera.<br />
<br />
==Quick start==<br />
<br />
Go to https://github.com/wowcube/WOWCube_apps_examples<br />
<br />
Clone or download to the necessary folder.<br />
<br />
Launch WOWCube Emulator.<br />
<br />
In ''Project'' tab switch Pawn mode.<br />
<br />
Specify ''Project path'' to the folder with examples.<br />
<br />
[[File:WOWCube_emulator_path_to_examples.png]]<br />
<br />
Under ''Run configuration'' choose example project.<br />
<br />
[[File:WOWCube_emulator_choose_example.png]]<br />
<br />
You can press 'i' button to watch what resources loaded for each script<br />
<br />
[[File:WOWCube_emulator_resources_for_scripts.png]]<br />
<br />
Press ''Start button'' to launch emulation<br />
<br />
[[File:WOWCube_emulator_launched_first_example.png]]<br />
<br />
In order to make changes in examples you need:<br />
<br />
* Go to folder where your WOWCube examples located<br />
* Open file 'example1.pwn' with any text redactor<br />
* make what changes you need</div>Raccoon piratehttps://wiki.wowcube.com/index.php?title=SDK&diff=173SDK2021-06-22T09:13:29Z<p>Raccoon pirate: /* Quick start */</p>
<hr />
<div>SDK/Framework<br />
<br />
*[[pawn]]<br />
<br />
==WOWCube Emulator installation==<br />
<br />
===Windows===<br />
Launch the wowcube-sdk.exe installer and follow the steps of the installer.<br />
<br />
Installing Dependencies (for Pawn Application Developers) <br />
To run scripts written in the Pawn language, you need to install Python 3, Pip, IntelHex, and Pillow.<br />
<br />
<br />
'''Installing Python'''<br />
<br />
Go to the site https://www.python.org/downloads/windows/, click on the "Latest Python 3 Release" link, wait for the download to complete.<br />
[[File:Highlight_Latest_Python_3_Release_link.png]]<br />
<br />
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".<br />
[[File:Python_installation_configuration.png]]<br />
<br />
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.<br />
[[File:Python_disable_path_length_limit.png]]<br />
<br />
<br />
'''Installing libraries'''<br />
<br />
To install the dependencies, you need to start the terminal. Go to Start menu (or press Windows key + X) and select Windows PowerShell.<br />
<br />
[[File:Start_menu_with_PowerShell.png]]<br />
<br />
Type command "pip install intelhex pillow" and press enter. <br />
[[File:Intelhex_and_pillow_installation.png]]<br />
<br />
This command will download and install the IntelHex and Pillow dependencies. If the installation is successful, a corresponding message will be displayed. <br />
<br />
If your company uses a proxy, then you need to add the --proxy option to the command above. The option has the following format:<br />
<br />
[user: password @] proxy.server: port<br />
<br />
For example:<br />
<br />
''pip install --proxy = http: //proxy.jf.intel.com: 911 intelhex pillow''<br />
<br />
===macOS===<br />
<br />
Open the .dmg file, drag the WOWCube Emulator application into the Applications folder. <br />
[[File:Installation_on_macOS.png]]<br />
<br />
If the .dmg file was downloaded not in the App Store, then an error will pop up when starting the application.<br />
[[File:Error_message_macOS_emulator_installation.png]]<br />
<br />
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.<br />
<br />
[[File:Terminal_window_in_macOS.png]]<br />
<br />
In the terminal, write the command ''/ Applications / WOWCube \ Emulator.app/Contents/MacOS/bin/wowcube'' and press enter.<br />
<br />
If the following error occurs<br />
<br />
''/ usr / bin / env: bad interpreter: Operation not permitted, or zsh: operation not permitted: / Applications / WOWCube Emulator.app/Contents/MacOS/bin/wowcube''<br />
<br />
Then run the following command ''xattr -rd com.apple.quarantine / Applications / WOWCube \ Emulator.app/''. It will output errors Permission Denied, but they are expected.<br />
<br />
<br />
'''Installing Python'''<br />
<br />
For macOS version below Catalina open a terminal, install and download Homebrew<br />
<br />
''/ bin / bash -c "$ (curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"''<br />
<br />
Homebrew is a package manager that lets you install Open Source applications.<br />
<br />
Next, install Python 3 and Pip<br />
<br />
''brew install python3''<br />
<br />
''brew cask install python3''<br />
<br />
<br />
For macOS by Catalina. First you need to make sure that python is installed and that it is the correct version.<br />
<br />
''python3 -V''<br />
<br />
This command should print “Python 3.x.x”. If the command did not display anything, or was not found, try to execute<br />
<br />
''python -V''<br />
<br />
If it displays “Python 2.x.x”, then Python 3 is not installed.<br />
<br />
<br />
Install pip:<br />
<br />
''curl -fsSL https://bootstrap.pypa.io/get-pip.py | python3''<br />
<br />
[[File:Check_for_python_and_installing_pip.png]]<br />
<br />
<br />
'''Installing labraries'''<br />
<br />
Install IntelHex and Pillow libraries.<br />
<br />
''pip3 install pillow intelhex''<br />
<br />
==Starting WOWCube Emulator==<br />
<br />
===Windows===<br />
<br />
Launch WOWCube Emulator by clicking on shortcut on desktop.<br />
<br />
[[File:WOWCube_Emulator_shortcut_windows.png]]<br />
<br />
On first launch, a warning from the firewall will appear.<br />
<br />
[[File:Windows_security_alert_first_emulator_launch.png]]<br />
<br />
Allow access. WOWCube Emulator uses local ports for communication between the processes it creates, as well as for projector mode.<br />
<br />
===macOS===<br />
<br />
Open terminal and enter ''WOWCube Emulator'' then and press Enter.<br />
<br />
==WOWCube Emulator interface==<br />
<br />
There are 4 main groups of widgets in the WOWCube Emulator interface.<br />
<br />
[[File:WOWCube_Emulator_UI.png]]<br />
<br />
'''First group'''<br />
<br />
Contains links for interacting with the cube module. Buttons from left to right:<br />
<br />
* simulates the shaking of a cube<br />
* returns the cube module to its original state (restoring rotations and position)<br />
* rotates a random side of the cube<br />
<br />
'''Second group'''<br />
<br />
Serves to interact with the progress of the script. Buttons from left to right:<br />
<br />
* start emulation of the selected pawn script. Аfter startup is replaced by the emulation restart button<br />
* stops pawn script emulation<br />
* loading a script to a physical cube using the bluetooth protocol (does not work in version 2.2.0 and below)<br />
<br />
'''Third group'''<br />
<br />
'''''Project tab'''''<br />
<br />
In this tab you can choose one of two modes of operation:<br />
<br />
* Pawn;<br />
* Projector.<br />
<br />
''Projector mode''<br />
<br />
The projector is used to transfer images from a computer or mobile device to the WOWCube via the Bluetooth protocol.<br />
<br />
The projector in the WOWCube Emulator is used for prototyping and faster development of web-projector applications.<br />
<br />
''Pawn Mode''<br />
<br />
In this mode, you can:<br />
<br />
* select the path to the projects folder<br />
* select a startup project<br />
* view additional data for a running project<br />
<br />
'''''View tab'''''<br />
<br />
The Sound adjusts the overall volume.<br />
<br />
[[File:WOWCube_Emulator_view_tab_sound.png]]<br />
<br />
In the Emulation, the transparency of the overlay is adjusted. The overlay displays on each module its current number, screen and adjacent modules.<br />
<br />
The Limit FPS slider allows you to limit the frame rate in the application running on the emulator.<br />
<br />
If necessary, it is possible to configure the simulation of lost packets during transmission.<br />
<br />
[[File:WOWCube_Emulator_view_tab_emulation.png]]<br />
<br />
In the CubeNet, the transparency and the size of the cube unfolding are configured.<br />
<br />
[[File:WOWCube_Emulator_view_tab_CubeNet.png]]<br />
<br />
In the Scene, the removal of the camera, the field of view, the backdrop are configured.<br />
<br />
[[File:WOWCube_Emulator_view_tab_scene.png]]<br />
<br />
'''''Settings Tab'''''<br />
<br />
This is where the PAWN compiler path and python path are selected. <br />
<br />
[[File:WOWCube_Emulator_settings_tab.png]]<br />
<br />
'''Fourth group'''<br />
<br />
Contains tabs for displaying script assembly logs and tabs with the console of each module separately.<br />
<br />
===Controls===<br />
<br />
LMB on a cube - rotation of the sides.<br />
<br />
RMB (or Ctrl + LMB) on a cube - tilt the cube.<br />
<br />
RMB (or Ctrl + LMB) past the cube - rotate the camera.<br />
<br />
Mouse wheel - zoom out / zoom in the camera.<br />
<br />
==Quick start==<br />
<br />
Go to https://github.com/wowcube/WOWCube_apps_examples<br />
<br />
Clone or download to the necessary folder.<br />
<br />
Launch WOWCube Emulator.<br />
<br />
In ''Project'' tab switch Pawn mode.<br />
<br />
Specify ''Project path'' to the folder with examples.<br />
<br />
[[File:WOWCube_emulator_path_to_examples.png]]<br />
<br />
Under ''Run configuration'' choose example project.<br />
<br />
[[File:WOWCube_emulator_choose_example.png]]<br />
<br />
You can press 'i' button to watch what resources loaded for each script<br />
<br />
[[File:WOWCube_emulator_resources_for_scripts.png]]<br />
<br />
Press ''Start button'' to launch emulation<br />
<br />
[[File:WOWCube_emulator_launched_first_example.png]]</div>Raccoon piratehttps://wiki.wowcube.com/index.php?title=File:WOWCube_emulator_launched_first_example.png&diff=172File:WOWCube emulator launched first example.png2021-06-22T09:08:30Z<p>Raccoon pirate: WOWCube Emulator guide. First example.</p>
<hr />
<div>== Summary ==<br />
WOWCube Emulator guide. First example.</div>Raccoon piratehttps://wiki.wowcube.com/index.php?title=File:WOWCube_emulator_resources_for_scripts.png&diff=171File:WOWCube emulator resources for scripts.png2021-06-22T09:03:25Z<p>Raccoon pirate: WOWCube Emulator guide. Script resources info window.</p>
<hr />
<div>== Summary ==<br />
WOWCube Emulator guide. Script resources info window.</div>Raccoon piratehttps://wiki.wowcube.com/index.php?title=SDK&diff=170SDK2021-06-22T09:02:01Z<p>Raccoon pirate: /* Quick start */</p>
<hr />
<div>SDK/Framework<br />
<br />
*[[pawn]]<br />
<br />
==WOWCube Emulator installation==<br />
<br />
===Windows===<br />
Launch the wowcube-sdk.exe installer and follow the steps of the installer.<br />
<br />
Installing Dependencies (for Pawn Application Developers) <br />
To run scripts written in the Pawn language, you need to install Python 3, Pip, IntelHex, and Pillow.<br />
<br />
<br />
'''Installing Python'''<br />
<br />
Go to the site https://www.python.org/downloads/windows/, click on the "Latest Python 3 Release" link, wait for the download to complete.<br />
[[File:Highlight_Latest_Python_3_Release_link.png]]<br />
<br />
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".<br />
[[File:Python_installation_configuration.png]]<br />
<br />
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.<br />
[[File:Python_disable_path_length_limit.png]]<br />
<br />
<br />
'''Installing libraries'''<br />
<br />
To install the dependencies, you need to start the terminal. Go to Start menu (or press Windows key + X) and select Windows PowerShell.<br />
<br />
[[File:Start_menu_with_PowerShell.png]]<br />
<br />
Type command "pip install intelhex pillow" and press enter. <br />
[[File:Intelhex_and_pillow_installation.png]]<br />
<br />
This command will download and install the IntelHex and Pillow dependencies. If the installation is successful, a corresponding message will be displayed. <br />
<br />
If your company uses a proxy, then you need to add the --proxy option to the command above. The option has the following format:<br />
<br />
[user: password @] proxy.server: port<br />
<br />
For example:<br />
<br />
''pip install --proxy = http: //proxy.jf.intel.com: 911 intelhex pillow''<br />
<br />
===macOS===<br />
<br />
Open the .dmg file, drag the WOWCube Emulator application into the Applications folder. <br />
[[File:Installation_on_macOS.png]]<br />
<br />
If the .dmg file was downloaded not in the App Store, then an error will pop up when starting the application.<br />
[[File:Error_message_macOS_emulator_installation.png]]<br />
<br />
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.<br />
<br />
[[File:Terminal_window_in_macOS.png]]<br />
<br />
In the terminal, write the command ''/ Applications / WOWCube \ Emulator.app/Contents/MacOS/bin/wowcube'' and press enter.<br />
<br />
If the following error occurs<br />
<br />
''/ usr / bin / env: bad interpreter: Operation not permitted, or zsh: operation not permitted: / Applications / WOWCube Emulator.app/Contents/MacOS/bin/wowcube''<br />
<br />
Then run the following command ''xattr -rd com.apple.quarantine / Applications / WOWCube \ Emulator.app/''. It will output errors Permission Denied, but they are expected.<br />
<br />
<br />
'''Installing Python'''<br />
<br />
For macOS version below Catalina open a terminal, install and download Homebrew<br />
<br />
''/ bin / bash -c "$ (curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"''<br />
<br />
Homebrew is a package manager that lets you install Open Source applications.<br />
<br />
Next, install Python 3 and Pip<br />
<br />
''brew install python3''<br />
<br />
''brew cask install python3''<br />
<br />
<br />
For macOS by Catalina. First you need to make sure that python is installed and that it is the correct version.<br />
<br />
''python3 -V''<br />
<br />
This command should print “Python 3.x.x”. If the command did not display anything, or was not found, try to execute<br />
<br />
''python -V''<br />
<br />
If it displays “Python 2.x.x”, then Python 3 is not installed.<br />
<br />
<br />
Install pip:<br />
<br />
''curl -fsSL https://bootstrap.pypa.io/get-pip.py | python3''<br />
<br />
[[File:Check_for_python_and_installing_pip.png]]<br />
<br />
<br />
'''Installing labraries'''<br />
<br />
Install IntelHex and Pillow libraries.<br />
<br />
''pip3 install pillow intelhex''<br />
<br />
==Starting WOWCube Emulator==<br />
<br />
===Windows===<br />
<br />
Launch WOWCube Emulator by clicking on shortcut on desktop.<br />
<br />
[[File:WOWCube_Emulator_shortcut_windows.png]]<br />
<br />
On first launch, a warning from the firewall will appear.<br />
<br />
[[File:Windows_security_alert_first_emulator_launch.png]]<br />
<br />
Allow access. WOWCube Emulator uses local ports for communication between the processes it creates, as well as for projector mode.<br />
<br />
===macOS===<br />
<br />
Open terminal and enter ''WOWCube Emulator'' then and press Enter.<br />
<br />
==WOWCube Emulator interface==<br />
<br />
There are 4 main groups of widgets in the WOWCube Emulator interface.<br />
<br />
[[File:WOWCube_Emulator_UI.png]]<br />
<br />
'''First group'''<br />
<br />
Contains links for interacting with the cube module. Buttons from left to right:<br />
<br />
* simulates the shaking of a cube<br />
* returns the cube module to its original state (restoring rotations and position)<br />
* rotates a random side of the cube<br />
<br />
'''Second group'''<br />
<br />
Serves to interact with the progress of the script. Buttons from left to right:<br />
<br />
* start emulation of the selected pawn script. Аfter startup is replaced by the emulation restart button<br />
* stops pawn script emulation<br />
* loading a script to a physical cube using the bluetooth protocol (does not work in version 2.2.0 and below)<br />
<br />
'''Third group'''<br />
<br />
'''''Project tab'''''<br />
<br />
In this tab you can choose one of two modes of operation:<br />
<br />
* Pawn;<br />
* Projector.<br />
<br />
''Projector mode''<br />
<br />
The projector is used to transfer images from a computer or mobile device to the WOWCube via the Bluetooth protocol.<br />
<br />
The projector in the WOWCube Emulator is used for prototyping and faster development of web-projector applications.<br />
<br />
''Pawn Mode''<br />
<br />
In this mode, you can:<br />
<br />
* select the path to the projects folder<br />
* select a startup project<br />
* view additional data for a running project<br />
<br />
'''''View tab'''''<br />
<br />
The Sound adjusts the overall volume.<br />
<br />
[[File:WOWCube_Emulator_view_tab_sound.png]]<br />
<br />
In the Emulation, the transparency of the overlay is adjusted. The overlay displays on each module its current number, screen and adjacent modules.<br />
<br />
The Limit FPS slider allows you to limit the frame rate in the application running on the emulator.<br />
<br />
If necessary, it is possible to configure the simulation of lost packets during transmission.<br />
<br />
[[File:WOWCube_Emulator_view_tab_emulation.png]]<br />
<br />
In the CubeNet, the transparency and the size of the cube unfolding are configured.<br />
<br />
[[File:WOWCube_Emulator_view_tab_CubeNet.png]]<br />
<br />
In the Scene, the removal of the camera, the field of view, the backdrop are configured.<br />
<br />
[[File:WOWCube_Emulator_view_tab_scene.png]]<br />
<br />
'''''Settings Tab'''''<br />
<br />
This is where the PAWN compiler path and python path are selected. <br />
<br />
[[File:WOWCube_Emulator_settings_tab.png]]<br />
<br />
'''Fourth group'''<br />
<br />
Contains tabs for displaying script assembly logs and tabs with the console of each module separately.<br />
<br />
===Controls===<br />
<br />
LMB on a cube - rotation of the sides.<br />
<br />
RMB (or Ctrl + LMB) on a cube - tilt the cube.<br />
<br />
RMB (or Ctrl + LMB) past the cube - rotate the camera.<br />
<br />
Mouse wheel - zoom out / zoom in the camera.<br />
<br />
==Quick start==<br />
<br />
Go to https://github.com/wowcube/WOWCube_apps_examples<br />
<br />
Clone or download to the necessary folder.<br />
<br />
Launch WOWCube Emulator.<br />
<br />
In ''Project'' tab switch Pawn mode.<br />
<br />
Specify ''Project path'' to the folder with examples.<br />
<br />
[[File:WOWCube_emulator_path_to_examples.png]]<br />
<br />
Under ''Run configuration'' choose example project.<br />
<br />
[[File:WOWCube_emulator_choose_example.png]]</div>Raccoon piratehttps://wiki.wowcube.com/index.php?title=File:WOWCube_emulator_choose_example.png&diff=169File:WOWCube emulator choose example.png2021-06-22T08:33:28Z<p>Raccoon pirate: WOWCube Emulator guide. Choose example from drop-down list.</p>
<hr />
<div>== Summary ==<br />
WOWCube Emulator guide. Choose example from drop-down list.</div>Raccoon piratehttps://wiki.wowcube.com/index.php?title=File:WOWCube_emulator_path_to_examples.png&diff=168File:WOWCube emulator path to examples.png2021-06-22T08:15:58Z<p>Raccoon pirate: WOWCube Emulator guide. Specify project path to examples.</p>
<hr />
<div>== Summary ==<br />
WOWCube Emulator guide. Specify project path to examples.</div>Raccoon piratehttps://wiki.wowcube.com/index.php?title=File:WOWCube_Emulator_view_tab_scene.png&diff=167File:WOWCube Emulator view tab scene.png2021-06-22T07:40:35Z<p>Raccoon pirate: Raccoon pirate uploaded a new version of File:WOWCube Emulator view tab scene.png</p>
<hr />
<div>== Summary ==<br />
WOWCube Emulator guide. Scene settings in view tab.</div>Raccoon piratehttps://wiki.wowcube.com/index.php?title=SDK&diff=166SDK2021-06-22T07:06:46Z<p>Raccoon pirate: /* WOWCube Emulator interface */</p>
<hr />
<div>SDK/Framework<br />
<br />
*[[pawn]]<br />
<br />
==WOWCube Emulator installation==<br />
<br />
===Windows===<br />
Launch the wowcube-sdk.exe installer and follow the steps of the installer.<br />
<br />
Installing Dependencies (for Pawn Application Developers) <br />
To run scripts written in the Pawn language, you need to install Python 3, Pip, IntelHex, and Pillow.<br />
<br />
<br />
'''Installing Python'''<br />
<br />
Go to the site https://www.python.org/downloads/windows/, click on the "Latest Python 3 Release" link, wait for the download to complete.<br />
[[File:Highlight_Latest_Python_3_Release_link.png]]<br />
<br />
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".<br />
[[File:Python_installation_configuration.png]]<br />
<br />
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.<br />
[[File:Python_disable_path_length_limit.png]]<br />
<br />
<br />
'''Installing libraries'''<br />
<br />
To install the dependencies, you need to start the terminal. Go to Start menu (or press Windows key + X) and select Windows PowerShell.<br />
<br />
[[File:Start_menu_with_PowerShell.png]]<br />
<br />
Type command "pip install intelhex pillow" and press enter. <br />
[[File:Intelhex_and_pillow_installation.png]]<br />
<br />
This command will download and install the IntelHex and Pillow dependencies. If the installation is successful, a corresponding message will be displayed. <br />
<br />
If your company uses a proxy, then you need to add the --proxy option to the command above. The option has the following format:<br />
<br />
[user: password @] proxy.server: port<br />
<br />
For example:<br />
<br />
''pip install --proxy = http: //proxy.jf.intel.com: 911 intelhex pillow''<br />
<br />
===macOS===<br />
<br />
Open the .dmg file, drag the WOWCube Emulator application into the Applications folder. <br />
[[File:Installation_on_macOS.png]]<br />
<br />
If the .dmg file was downloaded not in the App Store, then an error will pop up when starting the application.<br />
[[File:Error_message_macOS_emulator_installation.png]]<br />
<br />
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.<br />
<br />
[[File:Terminal_window_in_macOS.png]]<br />
<br />
In the terminal, write the command ''/ Applications / WOWCube \ Emulator.app/Contents/MacOS/bin/wowcube'' and press enter.<br />
<br />
If the following error occurs<br />
<br />
''/ usr / bin / env: bad interpreter: Operation not permitted, or zsh: operation not permitted: / Applications / WOWCube Emulator.app/Contents/MacOS/bin/wowcube''<br />
<br />
Then run the following command ''xattr -rd com.apple.quarantine / Applications / WOWCube \ Emulator.app/''. It will output errors Permission Denied, but they are expected.<br />
<br />
<br />
'''Installing Python'''<br />
<br />
For macOS version below Catalina open a terminal, install and download Homebrew<br />
<br />
''/ bin / bash -c "$ (curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"''<br />
<br />
Homebrew is a package manager that lets you install Open Source applications.<br />
<br />
Next, install Python 3 and Pip<br />
<br />
''brew install python3''<br />
<br />
''brew cask install python3''<br />
<br />
<br />
For macOS by Catalina. First you need to make sure that python is installed and that it is the correct version.<br />
<br />
''python3 -V''<br />
<br />
This command should print “Python 3.x.x”. If the command did not display anything, or was not found, try to execute<br />
<br />
''python -V''<br />
<br />
If it displays “Python 2.x.x”, then Python 3 is not installed.<br />
<br />
<br />
Install pip:<br />
<br />
''curl -fsSL https://bootstrap.pypa.io/get-pip.py | python3''<br />
<br />
[[File:Check_for_python_and_installing_pip.png]]<br />
<br />
<br />
'''Installing labraries'''<br />
<br />
Install IntelHex and Pillow libraries.<br />
<br />
''pip3 install pillow intelhex''<br />
<br />
==Starting WOWCube Emulator==<br />
<br />
===Windows===<br />
<br />
Launch WOWCube Emulator by clicking on shortcut on desktop.<br />
<br />
[[File:WOWCube_Emulator_shortcut_windows.png]]<br />
<br />
On first launch, a warning from the firewall will appear.<br />
<br />
[[File:Windows_security_alert_first_emulator_launch.png]]<br />
<br />
Allow access. WOWCube Emulator uses local ports for communication between the processes it creates, as well as for projector mode.<br />
<br />
===macOS===<br />
<br />
Open terminal and enter ''WOWCube Emulator'' then and press Enter.<br />
<br />
==WOWCube Emulator interface==<br />
<br />
There are 4 main groups of widgets in the WOWCube Emulator interface.<br />
<br />
[[File:WOWCube_Emulator_UI.png]]<br />
<br />
'''First group'''<br />
<br />
Contains links for interacting with the cube module. Buttons from left to right:<br />
<br />
* simulates the shaking of a cube<br />
* returns the cube module to its original state (restoring rotations and position)<br />
* rotates a random side of the cube<br />
<br />
'''Second group'''<br />
<br />
Serves to interact with the progress of the script. Buttons from left to right:<br />
<br />
* start emulation of the selected pawn script. Аfter startup is replaced by the emulation restart button<br />
* stops pawn script emulation<br />
* loading a script to a physical cube using the bluetooth protocol (does not work in version 2.2.0 and below)<br />
<br />
'''Third group'''<br />
<br />
'''''Project tab'''''<br />
<br />
In this tab you can choose one of two modes of operation:<br />
<br />
* Pawn;<br />
* Projector.<br />
<br />
''Projector mode''<br />
<br />
The projector is used to transfer images from a computer or mobile device to the WOWCube via the Bluetooth protocol.<br />
<br />
The projector in the WOWCube Emulator is used for prototyping and faster development of web-projector applications.<br />
<br />
''Pawn Mode''<br />
<br />
In this mode, you can:<br />
<br />
* select the path to the projects folder<br />
* select a startup project<br />
* view additional data for a running project<br />
<br />
'''''View tab'''''<br />
<br />
The Sound adjusts the overall volume.<br />
<br />
[[File:WOWCube_Emulator_view_tab_sound.png]]<br />
<br />
In the Emulation, the transparency of the overlay is adjusted. The overlay displays on each module its current number, screen and adjacent modules.<br />
<br />
The Limit FPS slider allows you to limit the frame rate in the application running on the emulator.<br />
<br />
If necessary, it is possible to configure the simulation of lost packets during transmission.<br />
<br />
[[File:WOWCube_Emulator_view_tab_emulation.png]]<br />
<br />
In the CubeNet, the transparency and the size of the cube unfolding are configured.<br />
<br />
[[File:WOWCube_Emulator_view_tab_CubeNet.png]]<br />
<br />
In the Scene, the removal of the camera, the field of view, the backdrop are configured.<br />
<br />
[[File:WOWCube_Emulator_view_tab_scene.png]]<br />
<br />
'''''Settings Tab'''''<br />
<br />
This is where the PAWN compiler path and python path are selected. <br />
<br />
[[File:WOWCube_Emulator_settings_tab.png]]<br />
<br />
'''Fourth group'''<br />
<br />
Contains tabs for displaying script assembly logs and tabs with the console of each module separately.<br />
<br />
===Controls===<br />
<br />
LMB on a cube - rotation of the sides.<br />
<br />
RMB (or Ctrl + LMB) on a cube - tilt the cube.<br />
<br />
RMB (or Ctrl + LMB) past the cube - rotate the camera.<br />
<br />
Mouse wheel - zoom out / zoom in the camera.<br />
<br />
==Quick start==<br />
<br />
Go to https://github.com/wowcube/WOWCube_apps_examples<br />
<br />
Clone to the necessary folder.<br />
<br />
Launch WOWCube Emulator.<br />
<br />
In ''Project'' tab switch Pawn mode.<br />
<br />
Specify ''Project path'' to the folder with examples.<br />
<br />
Under ''Run configuration'' choose example project.</div>Raccoon piratehttps://wiki.wowcube.com/index.php?title=SDK&diff=165SDK2021-06-22T06:48:32Z<p>Raccoon pirate: </p>
<hr />
<div>SDK/Framework<br />
<br />
*[[pawn]]<br />
<br />
==WOWCube Emulator installation==<br />
<br />
===Windows===<br />
Launch the wowcube-sdk.exe installer and follow the steps of the installer.<br />
<br />
Installing Dependencies (for Pawn Application Developers) <br />
To run scripts written in the Pawn language, you need to install Python 3, Pip, IntelHex, and Pillow.<br />
<br />
<br />
'''Installing Python'''<br />
<br />
Go to the site https://www.python.org/downloads/windows/, click on the "Latest Python 3 Release" link, wait for the download to complete.<br />
[[File:Highlight_Latest_Python_3_Release_link.png]]<br />
<br />
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".<br />
[[File:Python_installation_configuration.png]]<br />
<br />
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.<br />
[[File:Python_disable_path_length_limit.png]]<br />
<br />
<br />
'''Installing libraries'''<br />
<br />
To install the dependencies, you need to start the terminal. Go to Start menu (or press Windows key + X) and select Windows PowerShell.<br />
<br />
[[File:Start_menu_with_PowerShell.png]]<br />
<br />
Type command "pip install intelhex pillow" and press enter. <br />
[[File:Intelhex_and_pillow_installation.png]]<br />
<br />
This command will download and install the IntelHex and Pillow dependencies. If the installation is successful, a corresponding message will be displayed. <br />
<br />
If your company uses a proxy, then you need to add the --proxy option to the command above. The option has the following format:<br />
<br />
[user: password @] proxy.server: port<br />
<br />
For example:<br />
<br />
''pip install --proxy = http: //proxy.jf.intel.com: 911 intelhex pillow''<br />
<br />
===macOS===<br />
<br />
Open the .dmg file, drag the WOWCube Emulator application into the Applications folder. <br />
[[File:Installation_on_macOS.png]]<br />
<br />
If the .dmg file was downloaded not in the App Store, then an error will pop up when starting the application.<br />
[[File:Error_message_macOS_emulator_installation.png]]<br />
<br />
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.<br />
<br />
[[File:Terminal_window_in_macOS.png]]<br />
<br />
In the terminal, write the command ''/ Applications / WOWCube \ Emulator.app/Contents/MacOS/bin/wowcube'' and press enter.<br />
<br />
If the following error occurs<br />
<br />
''/ usr / bin / env: bad interpreter: Operation not permitted, or zsh: operation not permitted: / Applications / WOWCube Emulator.app/Contents/MacOS/bin/wowcube''<br />
<br />
Then run the following command ''xattr -rd com.apple.quarantine / Applications / WOWCube \ Emulator.app/''. It will output errors Permission Denied, but they are expected.<br />
<br />
<br />
'''Installing Python'''<br />
<br />
For macOS version below Catalina open a terminal, install and download Homebrew<br />
<br />
''/ bin / bash -c "$ (curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"''<br />
<br />
Homebrew is a package manager that lets you install Open Source applications.<br />
<br />
Next, install Python 3 and Pip<br />
<br />
''brew install python3''<br />
<br />
''brew cask install python3''<br />
<br />
<br />
For macOS by Catalina. First you need to make sure that python is installed and that it is the correct version.<br />
<br />
''python3 -V''<br />
<br />
This command should print “Python 3.x.x”. If the command did not display anything, or was not found, try to execute<br />
<br />
''python -V''<br />
<br />
If it displays “Python 2.x.x”, then Python 3 is not installed.<br />
<br />
<br />
Install pip:<br />
<br />
''curl -fsSL https://bootstrap.pypa.io/get-pip.py | python3''<br />
<br />
[[File:Check_for_python_and_installing_pip.png]]<br />
<br />
<br />
'''Installing labraries'''<br />
<br />
Install IntelHex and Pillow libraries.<br />
<br />
''pip3 install pillow intelhex''<br />
<br />
==Starting WOWCube Emulator==<br />
<br />
===Windows===<br />
<br />
Launch WOWCube Emulator by clicking on shortcut on desktop.<br />
<br />
[[File:WOWCube_Emulator_shortcut_windows.png]]<br />
<br />
On first launch, a warning from the firewall will appear.<br />
<br />
[[File:Windows_security_alert_first_emulator_launch.png]]<br />
<br />
Allow access. WOWCube Emulator uses local ports for communication between the processes it creates, as well as for projector mode.<br />
<br />
===macOS===<br />
<br />
Open terminal and enter ''WOWCube Emulator'' then and press Enter.<br />
<br />
==WOWCube Emulator interface==<br />
<br />
There are 4 main groups of widgets in the WOWCube Emulator interface.<br />
<br />
[[File:WOWCube_Emulator_UI.png]]<br />
<br />
'''First group'''<br />
<br />
Contains links for interacting with the cube module. Buttons from left to right:<br />
<br />
* simulates the shaking of a cube<br />
* returns the cube module to its original state (restoring rotations and position)<br />
* rotates a random side of the cube<br />
<br />
'''Second group'''<br />
<br />
Serves to interact with the progress of the script. Buttons from left to right:<br />
<br />
* start emulation of the selected pawn script. Аfter startup is replaced by the emulation restart button<br />
* stops pawn script emulation<br />
* loading a script to a physical cube using the bluetooth protocol<br />
<br />
'''Third group'''<br />
<br />
'''''Project tab'''''<br />
<br />
In this tab you can choose one of two modes of operation:<br />
<br />
* Pawn;<br />
* Projector.<br />
<br />
''Projector mode''<br />
<br />
The projector is used to transfer images from a computer or mobile device to the WOWCube via the Bluetooth protocol.<br />
<br />
The projector in the WOWCube Emulator is used for prototyping and faster development of web-projector applications.<br />
<br />
''Pawn Mode''<br />
<br />
In this mode, you can:<br />
<br />
* select the path to the projects folder<br />
* select a startup project<br />
* view additional data for a running project<br />
<br />
'''''View tab'''''<br />
<br />
The Sound adjusts the overall volume.<br />
<br />
[[File:WOWCube_Emulator_view_tab_sound.png]]<br />
<br />
In the Emulation, the transparency of the overlay is adjusted. The overlay displays on each module its current number, screen and adjacent modules.<br />
<br />
The Limit FPS slider allows you to limit the frame rate in the application running on the emulator.<br />
<br />
If necessary, it is possible to configure the simulation of lost packets during transmission.<br />
<br />
[[File:WOWCube_Emulator_view_tab_emulation.png]]<br />
<br />
In the CubeNet, the transparency and the size of the cube unfolding are configured.<br />
<br />
[[File:WOWCube_Emulator_view_tab_CubeNet.png]]<br />
<br />
In the Scene, the removal of the camera, the field of view, the backdrop are configured.<br />
<br />
[[File:WOWCube_Emulator_view_tab_scene.png]]<br />
<br />
'''''Settings Tab'''''<br />
<br />
This is where the PAWN compiler path and python path are selected. <br />
<br />
[[File:WOWCube_Emulator_settings_tab.png]]<br />
<br />
'''Fourth group'''<br />
<br />
Contains tabs for displaying script assembly logs and tabs with the console of each module separately.<br />
<br />
===Controls===<br />
<br />
LMB on a cube - rotation of the sides.<br />
<br />
RMB (or Ctrl + LMB) on a cube - tilt the cube.<br />
<br />
RMB (or Ctrl + LMB) past the cube - rotate the camera.<br />
<br />
Mouse wheel - zoom out / zoom in the camera.<br />
<br />
==Quick start==<br />
<br />
Go to https://github.com/wowcube/WOWCube_apps_examples<br />
<br />
Clone to the necessary folder.<br />
<br />
Launch WOWCube Emulator.<br />
<br />
In ''Project'' tab switch Pawn mode.<br />
<br />
Specify ''Project path'' to the folder with examples.<br />
<br />
Under ''Run configuration'' choose example project.</div>Raccoon piratehttps://wiki.wowcube.com/index.php?title=File:WOWCube_Emulator_UI.png&diff=164File:WOWCube Emulator UI.png2021-06-22T05:54:41Z<p>Raccoon pirate: Raccoon pirate uploaded a new version of File:WOWCube Emulator UI.png</p>
<hr />
<div>== Summary ==<br />
WOWCube Emulator guide. Basic elements of emulator.</div>Raccoon piratehttps://wiki.wowcube.com/index.php?title=API&diff=163API2021-06-17T10:13:19Z<p>Raccoon pirate: </p>
<hr />
<div>{{notice|This is a beta version, API changes can be made without warning.}}<br />
<br />
=Introduction=<br />
<br />
The main functions of the API are listed here, the features of the work of the environment are described<br />
<br />
==WOWCube Paradigms==<br />
<br />
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.<br />
<br />
==Pawn API==<br />
===Graphic functions===<br />
<br />
====Graphics 2D acceleration (G2D)====<br />
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:<br />
[[File:Cascade.png|center|G2D cascading scheme]]<br />
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.<br />
Basic coordinate principle:<br />
[[File:G2d_coordinates.png|center|G2D coordinates sceme]]<br />
Coordinates are limited from -2048 to 2047. Maximum layers size is 240x240.<br />
<br />
=====abi_CMD_G2D_BEGIN_BITMAP=====<br />
Syntax:<br />
abi_CMD_G2D_BEGIN_BITMAP(const resID, const width, const height, const bool:replace)<br />
Description:<br />
: 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.<br />
Arguments:<br />
: ''resID''<br />
:: 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.<br />
: ''width'' <br />
:: Width of the resulting resource. G2D engine can keep resource of 240px width maximum.<br />
: ''height'' <br />
:: Height of the resulting resource. G2D engine can keep resource of 240px height maximum.<br />
: ''replace'' <br />
:: If true, then an existing image will be replaced completely, otherwise it will be overwritten by reusing itself as a background layer.<br />
<br />
=====abi_CMD_G2D_BEGIN_DISPLAY=====<br />
Syntax:<br />
abi_CMD_G2D_BEGIN_DISPLAY(const display, const bool:replace)<br />
Description:<br />
: 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.<br />
Arguments:<br />
: ''display''<br />
:: ID of the display which framebuffer will be used for blending. Each module have 3 displays with ID starting from 0.<br />
: ''replace'' <br />
:: If true then an existing image will be replaced completely, otherwise it will be overwritten by reusing itself as a background layer.<br />
<br />
=====abi_CMD_G2D_ADD_SPRITE=====<br />
Syntax:<br />
abi_CMD_G2D_ADD_SPRITE(const resID, const bool:g2d, const x, const y, const alpha, const color, const rotation, const mirror)<br />
Description:<br />
: Specifies game resource which will be used as a layer for blending.<br />
Arguments:<br />
: ''resID''<br />
:: ID of the resource to be uses as a layer.<br />
: ''g2d''<br />
:: Indicates if an internal G2D resource is specified or not.<br />
: ''x'', ''y''<br />
:: Coordinates of the bitmap center to place on the layer.<br />
: ''alpha''<br />
:: Layer transparency in range between 0x00 and 0xFF, where 0x00 is a fully transparent layer.<br />
: ''color''<br />
:: Layer's source key - a color in ARGB8888 format to be avoided.<br />
: ''rotation''<br />
:: Clockwise rotation angle in degrees. It is possible to specify free angle, but only right angles have HW acceleration. Currently rotation only applicable for external resources.<br />
: ''mirror''<br />
:: Mirroring variant. Possible values are self-explained: MIRROR_BLANK, MIRROR_X, MIRROR_Y, MIRROR_XY.<br />
<br />
=====abi_CMD_G2D_ADD_RECTANGLE=====<br />
Syntax:<br />
abi_CMD_G2D_ADD_RECTANGLE(const x, const y, const width, const height, const color)<br />
Description:<br />
: 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.<br />
Arguments:<br />
: ''x'', ''y''<br />
:: Coordinates of top left rectangle corner.<br />
: ''width''<br />
:: Rectangle width.<br />
: ''height''<br />
:: Rectangle height.<br />
: ''color''<br />
:: Rectangle color in ARGB8888 format.<br />
<br />
=====abi_CMD_G2D_END=====<br />
Syntax:<br />
abi_CMD_G2D_END()<br />
Description:<br />
: 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.<br />
<br />
=====Examples=====<br />
1. Render into inner G2D resource buffer #face and display it on the display #face. Please, note that last argument of abi_CMD_BITMAP is a `true` flag, which means G2D resource should be used:<br />
...<br />
abi_CMD_G2D_BEGIN_BITMAP(face, 240, 240, true);<br />
abi_CMD_G2D_ADD_RECTANGLE(120 - animationSquareSize0, 120 - animationSquareSize0, animationSquareSize0 * 2, animationSquareSize0 * 2, 0xdfff0000);<br />
abi_CMD_G2D_ADD_RECTANGLE(120 - animationSquareSize1, 120 - animationSquareSize1, animationSquareSize1 * 2, animationSquareSize1 * 2, 0xdfffff00);<br />
abi_CMD_G2D_ADD_RECTANGLE(120 - animationSquareSize2, 120 - animationSquareSize2, animationSquareSize2 * 2, animationSquareSize2 * 2, 0xdfff00ff);<br />
abi_CMD_G2D_ADD_RECTANGLE(120 - animationSquareSize3, 120 - animationSquareSize3, animationSquareSize3 * 2, animationSquareSize3 * 2, 0xdf00ffff);<br />
abi_CMD_G2D_ADD_SPRITE(resID, false, 120, 120, animationAlpha, 0x00000000, animationAngle, MIRROR_BLANK);<br />
abi_CMD_G2D_END();<br />
...<br />
abi_CMD_BITMAP(face, 120, 120, 0, MIRROR_BLANK, true);<br />
...<br />
abi_CMD_REDRAW(face);<br />
...<br />
2. Render directly into display framebuffer #face. This will produce same result on display as example #1, but the generated image is not saved:<br />
...<br />
abi_CMD_G2D_BEGIN_DISPLAY(face, true);<br />
abi_CMD_G2D_ADD_RECTANGLE(120 - animationSquareSize0, 120 - animationSquareSize0, animationSquareSize0 * 2, animationSquareSize0 * 2, 0xdfff0000);<br />
abi_CMD_G2D_ADD_RECTANGLE(120 - animationSquareSize1, 120 - animationSquareSize1, animationSquareSize1 * 2, animationSquareSize1 * 2, 0xdfffff00);<br />
abi_CMD_G2D_ADD_RECTANGLE(120 - animationSquareSize2, 120 - animationSquareSize2, animationSquareSize2 * 2, animationSquareSize2 * 2, 0xdfff00ff);<br />
abi_CMD_G2D_ADD_RECTANGLE(120 - animationSquareSize3, 120 - animationSquareSize3, animationSquareSize3 * 2, animationSquareSize3 * 2, 0xdf00ffff);<br />
abi_CMD_G2D_ADD_SPRITE(resID, false, 120, 120, animationAlpha, 0x00000000, animationAngle, MIRROR_BLANK);<br />
abi_CMD_G2D_END();<br />
...<br />
<br />
====Font drawing functions====<br />
=====abi_CMD_TEXT=====<br />
API:<br />
abi_CMD_TEXT(const text[], const fontResID, const x, const y, const scale, const angle, const r, const g, const b)<br />
Description:<br />
: Intended to render a system font or a custom font from resources with specified coordinates, scale and rotation at an arbitrary angle.<br />
Arguments:<br />
: ''text''<br />
:: Array of chars.<br />
: ''fontResID''<br />
:: Custom font resource identifier. Provide ''-1'' to use system font resource.<br />
: ''x'', ''y''<br />
:: Coordinates of top left rectangle corner.<br />
: ''scale'', ''angle''<br />
:: Percentage scale and clockwise rotation angle in degrees. Max size of font is 200x200 px. (scale = 100%)<br />
: ''r'', ''g'', ''b''<br />
:: Font color in RGB format.<br />
<br />
Example:<br />
new text[4] = ['A', 'p', 'p', '\0'];<br />
abi_CMD_TEXT(text, RES_ID_FONT, 90, 160, 16, current_angles[face], 255, 0, 0);<br />
<br />
====TEXTURE drawing functions====<br />
=====abi_CMD_DYNAMIC_TEXTURE=====<br />
<br />
API:<br />
<br />
abi_CMD_DYNAMIC_TEXTURE(const effectId = 1, const time = any value, const args[] = {0x04030201, 0x08070605, 0x00000A09}, const argsCount = 3, const bool:g2d = false)<br />
<br />
Description:<br />
: Render a texture with chosen algorithm and parameters.<br />
Arguments:<br />
: ''effectId''<br />
:: Define algorithm to render texture. <br />
:: Available values : G2D_DYNAMIC_TEXTURE_MOSAIC <br />
<br />
: ''time ''<br />
:: Current time value. Use any fixed value to static texture or set current time value in milliseconds to make texture alive.<br />
: ''args'', ''argsCount''<br />
:: Byte stream of algorithm settings it's aligned to 4 bytes, because of pawn supports only 32-bit values.<br />
:: Size of array depends on algorithm. For example mosaic algorithm has size of settings equals 10 bytes , so we must use aligned 4 bytes - 12 bytes array and argsCount = 3<br />
<br />
: ''g2d''<br />
:: false - Use pawn default buffer to draw texture.<br />
:: true - Use g2d buffer to draw texture - not supported now.<br />
<br />
'''G2D_DYNAMIC_TEXTURE_MOSAIC''' alogrithm description<br />
<br />
:So in effect named 'mosaic' we have settings of 10 parameters each one 1 byte<br />
<br />
:Noise factors :<br />
::factor x : values from 0 to 10<br />
::factor y : values from 0 to 10<br />
::factor xy : values from 0 to 10<br />
:Time factors :<br />
::factor x : values from 0 to 10<br />
::factor y : values from 0 to 10<br />
::factor xy : values from 0 to 10<br />
:Color factors :<br />
::r : values from 0 to 10<br />
::g : values from 0 to 10<br />
::b : values from 0 to 10<br />
:Zoom factor :<br />
::zoom values from 0 to 10<br />
<br />
For example we want to set all parameters above with values in order 1,2,3,4,5,6,7,8,9,10. Take in attention that each parameter is 1 byte we must make array of 32-bit values<br />
0x04030201, 0x08070605, 0x00000A09<br />
<br />
Example:<br />
mosaic_effect_settings = { 0x04030201, 0x08070605, 0x00000A09 };<br />
mosaic_effect_settings_length = 3;<br />
abi_CMD_DYNAMIC_TEXTURE(G2D_DYNAMIC_TEXTURE_MOSAIC , currentTime, mosaic_effect_settings, mosaic_effect_settings_length);<br />
<br />
===Motion sensors===<br />
====abi_MTD_GetFaceAccel(X/Y/Z)====<br />
Syntax:<br />
abi_MTD_GetFaceAccelX(const faceN)<br />
abi_MTD_GetFaceAccelY(const faceN)<br />
abi_MTD_GetFaceAccelZ(const faceN)<br />
Description:<br />
: Get the value of acceleration along the requested axis.<br />
Arguments<br />
: ''faceN''<br />
:: Number of the module face for which requested axis is belong.<br />
<br />
====abi_MTD_GetFaceGyro(X/Y/Z)====<br />
Syntax:<br />
abi_MTD_GetFaceGyroX(const faceN)<br />
abi_MTD_GetFaceGyroY(const faceN)<br />
abi_MTD_GetFaceGyroZ(const faceN)<br />
Description:<br />
: Get the gyro value around the requested axis.<br />
Arguments<br />
: ''faceN''<br />
:: Number of the module face for which requested axis is belong.<br />
<br />
====abi_MTD_GetTapFace====<br />
Syntax:<br />
abi_MTD_GetTapFace()<br />
Description:<br />
: Get the face ID which was tapped. ID is not a face number which is used for drawing in abi_CMD_G2D_BEGIN_DISPLAY or abi_CMD_REDRAW, but that number can be calculated by subtracting by one from ID value. See possible values below.<br />
Return values:<br />
: ''MTD_TAP_DIRECTION_NONE = 0''<br />
:: Indicates that the module wan not tapped.<br />
: ''MTD_TAP_DIRECTION_X = 1''<br />
: ''MTD_TAP_DIRECTION_Y = 2''<br />
: ''MTD_TAP_DIRECTION_Z = 3''<br />
:: Indicated direction of tap.<br />
<br />
====abi_MTD_IsTapOpposite====<br />
Syntax:<br />
abi_MTD_IsTapOpposite()<br />
Description:<br />
: Get the flag if the tap was detected in opposite direction.<br />
<br />
====abi_MTD_GetTapsCount====<br />
Syntax:<br />
abi_MTD_GetTapsCount()<br />
Description:<br />
: Get the count of subsequent taps. Tap is treated as a subsequent if it was detected within predefined interval (350ms). Count will be zero until sequence is finished, i.e. next tap is not detected within interval.<br />
<br />
====abi_checkShake====<br />
Syntax:<br />
abi_checkShake()<br />
Description:<br />
: Checks if the number of shakes of the cube was more than a certain threshold then exits the script <br />
<br />
<br />
====Examples====<br />
1. Flash the face on which tap was detected. Print an ID of that face. Color of the flash depends on taps count: red - one tap, green - two taps and blue - three.<br />
new delay = 0;<br />
new color = 0x000000; <br />
ONTICK() {<br />
if (!color) {<br />
switch (abi_MTD_GetTapsCount()) {<br />
case 1:<br />
color = 0xff0000;<br />
case 2:<br />
color = 0x00ff00;<br />
case 3:<br />
color = 0x0000ff;<br />
}<br />
}<br />
if (delay % 25 == 0) {<br />
for (new i = 0; i < FACES_MAX; i++) {<br />
if (i == (abi_MTD_GetTapFace() - 1)) {<br />
abi_CMD_FILL_2(color);<br />
color = 0x000000;<br />
switch (abi_MTD_GetTapFace()) {<br />
case 1:<br />
abi_CMD_TEXT(['1', '\0'], -1, 120, 120, 14, 0, 0xff, 0xff, 0xff);<br />
case 2:<br />
abi_CMD_TEXT(['2', '\0'], -1, 120, 120, 14, 0, 0xff, 0xff, 0xff);<br />
case 3:<br />
abi_CMD_TEXT(['3', '\0'], -1, 120, 120, 14, 0, 0xff, 0xff, 0xff);<br />
}<br />
} else {<br />
abi_CMD_FILL(0, 0, 0);<br />
}<br />
abi_CMD_REDRAW(i);<br />
}<br />
}<br />
delay++;<br />
}<br />
2. Exit from script<br />
ONTICK() {<br />
if (abi_cubeN == 0) {<br />
abi_checkShake();<br />
}<br />
// Script logic<br />
}<br />
<br />
===Save/load functions===<br />
<br />
====abi_CMD_SAVE_STATE====<br />
Syntax:<br />
bool:abi_CMD_SAVE_STATE(const data[], size = sizeof(data))<br />
Description:<br />
: Save maximum 256 bytes of data to wowcube flash memory.<br />
Arguments<br />
: ''data''<br />
:: Game data to save.<br />
: ''size''<br />
:: Size of game data.<br />
Return values:<br />
: ''return false''<br />
:: If size is bigger then 256 bytes.<br />
<br />
====abi_CMD_LOAD_STATE====<br />
Syntax:<br />
abi_CMD_LOAD_STATE()<br />
Description:<br />
: Sends a command requesting the platform to load script data. The response from the platform is not instantaneous and takes several milliseconds.<br />
<br />
====Examples====<br />
1. Load data at the start.<br />
// This function is called when a response is received from the platform<br />
ON_LOAD_GAME_DATA (const pkt[]) {<br />
// Deserialize pkt<br />
currentLevelNumber = pkt[1]; // Starting with 1 cause 0 pkt element holding command ID<br />
score = pkt[2];<br />
moves = pkt[3];<br />
...<br />
record = pkt[GAME_SAVE_SIZE];<br />
}<br />
ON_INIT () {<br />
abi_CMD_LOAD_STATE ();<br />
}<br />
<br />
2. Save the data after the end of the level.<br />
SaveGameState () {<br />
new saveData [GAME_SAVE_SIZE];<br />
// Assign all necessary data<br />
saveData[0] = currentLevelNumber;<br />
saveData[1] = score;<br />
saveData[2] = moves;<br />
...<br />
saveData[GAME_SAVE_SIZE - 1] = record;<br />
<br />
abi_CMD_SAVE_STATE (saveData);<br />
}<br />
ON_CHECK_ROTATE () {<br />
if (isLevelFinished) {<br />
SaveGameState();<br />
}<br />
}<br />
<br />
===Time functions===<br />
====abi_GetTime====<br />
Syntax:<br />
abi_GetTime()<br />
Description:<br />
: Get current time in milliseconds.<br />
<br />
====Examples====<br />
new previousTime = 0;<br />
new currentTime = 0;<br />
new deltaTime = 0;<br />
ON_INIT() {<br />
previousTime = abi_GetTime();<br />
}<br />
ONTICK() {<br />
currentTime = abi_GetTime();<br />
deltaTime = currentTime - previousTime;<br />
previousTime = currentTime;<br />
}<br />
<br />
<br />
===Topology functions===<br />
====get cube/face====<br />
Syntax:<br />
abi_topCubeN(const _cubeN, const _faceN)<br />
abi_topFaceN(const _cubeN, const _faceN)<br />
abi_rightCubeN(const _cubeN, const _faceN)<br />
abi_rightFaceN(const _cubeN, const _faceN)<br />
abi_bottomCubeN(const _cubeN, const _faceN)<br />
abi_bottomFaceN(const _cubeN, const _faceN)<br />
abi_leftCubeN(const _cubeN, const _faceN)<br />
abi_leftFaceN(const _cubeN, const _faceN)<br />
Description:<br />
: Returns the cube / screen located at the top / bottom / left / right of the specified in parameters.<br />
<br />
====Examples====<br />
Find diagonal face and cube<br />
new diagonalCube = CUBES_MAX;<br />
new diagonalFace = FACES_MAX;<br />
new topCube = abi_topCubeN(cube, face);<br />
new topFace = abi_topFaceN(cube, face);<br />
if (topCube < CUBES_MAX) {<br />
diagonalCube = abi_topCubeN(topCube, topFace);<br />
if (diagonalCube < CUBES_MAX) {<br />
diagonalFace = abi_topFaceN(topCube, topFace);<br />
}<br />
}<br />
<br />
<br />
===Sound functions===<br />
====abi_CMD_PLAYSND====<br />
Syntax:<br />
abi_CMD_PLAYSND(const id, const volume)<br />
Description:<br />
: Play chosen sound with a given volume.<br />
Arguments<br />
: ''id''<br />
:: Sound serial number in the application package.<br />
: ''volume''<br />
:: The sound volume.</div>Raccoon piratehttps://wiki.wowcube.com/index.php?title=API&diff=162API2021-06-17T08:44:08Z<p>Raccoon pirate: /* Examples */</p>
<hr />
<div>{{notice|This is a beta version, API changes can be made without warning.}}<br />
<br />
=Introduction=<br />
<br />
The main functions of the API are listed here, the features of the work of the environment are described<br />
<br />
==WOWCube Paradigms==<br />
<br />
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.<br />
<br />
==Pawn API==<br />
===Graphic functions===<br />
<br />
====Graphics 2D acceleration (G2D)====<br />
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:<br />
[[File:Cascade.png|center|G2D cascading scheme]]<br />
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.<br />
Basic coordinate principle:<br />
[[File:G2d_coordinates.png|center|G2D coordinates sceme]]<br />
Coordinates are limited from -2048 to 2047. Maximum layers size is 240x240.<br />
<br />
=====abi_CMD_G2D_BEGIN_BITMAP=====<br />
Syntax:<br />
abi_CMD_G2D_BEGIN_BITMAP(const resID, const width, const height, const bool:replace)<br />
Description:<br />
: 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.<br />
Arguments:<br />
: ''resID''<br />
:: 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.<br />
: ''width'' <br />
:: Width of the resulting resource. G2D engine can keep resource of 240px width maximum.<br />
: ''height'' <br />
:: Height of the resulting resource. G2D engine can keep resource of 240px height maximum.<br />
: ''replace'' <br />
:: If true, then an existing image will be replaced completely, otherwise it will be overwritten by reusing itself as a background layer.<br />
<br />
=====abi_CMD_G2D_BEGIN_DISPLAY=====<br />
Syntax:<br />
abi_CMD_G2D_BEGIN_DISPLAY(const display, const bool:replace)<br />
Description:<br />
: 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.<br />
Arguments:<br />
: ''display''<br />
:: ID of the display which framebuffer will be used for blending. Each module have 3 displays with ID starting from 0.<br />
: ''replace'' <br />
:: If true then an existing image will be replaced completely, otherwise it will be overwritten by reusing itself as a background layer.<br />
<br />
=====abi_CMD_G2D_ADD_SPRITE=====<br />
Syntax:<br />
abi_CMD_G2D_ADD_SPRITE(const resID, const bool:g2d, const x, const y, const alpha, const color, const rotation, const mirror)<br />
Description:<br />
: Specifies game resource which will be used as a layer for blending.<br />
Arguments:<br />
: ''resID''<br />
:: ID of the resource to be uses as a layer.<br />
: ''g2d''<br />
:: Indicates if an internal G2D resource is specified or not.<br />
: ''x'', ''y''<br />
:: Coordinates of the bitmap center to place on the layer.<br />
: ''alpha''<br />
:: Layer transparency in range between 0x00 and 0xFF, where 0x00 is a fully transparent layer.<br />
: ''color''<br />
:: Layer's source key - a color in ARGB8888 format to be avoided.<br />
: ''rotation''<br />
:: Clockwise rotation angle in degrees. It is possible to specify free angle, but only right angles have HW acceleration. Currently rotation only applicable for external resources.<br />
: ''mirror''<br />
:: Mirroring variant. Possible values are self-explained: MIRROR_BLANK, MIRROR_X, MIRROR_Y, MIRROR_XY.<br />
<br />
=====abi_CMD_G2D_ADD_RECTANGLE=====<br />
Syntax:<br />
abi_CMD_G2D_ADD_RECTANGLE(const x, const y, const width, const height, const color)<br />
Description:<br />
: 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.<br />
Arguments:<br />
: ''x'', ''y''<br />
:: Coordinates of top left rectangle corner.<br />
: ''width''<br />
:: Rectangle width.<br />
: ''height''<br />
:: Rectangle height.<br />
: ''color''<br />
:: Rectangle color in ARGB8888 format.<br />
<br />
=====abi_CMD_G2D_END=====<br />
Syntax:<br />
abi_CMD_G2D_END()<br />
Description:<br />
: 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.<br />
<br />
=====Examples=====<br />
1. Render into inner G2D resource buffer #face and display it on the display #face. Please, note that last argument of abi_CMD_BITMAP is a `true` flag, which means G2D resource should be used:<br />
...<br />
abi_CMD_G2D_BEGIN_BITMAP(face, 240, 240, true);<br />
abi_CMD_G2D_ADD_RECTANGLE(120 - animationSquareSize0, 120 - animationSquareSize0, animationSquareSize0 * 2, animationSquareSize0 * 2, 0xdfff0000);<br />
abi_CMD_G2D_ADD_RECTANGLE(120 - animationSquareSize1, 120 - animationSquareSize1, animationSquareSize1 * 2, animationSquareSize1 * 2, 0xdfffff00);<br />
abi_CMD_G2D_ADD_RECTANGLE(120 - animationSquareSize2, 120 - animationSquareSize2, animationSquareSize2 * 2, animationSquareSize2 * 2, 0xdfff00ff);<br />
abi_CMD_G2D_ADD_RECTANGLE(120 - animationSquareSize3, 120 - animationSquareSize3, animationSquareSize3 * 2, animationSquareSize3 * 2, 0xdf00ffff);<br />
abi_CMD_G2D_ADD_SPRITE(resID, false, 120, 120, animationAlpha, 0x00000000, animationAngle, MIRROR_BLANK);<br />
abi_CMD_G2D_END();<br />
...<br />
abi_CMD_BITMAP(face, 120, 120, 0, MIRROR_BLANK, true);<br />
...<br />
abi_CMD_REDRAW(face);<br />
...<br />
2. Render directly into display framebuffer #face. This will produce same result on display as example #1, but the generated image is not saved:<br />
...<br />
abi_CMD_G2D_BEGIN_DISPLAY(face, true);<br />
abi_CMD_G2D_ADD_RECTANGLE(120 - animationSquareSize0, 120 - animationSquareSize0, animationSquareSize0 * 2, animationSquareSize0 * 2, 0xdfff0000);<br />
abi_CMD_G2D_ADD_RECTANGLE(120 - animationSquareSize1, 120 - animationSquareSize1, animationSquareSize1 * 2, animationSquareSize1 * 2, 0xdfffff00);<br />
abi_CMD_G2D_ADD_RECTANGLE(120 - animationSquareSize2, 120 - animationSquareSize2, animationSquareSize2 * 2, animationSquareSize2 * 2, 0xdfff00ff);<br />
abi_CMD_G2D_ADD_RECTANGLE(120 - animationSquareSize3, 120 - animationSquareSize3, animationSquareSize3 * 2, animationSquareSize3 * 2, 0xdf00ffff);<br />
abi_CMD_G2D_ADD_SPRITE(resID, false, 120, 120, animationAlpha, 0x00000000, animationAngle, MIRROR_BLANK);<br />
abi_CMD_G2D_END();<br />
...<br />
<br />
====Font drawing functions====<br />
=====abi_CMD_TEXT=====<br />
API:<br />
abi_CMD_TEXT(const text[], const fontResID, const x, const y, const scale, const angle, const r, const g, const b)<br />
Description:<br />
: Intended to render a system font or a custom font from resources with specified coordinates, scale and rotation at an arbitrary angle.<br />
Arguments:<br />
: ''text''<br />
:: Array of chars.<br />
: ''fontResID''<br />
:: Custom font resource identifier. Provide ''-1'' to use system font resource.<br />
: ''x'', ''y''<br />
:: Coordinates of top left rectangle corner.<br />
: ''scale'', ''angle''<br />
:: Percentage scale and clockwise rotation angle in degrees. Max size of font is 200x200 px. (scale = 100%)<br />
: ''r'', ''g'', ''b''<br />
:: Font color in RGB format.<br />
<br />
Example:<br />
new text[4] = ['A', 'p', 'p', '\0'];<br />
abi_CMD_TEXT(text, RES_ID_FONT, 90, 160, 16, current_angles[face], 255, 0, 0);<br />
<br />
====TEXTURE drawing functions====<br />
=====abi_CMD_DYNAMIC_TEXTURE=====<br />
<br />
API:<br />
<br />
abi_CMD_DYNAMIC_TEXTURE(const effectId = 1, const time = any value, const args[] = {0x04030201, 0x08070605, 0x00000A09}, const argsCount = 3, const bool:g2d = false)<br />
<br />
Description:<br />
: Render a texture with chosen algorithm and parameters.<br />
Arguments:<br />
: ''effectId''<br />
:: Define algorithm to render texture. <br />
:: Available values : G2D_DYNAMIC_TEXTURE_MOSAIC <br />
<br />
: ''time ''<br />
:: Current time value. Use any fixed value to static texture or set current time value in milliseconds to make texture alive.<br />
: ''args'', ''argsCount''<br />
:: Byte stream of algorithm settings it's aligned to 4 bytes, because of pawn supports only 32-bit values.<br />
:: Size of array depends on algorithm. For example mosaic algorithm has size of settings equals 10 bytes , so we must use aligned 4 bytes - 12 bytes array and argsCount = 3<br />
<br />
: ''g2d''<br />
:: false - Use pawn default buffer to draw texture.<br />
:: true - Use g2d buffer to draw texture - not supported now.<br />
<br />
'''G2D_DYNAMIC_TEXTURE_MOSAIC''' alogrithm description<br />
<br />
:So in effect named 'mosaic' we have settings of 10 parameters each one 1 byte<br />
<br />
:Noise factors :<br />
::factor x : values from 0 to 10<br />
::factor y : values from 0 to 10<br />
::factor xy : values from 0 to 10<br />
:Time factors :<br />
::factor x : values from 0 to 10<br />
::factor y : values from 0 to 10<br />
::factor xy : values from 0 to 10<br />
:Color factors :<br />
::r : values from 0 to 10<br />
::g : values from 0 to 10<br />
::b : values from 0 to 10<br />
:Zoom factor :<br />
::zoom values from 0 to 10<br />
<br />
For example we want to set all parameters above with values in order 1,2,3,4,5,6,7,8,9,10. Take in attention that each parameter is 1 byte we must make array of 32-bit values<br />
0x04030201, 0x08070605, 0x00000A09<br />
<br />
Example:<br />
mosaic_effect_settings = { 0x04030201, 0x08070605, 0x00000A09 };<br />
mosaic_effect_settings_length = 3;<br />
abi_CMD_DYNAMIC_TEXTURE(G2D_DYNAMIC_TEXTURE_MOSAIC , currentTime, mosaic_effect_settings, mosaic_effect_settings_length);<br />
<br />
===Motion sensors===<br />
====abi_MTD_GetFaceAccel(X/Y/Z)====<br />
Syntax:<br />
abi_MTD_GetFaceAccelX(const faceN)<br />
abi_MTD_GetFaceAccelY(const faceN)<br />
abi_MTD_GetFaceAccelZ(const faceN)<br />
Description:<br />
: Get the value of acceleration along the requested axis.<br />
Arguments<br />
: ''faceN''<br />
:: Number of the module face for which requested axis is belong.<br />
<br />
====abi_MTD_GetFaceGyro(X/Y/Z)====<br />
Syntax:<br />
abi_MTD_GetFaceGyroX(const faceN)<br />
abi_MTD_GetFaceGyroY(const faceN)<br />
abi_MTD_GetFaceGyroZ(const faceN)<br />
Description:<br />
: Get the gyro value around the requested axis.<br />
Arguments<br />
: ''faceN''<br />
:: Number of the module face for which requested axis is belong.<br />
<br />
====abi_MTD_GetTapFace====<br />
Syntax:<br />
abi_MTD_GetTapFace()<br />
Description:<br />
: Get the face ID which was tapped. ID is not a face number which is used for drawing in abi_CMD_G2D_BEGIN_DISPLAY or abi_CMD_REDRAW, but that number can be calculated by subtracting by one from ID value. See possible values below.<br />
Return values:<br />
: ''MTD_TAP_DIRECTION_NONE = 0''<br />
:: Indicates that the module wan not tapped.<br />
: ''MTD_TAP_DIRECTION_X = 1''<br />
: ''MTD_TAP_DIRECTION_Y = 2''<br />
: ''MTD_TAP_DIRECTION_Z = 3''<br />
:: Indicated direction of tap.<br />
<br />
====abi_MTD_IsTapOpposite====<br />
Syntax:<br />
abi_MTD_IsTapOpposite()<br />
Description:<br />
: Get the flag if the tap was detected in opposite direction.<br />
<br />
====abi_MTD_GetTapsCount====<br />
Syntax:<br />
abi_MTD_GetTapsCount()<br />
Description:<br />
: Get the count of subsequent taps. Tap is treated as a subsequent if it was detected within predefined interval (350ms). Count will be zero until sequence is finished, i.e. next tap is not detected within interval.<br />
<br />
====abi_checkShake====<br />
Syntax:<br />
abi_checkShake()<br />
Description:<br />
: Checks if the number of shakes of the cube was more than a certain threshold then exits the script <br />
<br />
<br />
====Examples====<br />
1. Flash the face on which tap was detected. Print an ID of that face. Color of the flash depends on taps count: red - one tap, green - two taps and blue - three.<br />
new delay = 0;<br />
new color = 0x000000; <br />
ONTICK() {<br />
if (!color) {<br />
switch (abi_MTD_GetTapsCount()) {<br />
case 1:<br />
color = 0xff0000;<br />
case 2:<br />
color = 0x00ff00;<br />
case 3:<br />
color = 0x0000ff;<br />
}<br />
}<br />
if (delay % 25 == 0) {<br />
for (new i = 0; i < FACES_MAX; i++) {<br />
if (i == (abi_MTD_GetTapFace() - 1)) {<br />
abi_CMD_FILL_2(color);<br />
color = 0x000000;<br />
switch (abi_MTD_GetTapFace()) {<br />
case 1:<br />
abi_CMD_TEXT(['1', '\0'], -1, 120, 120, 14, 0, 0xff, 0xff, 0xff);<br />
case 2:<br />
abi_CMD_TEXT(['2', '\0'], -1, 120, 120, 14, 0, 0xff, 0xff, 0xff);<br />
case 3:<br />
abi_CMD_TEXT(['3', '\0'], -1, 120, 120, 14, 0, 0xff, 0xff, 0xff);<br />
}<br />
} else {<br />
abi_CMD_FILL(0, 0, 0);<br />
}<br />
abi_CMD_REDRAW(i);<br />
}<br />
}<br />
delay++;<br />
}<br />
2. Exit from script<br />
ONTICK() {<br />
if (abi_cubeN == 0) {<br />
abi_checkShake();<br />
}<br />
// Script logic<br />
}<br />
<br />
===Save/load functions===<br />
<br />
====abi_CMD_SAVE_STATE====<br />
Syntax:<br />
bool:abi_CMD_SAVE_STATE(const data[], size = sizeof(data))<br />
Description:<br />
: Save maximum 256 bytes of data to wowcube flash memory.<br />
Arguments<br />
: ''data''<br />
:: Game data to save.<br />
: ''size''<br />
:: Size of game data.<br />
Return values:<br />
: ''return false''<br />
:: If size is bigger then 256 bytes.<br />
<br />
====abi_CMD_LOAD_STATE====<br />
Syntax:<br />
abi_CMD_LOAD_STATE()<br />
Description:<br />
: Sends a command requesting the platform to load script data. The response from the platform is not instantaneous and takes several milliseconds.<br />
<br />
====Examples====<br />
1. Load data at the start.<br />
// This function is called when a response is received from the platform<br />
ON_LOAD_GAME_DATA (const pkt[]) {<br />
// Deserialize pkt<br />
currentLevelNumber = pkt[1]; // Starting with 1 cause 0 pkt element holding command ID<br />
score = pkt[2];<br />
moves = pkt[3];<br />
...<br />
record = pkt[GAME_SAVE_SIZE];<br />
}<br />
ON_INIT () {<br />
abi_CMD_LOAD_STATE ();<br />
}<br />
<br />
2. Save the data after the end of the level.<br />
SaveGameState () {<br />
new saveData [GAME_SAVE_SIZE];<br />
// Assign all necessary data<br />
saveData[0] = currentLevelNumber;<br />
saveData[1] = score;<br />
saveData[2] = moves;<br />
...<br />
saveData[GAME_SAVE_SIZE - 1] = record;<br />
<br />
abi_CMD_SAVE_STATE (saveData);<br />
}<br />
ON_CHECK_ROTATE () {<br />
if (isLevelFinished) {<br />
SaveGameState();<br />
}<br />
}<br />
<br />
===Time functions===<br />
====abi_GetTime====<br />
Syntax:<br />
abi_GetTime()<br />
Description:<br />
: Get current time in milliseconds.<br />
<br />
====Examples====<br />
new previousTime = 0;<br />
new currentTime = 0;<br />
new deltaTime = 0;<br />
ON_INIT() {<br />
previousTime = abi_GetTime();<br />
}<br />
ONTICK() {<br />
currentTime = abi_GetTime();<br />
deltaTime = currentTime - previousTime;<br />
previousTime = currentTime;<br />
}<br />
<br />
<br />
===Topology functions===<br />
====get cube/face====<br />
Syntax:<br />
abi_topCubeN(const _cubeN, const _faceN)<br />
abi_topFaceN(const _cubeN, const _faceN)<br />
abi_rightCubeN(const _cubeN, const _faceN)<br />
abi_rightFaceN(const _cubeN, const _faceN)<br />
abi_bottomCubeN(const _cubeN, const _faceN)<br />
abi_bottomFaceN(const _cubeN, const _faceN)<br />
abi_leftCubeN(const _cubeN, const _faceN)<br />
abi_leftFaceN(const _cubeN, const _faceN)<br />
Description:<br />
: Returns the cube / screen located at the top / bottom / left / right of the specified in parameters.<br />
<br />
====Examples====<br />
Find diagonal face and cube<br />
new diagonalCube = CUBES_MAX;<br />
new diagonalFace = FACES_MAX;<br />
new topCube = abi_topCubeN(cube, face);<br />
new topFace = abi_topFaceN(cube, face);<br />
if (topCube < CUBES_MAX) {<br />
diagonalCube = abi_topCubeN(topCube, topFace);<br />
if (diagonalCube < CUBES_MAX) {<br />
diagonalFace = abi_topFaceN(topCube, topFace);<br />
}<br />
}</div>Raccoon piratehttps://wiki.wowcube.com/index.php?title=API&diff=161API2021-06-17T08:42:57Z<p>Raccoon pirate: /* abi_CMD_SAVE_STATE */</p>
<hr />
<div>{{notice|This is a beta version, API changes can be made without warning.}}<br />
<br />
=Introduction=<br />
<br />
The main functions of the API are listed here, the features of the work of the environment are described<br />
<br />
==WOWCube Paradigms==<br />
<br />
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.<br />
<br />
==Pawn API==<br />
===Graphic functions===<br />
<br />
====Graphics 2D acceleration (G2D)====<br />
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:<br />
[[File:Cascade.png|center|G2D cascading scheme]]<br />
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.<br />
Basic coordinate principle:<br />
[[File:G2d_coordinates.png|center|G2D coordinates sceme]]<br />
Coordinates are limited from -2048 to 2047. Maximum layers size is 240x240.<br />
<br />
=====abi_CMD_G2D_BEGIN_BITMAP=====<br />
Syntax:<br />
abi_CMD_G2D_BEGIN_BITMAP(const resID, const width, const height, const bool:replace)<br />
Description:<br />
: 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.<br />
Arguments:<br />
: ''resID''<br />
:: 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.<br />
: ''width'' <br />
:: Width of the resulting resource. G2D engine can keep resource of 240px width maximum.<br />
: ''height'' <br />
:: Height of the resulting resource. G2D engine can keep resource of 240px height maximum.<br />
: ''replace'' <br />
:: If true, then an existing image will be replaced completely, otherwise it will be overwritten by reusing itself as a background layer.<br />
<br />
=====abi_CMD_G2D_BEGIN_DISPLAY=====<br />
Syntax:<br />
abi_CMD_G2D_BEGIN_DISPLAY(const display, const bool:replace)<br />
Description:<br />
: 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.<br />
Arguments:<br />
: ''display''<br />
:: ID of the display which framebuffer will be used for blending. Each module have 3 displays with ID starting from 0.<br />
: ''replace'' <br />
:: If true then an existing image will be replaced completely, otherwise it will be overwritten by reusing itself as a background layer.<br />
<br />
=====abi_CMD_G2D_ADD_SPRITE=====<br />
Syntax:<br />
abi_CMD_G2D_ADD_SPRITE(const resID, const bool:g2d, const x, const y, const alpha, const color, const rotation, const mirror)<br />
Description:<br />
: Specifies game resource which will be used as a layer for blending.<br />
Arguments:<br />
: ''resID''<br />
:: ID of the resource to be uses as a layer.<br />
: ''g2d''<br />
:: Indicates if an internal G2D resource is specified or not.<br />
: ''x'', ''y''<br />
:: Coordinates of the bitmap center to place on the layer.<br />
: ''alpha''<br />
:: Layer transparency in range between 0x00 and 0xFF, where 0x00 is a fully transparent layer.<br />
: ''color''<br />
:: Layer's source key - a color in ARGB8888 format to be avoided.<br />
: ''rotation''<br />
:: Clockwise rotation angle in degrees. It is possible to specify free angle, but only right angles have HW acceleration. Currently rotation only applicable for external resources.<br />
: ''mirror''<br />
:: Mirroring variant. Possible values are self-explained: MIRROR_BLANK, MIRROR_X, MIRROR_Y, MIRROR_XY.<br />
<br />
=====abi_CMD_G2D_ADD_RECTANGLE=====<br />
Syntax:<br />
abi_CMD_G2D_ADD_RECTANGLE(const x, const y, const width, const height, const color)<br />
Description:<br />
: 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.<br />
Arguments:<br />
: ''x'', ''y''<br />
:: Coordinates of top left rectangle corner.<br />
: ''width''<br />
:: Rectangle width.<br />
: ''height''<br />
:: Rectangle height.<br />
: ''color''<br />
:: Rectangle color in ARGB8888 format.<br />
<br />
=====abi_CMD_G2D_END=====<br />
Syntax:<br />
abi_CMD_G2D_END()<br />
Description:<br />
: 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.<br />
<br />
=====Examples=====<br />
1. Render into inner G2D resource buffer #face and display it on the display #face. Please, note that last argument of abi_CMD_BITMAP is a `true` flag, which means G2D resource should be used:<br />
...<br />
abi_CMD_G2D_BEGIN_BITMAP(face, 240, 240, true);<br />
abi_CMD_G2D_ADD_RECTANGLE(120 - animationSquareSize0, 120 - animationSquareSize0, animationSquareSize0 * 2, animationSquareSize0 * 2, 0xdfff0000);<br />
abi_CMD_G2D_ADD_RECTANGLE(120 - animationSquareSize1, 120 - animationSquareSize1, animationSquareSize1 * 2, animationSquareSize1 * 2, 0xdfffff00);<br />
abi_CMD_G2D_ADD_RECTANGLE(120 - animationSquareSize2, 120 - animationSquareSize2, animationSquareSize2 * 2, animationSquareSize2 * 2, 0xdfff00ff);<br />
abi_CMD_G2D_ADD_RECTANGLE(120 - animationSquareSize3, 120 - animationSquareSize3, animationSquareSize3 * 2, animationSquareSize3 * 2, 0xdf00ffff);<br />
abi_CMD_G2D_ADD_SPRITE(resID, false, 120, 120, animationAlpha, 0x00000000, animationAngle, MIRROR_BLANK);<br />
abi_CMD_G2D_END();<br />
...<br />
abi_CMD_BITMAP(face, 120, 120, 0, MIRROR_BLANK, true);<br />
...<br />
abi_CMD_REDRAW(face);<br />
...<br />
2. Render directly into display framebuffer #face. This will produce same result on display as example #1, but the generated image is not saved:<br />
...<br />
abi_CMD_G2D_BEGIN_DISPLAY(face, true);<br />
abi_CMD_G2D_ADD_RECTANGLE(120 - animationSquareSize0, 120 - animationSquareSize0, animationSquareSize0 * 2, animationSquareSize0 * 2, 0xdfff0000);<br />
abi_CMD_G2D_ADD_RECTANGLE(120 - animationSquareSize1, 120 - animationSquareSize1, animationSquareSize1 * 2, animationSquareSize1 * 2, 0xdfffff00);<br />
abi_CMD_G2D_ADD_RECTANGLE(120 - animationSquareSize2, 120 - animationSquareSize2, animationSquareSize2 * 2, animationSquareSize2 * 2, 0xdfff00ff);<br />
abi_CMD_G2D_ADD_RECTANGLE(120 - animationSquareSize3, 120 - animationSquareSize3, animationSquareSize3 * 2, animationSquareSize3 * 2, 0xdf00ffff);<br />
abi_CMD_G2D_ADD_SPRITE(resID, false, 120, 120, animationAlpha, 0x00000000, animationAngle, MIRROR_BLANK);<br />
abi_CMD_G2D_END();<br />
...<br />
<br />
====Font drawing functions====<br />
=====abi_CMD_TEXT=====<br />
API:<br />
abi_CMD_TEXT(const text[], const fontResID, const x, const y, const scale, const angle, const r, const g, const b)<br />
Description:<br />
: Intended to render a system font or a custom font from resources with specified coordinates, scale and rotation at an arbitrary angle.<br />
Arguments:<br />
: ''text''<br />
:: Array of chars.<br />
: ''fontResID''<br />
:: Custom font resource identifier. Provide ''-1'' to use system font resource.<br />
: ''x'', ''y''<br />
:: Coordinates of top left rectangle corner.<br />
: ''scale'', ''angle''<br />
:: Percentage scale and clockwise rotation angle in degrees. Max size of font is 200x200 px. (scale = 100%)<br />
: ''r'', ''g'', ''b''<br />
:: Font color in RGB format.<br />
<br />
Example:<br />
new text[4] = ['A', 'p', 'p', '\0'];<br />
abi_CMD_TEXT(text, RES_ID_FONT, 90, 160, 16, current_angles[face], 255, 0, 0);<br />
<br />
====TEXTURE drawing functions====<br />
=====abi_CMD_DYNAMIC_TEXTURE=====<br />
<br />
API:<br />
<br />
abi_CMD_DYNAMIC_TEXTURE(const effectId = 1, const time = any value, const args[] = {0x04030201, 0x08070605, 0x00000A09}, const argsCount = 3, const bool:g2d = false)<br />
<br />
Description:<br />
: Render a texture with chosen algorithm and parameters.<br />
Arguments:<br />
: ''effectId''<br />
:: Define algorithm to render texture. <br />
:: Available values : G2D_DYNAMIC_TEXTURE_MOSAIC <br />
<br />
: ''time ''<br />
:: Current time value. Use any fixed value to static texture or set current time value in milliseconds to make texture alive.<br />
: ''args'', ''argsCount''<br />
:: Byte stream of algorithm settings it's aligned to 4 bytes, because of pawn supports only 32-bit values.<br />
:: Size of array depends on algorithm. For example mosaic algorithm has size of settings equals 10 bytes , so we must use aligned 4 bytes - 12 bytes array and argsCount = 3<br />
<br />
: ''g2d''<br />
:: false - Use pawn default buffer to draw texture.<br />
:: true - Use g2d buffer to draw texture - not supported now.<br />
<br />
'''G2D_DYNAMIC_TEXTURE_MOSAIC''' alogrithm description<br />
<br />
:So in effect named 'mosaic' we have settings of 10 parameters each one 1 byte<br />
<br />
:Noise factors :<br />
::factor x : values from 0 to 10<br />
::factor y : values from 0 to 10<br />
::factor xy : values from 0 to 10<br />
:Time factors :<br />
::factor x : values from 0 to 10<br />
::factor y : values from 0 to 10<br />
::factor xy : values from 0 to 10<br />
:Color factors :<br />
::r : values from 0 to 10<br />
::g : values from 0 to 10<br />
::b : values from 0 to 10<br />
:Zoom factor :<br />
::zoom values from 0 to 10<br />
<br />
For example we want to set all parameters above with values in order 1,2,3,4,5,6,7,8,9,10. Take in attention that each parameter is 1 byte we must make array of 32-bit values<br />
0x04030201, 0x08070605, 0x00000A09<br />
<br />
Example:<br />
mosaic_effect_settings = { 0x04030201, 0x08070605, 0x00000A09 };<br />
mosaic_effect_settings_length = 3;<br />
abi_CMD_DYNAMIC_TEXTURE(G2D_DYNAMIC_TEXTURE_MOSAIC , currentTime, mosaic_effect_settings, mosaic_effect_settings_length);<br />
<br />
===Motion sensors===<br />
====abi_MTD_GetFaceAccel(X/Y/Z)====<br />
Syntax:<br />
abi_MTD_GetFaceAccelX(const faceN)<br />
abi_MTD_GetFaceAccelY(const faceN)<br />
abi_MTD_GetFaceAccelZ(const faceN)<br />
Description:<br />
: Get the value of acceleration along the requested axis.<br />
Arguments<br />
: ''faceN''<br />
:: Number of the module face for which requested axis is belong.<br />
<br />
====abi_MTD_GetFaceGyro(X/Y/Z)====<br />
Syntax:<br />
abi_MTD_GetFaceGyroX(const faceN)<br />
abi_MTD_GetFaceGyroY(const faceN)<br />
abi_MTD_GetFaceGyroZ(const faceN)<br />
Description:<br />
: Get the gyro value around the requested axis.<br />
Arguments<br />
: ''faceN''<br />
:: Number of the module face for which requested axis is belong.<br />
<br />
====abi_MTD_GetTapFace====<br />
Syntax:<br />
abi_MTD_GetTapFace()<br />
Description:<br />
: Get the face ID which was tapped. ID is not a face number which is used for drawing in abi_CMD_G2D_BEGIN_DISPLAY or abi_CMD_REDRAW, but that number can be calculated by subtracting by one from ID value. See possible values below.<br />
Return values:<br />
: ''MTD_TAP_DIRECTION_NONE = 0''<br />
:: Indicates that the module wan not tapped.<br />
: ''MTD_TAP_DIRECTION_X = 1''<br />
: ''MTD_TAP_DIRECTION_Y = 2''<br />
: ''MTD_TAP_DIRECTION_Z = 3''<br />
:: Indicated direction of tap.<br />
<br />
====abi_MTD_IsTapOpposite====<br />
Syntax:<br />
abi_MTD_IsTapOpposite()<br />
Description:<br />
: Get the flag if the tap was detected in opposite direction.<br />
<br />
====abi_MTD_GetTapsCount====<br />
Syntax:<br />
abi_MTD_GetTapsCount()<br />
Description:<br />
: Get the count of subsequent taps. Tap is treated as a subsequent if it was detected within predefined interval (350ms). Count will be zero until sequence is finished, i.e. next tap is not detected within interval.<br />
<br />
====abi_checkShake====<br />
Syntax:<br />
abi_checkShake()<br />
Description:<br />
: Checks if the number of shakes of the cube was more than a certain threshold then exits the script <br />
<br />
<br />
====Examples====<br />
1. Flash the face on which tap was detected. Print an ID of that face. Color of the flash depends on taps count: red - one tap, green - two taps and blue - three.<br />
new delay = 0;<br />
new color = 0x000000; <br />
ONTICK() {<br />
if (!color) {<br />
switch (abi_MTD_GetTapsCount()) {<br />
case 1:<br />
color = 0xff0000;<br />
case 2:<br />
color = 0x00ff00;<br />
case 3:<br />
color = 0x0000ff;<br />
}<br />
}<br />
if (delay % 25 == 0) {<br />
for (new i = 0; i < FACES_MAX; i++) {<br />
if (i == (abi_MTD_GetTapFace() - 1)) {<br />
abi_CMD_FILL_2(color);<br />
color = 0x000000;<br />
switch (abi_MTD_GetTapFace()) {<br />
case 1:<br />
abi_CMD_TEXT(['1', '\0'], -1, 120, 120, 14, 0, 0xff, 0xff, 0xff);<br />
case 2:<br />
abi_CMD_TEXT(['2', '\0'], -1, 120, 120, 14, 0, 0xff, 0xff, 0xff);<br />
case 3:<br />
abi_CMD_TEXT(['3', '\0'], -1, 120, 120, 14, 0, 0xff, 0xff, 0xff);<br />
}<br />
} else {<br />
abi_CMD_FILL(0, 0, 0);<br />
}<br />
abi_CMD_REDRAW(i);<br />
}<br />
}<br />
delay++;<br />
}<br />
2. Exit from script<br />
ONTICK() {<br />
if (abi_cubeN == 0) {<br />
abi_checkShake();<br />
}<br />
// Script logic<br />
}<br />
<br />
===Save/load functions===<br />
<br />
====abi_CMD_SAVE_STATE====<br />
Syntax:<br />
bool:abi_CMD_SAVE_STATE(const data[], size = sizeof(data))<br />
Description:<br />
: Save maximum 256 bytes of data to wowcube flash memory.<br />
Arguments<br />
: ''data''<br />
:: Game data to save.<br />
: ''size''<br />
:: Size of game data.<br />
Return values:<br />
: ''return false''<br />
:: If size is bigger then 256 bytes.<br />
<br />
====abi_CMD_LOAD_STATE====<br />
Syntax:<br />
abi_CMD_LOAD_STATE()<br />
Description:<br />
: Sends a command requesting the platform to load script data. The response from the platform is not instantaneous and takes several milliseconds.<br />
<br />
====Examples====<br />
1. Load data at the start.<br />
// This function is called when a response is received from the platform<br />
ON_LOAD_GAME_DATA (const pkt[]) {<br />
// Deserialize pkt<br />
currentLevelNumber = pkt[1]; // Starting with 1 cause 0 pkt element holding command ID<br />
score = pkt[2];<br />
moves = pkt[3];<br />
...<br />
record = pkt[8];<br />
}<br />
ON_INIT () {<br />
abi_CMD_LOAD_STATE ();<br />
}<br />
<br />
2. Save the data after the end of the level.<br />
SaveGameState () {<br />
new saveData [GAME_SAVE_SIZE];<br />
// Assign all necessary data<br />
saveData[0] = currentLevelNumber;<br />
saveData[1] = score;<br />
saveData[2] = moves;<br />
...<br />
saveData[7] = record;<br />
<br />
abi_CMD_SAVE_STATE (saveData);<br />
}<br />
ON_CHECK_ROTATE () {<br />
if (isLevelFinished) {<br />
SaveGameState();<br />
}<br />
}<br />
<br />
===Time functions===<br />
====abi_GetTime====<br />
Syntax:<br />
abi_GetTime()<br />
Description:<br />
: Get current time in milliseconds.<br />
<br />
====Examples====<br />
new previousTime = 0;<br />
new currentTime = 0;<br />
new deltaTime = 0;<br />
ON_INIT() {<br />
previousTime = abi_GetTime();<br />
}<br />
ONTICK() {<br />
currentTime = abi_GetTime();<br />
deltaTime = currentTime - previousTime;<br />
previousTime = currentTime;<br />
}<br />
<br />
<br />
===Topology functions===<br />
====get cube/face====<br />
Syntax:<br />
abi_topCubeN(const _cubeN, const _faceN)<br />
abi_topFaceN(const _cubeN, const _faceN)<br />
abi_rightCubeN(const _cubeN, const _faceN)<br />
abi_rightFaceN(const _cubeN, const _faceN)<br />
abi_bottomCubeN(const _cubeN, const _faceN)<br />
abi_bottomFaceN(const _cubeN, const _faceN)<br />
abi_leftCubeN(const _cubeN, const _faceN)<br />
abi_leftFaceN(const _cubeN, const _faceN)<br />
Description:<br />
: Returns the cube / screen located at the top / bottom / left / right of the specified in parameters.<br />
<br />
====Examples====<br />
Find diagonal face and cube<br />
new diagonalCube = CUBES_MAX;<br />
new diagonalFace = FACES_MAX;<br />
new topCube = abi_topCubeN(cube, face);<br />
new topFace = abi_topFaceN(cube, face);<br />
if (topCube < CUBES_MAX) {<br />
diagonalCube = abi_topCubeN(topCube, topFace);<br />
if (diagonalCube < CUBES_MAX) {<br />
diagonalFace = abi_topFaceN(topCube, topFace);<br />
}<br />
}</div>Raccoon piratehttps://wiki.wowcube.com/index.php?title=SDK&diff=160SDK2021-06-16T12:01:37Z<p>Raccoon pirate: </p>
<hr />
<div>SDK/Framework<br />
<br />
*[[pawn]]<br />
<br />
==WOWCube Emulator installation==<br />
<br />
===Windows===<br />
Launch the wowcube-sdk.exe installer and follow the steps of the installer.<br />
<br />
Installing Dependencies (for Pawn Application Developers) <br />
To run scripts written in the Pawn language, you need to install Python 3, Pip, IntelHex, and Pillow.<br />
<br />
<br />
'''Installing Python'''<br />
<br />
Go to the site https://www.python.org/downloads/windows/, click on the "Latest Python 3 Release" link, wait for the download to complete.<br />
[[File:Highlight_Latest_Python_3_Release_link.png]]<br />
<br />
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".<br />
[[File:Python_installation_configuration.png]]<br />
<br />
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.<br />
[[File:Python_disable_path_length_limit.png]]<br />
<br />
<br />
'''Installing libraries'''<br />
<br />
To install the dependencies, you need to start the terminal. Go to Start menu (or press Windows key + X) and select Windows PowerShell.<br />
<br />
[[File:Start_menu_with_PowerShell.png]]<br />
<br />
Type command "pip install intelhex pillow" and press enter. <br />
[[File:Intelhex_and_pillow_installation.png]]<br />
<br />
This command will download and install the IntelHex and Pillow dependencies. If the installation is successful, a corresponding message will be displayed. <br />
<br />
If your company uses a proxy, then you need to add the --proxy option to the command above. The option has the following format:<br />
<br />
[user: password @] proxy.server: port<br />
<br />
For example:<br />
<br />
''pip install --proxy = http: //proxy.jf.intel.com: 911 intelhex pillow''<br />
<br />
===macOS===<br />
<br />
Open the .dmg file, drag the WOWCube Emulator application into the Applications folder. <br />
[[File:Installation_on_macOS.png]]<br />
<br />
If the .dmg file was downloaded not in the App Store, then an error will pop up when starting the application.<br />
[[File:Error_message_macOS_emulator_installation.png]]<br />
<br />
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.<br />
<br />
[[File:Terminal_window_in_macOS.png]]<br />
<br />
In the terminal, write the command ''/ Applications / WOWCube \ Emulator.app/Contents/MacOS/bin/wowcube'' and press enter.<br />
<br />
If the following error occurs<br />
<br />
''/ usr / bin / env: bad interpreter: Operation not permitted, or zsh: operation not permitted: / Applications / WOWCube Emulator.app/Contents/MacOS/bin/wowcube''<br />
<br />
Then run the following command ''xattr -rd com.apple.quarantine / Applications / WOWCube \ Emulator.app/''. It will output errors Permission Denied, but they are expected.<br />
<br />
<br />
'''Installing Python'''<br />
<br />
For macOS version below Catalina open a terminal, install and download Homebrew<br />
<br />
''/ bin / bash -c "$ (curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"''<br />
<br />
Homebrew is a package manager that lets you install Open Source applications.<br />
<br />
Next, install Python 3 and Pip<br />
<br />
''brew install python3''<br />
<br />
''brew cask install python3''<br />
<br />
<br />
For macOS by Catalina. First you need to make sure that python is installed and that it is the correct version.<br />
<br />
''python3 -V''<br />
<br />
This command should print “Python 3.x.x”. If the command did not display anything, or was not found, try to execute<br />
<br />
''python -V''<br />
<br />
If it displays “Python 2.x.x”, then Python 3 is not installed.<br />
<br />
<br />
Install pip:<br />
<br />
''curl -fsSL https://bootstrap.pypa.io/get-pip.py | python3''<br />
<br />
[[File:Check_for_python_and_installing_pip.png]]<br />
<br />
<br />
'''Installing labraries'''<br />
<br />
Install IntelHex and Pillow libraries.<br />
<br />
''pip3 install pillow intelhex''<br />
<br />
==Starting WOWCube Emulator==<br />
<br />
===Windows===<br />
<br />
Launch WOWCube Emulator by clicking on shortcut on desktop.<br />
<br />
[[File:WOWCube_Emulator_shortcut_windows.png]]<br />
<br />
On first launch, a warning from the firewall will appear.<br />
<br />
[[File:Windows_security_alert_first_emulator_launch.png]]<br />
<br />
Allow access. WOWCube Emulator uses local ports for communication between the processes it creates, as well as for projector mode.<br />
<br />
===macOS===<br />
<br />
Open terminal and enter ''WOWCube Emulator'' then and press Enter.<br />
<br />
==WOWCube Emulator interface==<br />
<br />
There are 4 main groups of widgets in the WOWCube Emulator interface.<br />
<br />
[[File:WOWCube_Emulator_UI.png]]<br />
<br />
'''First group'''<br />
<br />
Contains links for interacting with the cube module. Buttons from left to right:<br />
<br />
* simulates the shaking of a cube<br />
* returns the cube module to its original state (restoring rotations and position)<br />
* rotates a random side of the cube<br />
<br />
'''Second group'''<br />
<br />
Serves to interact with the progress of the script. Buttons from left to right:<br />
<br />
* start emulation of the selected pawn script. Аfter startup is replaced by the emulation restart button<br />
* stops pawn script emulation<br />
* loading a script to a physical cube using the bluetooth protocol<br />
<br />
'''Third group'''<br />
<br />
'''''Project tab'''''<br />
<br />
In this tab you can choose one of two modes of operation:<br />
<br />
* Pawn;<br />
* Projector.<br />
<br />
''Projector mode''<br />
<br />
The projector is used to transfer images from a computer or mobile device to the WOWCube via the Bluetooth protocol.<br />
<br />
The projector in the WOWCube Emulator is used for prototyping and faster development of web-projector applications.<br />
<br />
''Pawn Mode''<br />
<br />
In this mode, you can:<br />
<br />
* select the path to the projects folder<br />
* select a startup project<br />
* view additional data for a running project<br />
<br />
'''''View tab'''''<br />
<br />
The Sound adjusts the overall volume.<br />
<br />
[[File:WOWCube_Emulator_view_tab_sound.png]]<br />
<br />
In the Emulation, the transparency of the overlay is adjusted. The overlay displays on each module its current number, screen and adjacent modules.<br />
<br />
The Limit FPS slider allows you to limit the frame rate in the application running on the emulator.<br />
<br />
If necessary, it is possible to configure the simulation of lost packets during transmission.<br />
<br />
[[File:WOWCube_Emulator_view_tab_emulation.png]]<br />
<br />
In the CubeNet, the transparency and the size of the cube unfolding are configured.<br />
<br />
[[File:WOWCube_Emulator_view_tab_CubeNet.png]]<br />
<br />
In the Scene, the removal of the camera, the field of view, the backdrop are configured.<br />
<br />
[[File:WOWCube_Emulator_view_tab_scene.png]]<br />
<br />
'''''Settings Tab'''''<br />
<br />
This is where the PAWN compiler path and python path are selected. <br />
<br />
[[File:WOWCube_Emulator_settings_tab.png]]<br />
<br />
'''Fourth group'''<br />
<br />
Contains tabs for displaying script assembly logs and tabs with the console of each module separately.<br />
<br />
===Controls===<br />
<br />
LMB on a cube - rotation of the sides.<br />
<br />
RMB (or Ctrl + LMB) on a cube - tilt the cube.<br />
<br />
RMB (or Ctrl + LMB) past the cube - rotate the camera.<br />
<br />
Mouse wheel - zoom out / zoom in the camera.</div>Raccoon piratehttps://wiki.wowcube.com/index.php?title=File:WOWCube_Emulator_settings_tab.png&diff=159File:WOWCube Emulator settings tab.png2021-06-16T11:57:36Z<p>Raccoon pirate: WOWCube Emulator guide. Settings tab in emulator.</p>
<hr />
<div>== Summary ==<br />
WOWCube Emulator guide. Settings tab in emulator.</div>Raccoon piratehttps://wiki.wowcube.com/index.php?title=File:WOWCube_Emulator_view_tab_scene.png&diff=158File:WOWCube Emulator view tab scene.png2021-06-16T11:51:56Z<p>Raccoon pirate: WOWCube Emulator guide. Scene settings in view tab.</p>
<hr />
<div>== Summary ==<br />
WOWCube Emulator guide. Scene settings in view tab.</div>Raccoon piratehttps://wiki.wowcube.com/index.php?title=File:WOWCube_Emulator_view_tab_CubeNet.png&diff=157File:WOWCube Emulator view tab CubeNet.png2021-06-16T11:50:21Z<p>Raccoon pirate: WOWCube Emulator guide. CubeNet setting in view tab.</p>
<hr />
<div>== Summary ==<br />
WOWCube Emulator guide. CubeNet setting in view tab.</div>Raccoon piratehttps://wiki.wowcube.com/index.php?title=File:WOWCube_Emulator_view_tab_emulation.png&diff=156File:WOWCube Emulator view tab emulation.png2021-06-16T11:46:04Z<p>Raccoon pirate: WOWCube Emulator guide. Emulation settings in view tab.</p>
<hr />
<div>== Summary ==<br />
WOWCube Emulator guide. Emulation settings in view tab.</div>Raccoon piratehttps://wiki.wowcube.com/index.php?title=File:WOWCube_Emulator_view_tab_sound.png&diff=155File:WOWCube Emulator view tab sound.png2021-06-16T11:43:48Z<p>Raccoon pirate: WOWCube Emulator guide. Sound settings in view tab.</p>
<hr />
<div>== Summary ==<br />
WOWCube Emulator guide. Sound settings in view tab.</div>Raccoon piratehttps://wiki.wowcube.com/index.php?title=File:WOWCube_Emulator_UI.png&diff=154File:WOWCube Emulator UI.png2021-06-16T10:36:46Z<p>Raccoon pirate: WOWCube Emulator guide. Basic elements of emulator.</p>
<hr />
<div>== Summary ==<br />
WOWCube Emulator guide. Basic elements of emulator.</div>Raccoon piratehttps://wiki.wowcube.com/index.php?title=SDK&diff=153SDK2021-06-16T09:40:58Z<p>Raccoon pirate: </p>
<hr />
<div>SDK/Framework<br />
<br />
*[[pawn]]<br />
<br />
==WOWCube Emulator installation==<br />
<br />
===Windows===<br />
Launch the wowcube-sdk.exe installer and follow the steps of the installer.<br />
<br />
Installing Dependencies (for Pawn Application Developers) <br />
To run scripts written in the Pawn language, you need to install Python 3, Pip, IntelHex, and Pillow.<br />
<br />
<br />
'''Installing Python'''<br />
<br />
Go to the site https://www.python.org/downloads/windows/, click on the "Latest Python 3 Release" link, wait for the download to complete.<br />
[[File:Highlight_Latest_Python_3_Release_link.png]]<br />
<br />
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".<br />
[[File:Python_installation_configuration.png]]<br />
<br />
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.<br />
[[File:Python_disable_path_length_limit.png]]<br />
<br />
<br />
'''Installing libraries'''<br />
<br />
To install the dependencies, you need to start the terminal. Go to Start menu (or press Windows key + X) and select Windows PowerShell.<br />
<br />
[[File:Start_menu_with_PowerShell.png]]<br />
<br />
Type command "pip install intelhex pillow" and press enter. <br />
[[File:Intelhex_and_pillow_installation.png]]<br />
<br />
This command will download and install the IntelHex and Pillow dependencies. If the installation is successful, a corresponding message will be displayed. <br />
<br />
If your company uses a proxy, then you need to add the --proxy option to the command above. The option has the following format:<br />
<br />
[user: password @] proxy.server: port<br />
<br />
For example:<br />
<br />
''pip install --proxy = http: //proxy.jf.intel.com: 911 intelhex pillow''<br />
<br />
===macOS===<br />
<br />
Open the .dmg file, drag the WOWCube Emulator application into the Applications folder. <br />
[[File:Installation_on_macOS.png]]<br />
<br />
If the .dmg file was downloaded not in the App Store, then an error will pop up when starting the application.<br />
[[File:Error_message_macOS_emulator_installation.png]]<br />
<br />
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.<br />
<br />
[[File:Terminal_window_in_macOS.png]]<br />
<br />
In the terminal, write the command ''/ Applications / WOWCube \ Emulator.app/Contents/MacOS/bin/wowcube'' and press enter.<br />
<br />
If the following error occurs<br />
<br />
''/ usr / bin / env: bad interpreter: Operation not permitted, or zsh: operation not permitted: / Applications / WOWCube Emulator.app/Contents/MacOS/bin/wowcube''<br />
<br />
Then run the following command ''xattr -rd com.apple.quarantine / Applications / WOWCube \ Emulator.app/''. It will output errors Permission Denied, but they are expected.<br />
<br />
<br />
'''Installing Python'''<br />
<br />
For macOS version below Catalina open a terminal, install and download Homebrew<br />
<br />
''/ bin / bash -c "$ (curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"''<br />
<br />
Homebrew is a package manager that lets you install Open Source applications.<br />
<br />
Next, install Python 3 and Pip<br />
<br />
''brew install python3''<br />
<br />
''brew cask install python3''<br />
<br />
<br />
For macOS by Catalina. First you need to make sure that python is installed and that it is the correct version.<br />
<br />
''python3 -V''<br />
<br />
This command should print “Python 3.x.x”. If the command did not display anything, or was not found, try to execute<br />
<br />
''python -V''<br />
<br />
If it displays “Python 2.x.x”, then Python 3 is not installed.<br />
<br />
<br />
Install pip:<br />
<br />
''curl -fsSL https://bootstrap.pypa.io/get-pip.py | python3''<br />
<br />
[[File:Check_for_python_and_installing_pip.png]]<br />
<br />
<br />
'''Installing labraries'''<br />
<br />
Install IntelHex and Pillow libraries.<br />
<br />
''pip3 install pillow intelhex''<br />
<br />
==Starting WOWCube Emulator==<br />
<br />
===Windows===<br />
<br />
Launch WOWCube Emulator by clicking on shortcut on desktop.<br />
<br />
[[File:WOWCube_Emulator_shortcut_windows.png]]<br />
<br />
On first launch, a warning from the firewall will appear.<br />
<br />
[[File:Windows_security_alert_first_emulator_launch.png]]<br />
<br />
Allow access. WOWCube Emulator uses local ports for communication between the processes it creates, as well as for projector mode.<br />
<br />
===macOS===<br />
<br />
Open terminal and enter ''WOWCube Emulator'' then and press Enter.</div>Raccoon piratehttps://wiki.wowcube.com/index.php?title=File:Windows_security_alert_first_emulator_launch.png&diff=152File:Windows security alert first emulator launch.png2021-06-16T09:37:34Z<p>Raccoon pirate: WOWCube Emulator guide. Firewall warning message on first WOWCube Emulator launch.</p>
<hr />
<div>== Summary ==<br />
WOWCube Emulator guide. Firewall warning message on first WOWCube Emulator launch.</div>Raccoon piratehttps://wiki.wowcube.com/index.php?title=File:WOWCube_Emulator_shortcut_windows.png&diff=151File:WOWCube Emulator shortcut windows.png2021-06-16T09:33:24Z<p>Raccoon pirate: WOWCube Emulator guide. WOWCube Emulator application shortcut.</p>
<hr />
<div>== Summary ==<br />
WOWCube Emulator guide. WOWCube Emulator application shortcut.</div>Raccoon piratehttps://wiki.wowcube.com/index.php?title=File:Check_for_python_and_installing_pip.png&diff=150File:Check for python and installing pip.png2021-06-16T09:06:09Z<p>Raccoon pirate: WOWCube Emulator guide. Installing pip on macOS.</p>
<hr />
<div>== Summary ==<br />
WOWCube Emulator guide. Installing pip on macOS.</div>Raccoon piratehttps://wiki.wowcube.com/index.php?title=File:Terminal_window_in_macOS.png&diff=149File:Terminal window in macOS.png2021-06-16T08:21:39Z<p>Raccoon pirate: WOWCube Emulator guide. MacOS terminal window.</p>
<hr />
<div>== Summary ==<br />
WOWCube Emulator guide. MacOS terminal window.</div>Raccoon piratehttps://wiki.wowcube.com/index.php?title=File:Error_message_macOS_emulator_installation.png&diff=148File:Error message macOS emulator installation.png2021-06-16T08:00:04Z<p>Raccoon pirate: WOWCube Emulator guide. Error message when WOWCube emulator fails to launch on macOS.</p>
<hr />
<div>== Summary ==<br />
WOWCube Emulator guide. Error message when WOWCube emulator fails to launch on macOS.</div>Raccoon piratehttps://wiki.wowcube.com/index.php?title=File:Installation_on_macOS.png&diff=147File:Installation on macOS.png2021-06-16T07:54:30Z<p>Raccoon pirate: WOWCube Emulator guide. Installation WOWCube Emulator on macOS.</p>
<hr />
<div>== Summary ==<br />
WOWCube Emulator guide. Installation WOWCube Emulator on macOS.</div>Raccoon piratehttps://wiki.wowcube.com/index.php?title=SDK&diff=146SDK2021-06-16T07:39:20Z<p>Raccoon pirate: </p>
<hr />
<div>SDK/Framework<br />
<br />
*[[pawn]]<br />
<br />
==WOWCube Emulator installation==<br />
<br />
===Windows===<br />
Launch the wowcube-sdk.exe installer and follow the steps of the installer.<br />
<br />
Installing Dependencies (for Pawn Application Developers) <br />
To run scripts written in the Pawn language, you need to install Python 3, Pip, IntelHex, and Pillow.<br />
<br />
<br />
Installing Python<br />
<br />
Go to the site https://www.python.org/downloads/windows/, click on the "Latest Python 3 Release" link, wait for the download to complete.<br />
[[File:Highlight_Latest_Python_3_Release_link.png]]<br />
<br />
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".<br />
[[File:Python_installation_configuration.png]]<br />
<br />
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.<br />
[[File:Python_disable_path_length_limit.png]]<br />
<br />
<br />
Installing libraries<br />
<br />
To install the dependencies, you need to start the terminal. Go to Start menu (or press Windows key + X) and select Windows PowerShell.<br />
<br />
[[File:Start_menu_with_PowerShell.png]]<br />
<br />
Type command "pip install intelhex pillow" and press enter. <br />
[[File:Intelhex_and_pillow_installation.png]]<br />
<br />
This command will download and install the IntelHex and Pillow dependencies. If the installation is successful, a corresponding message will be displayed. <br />
<br />
If your company uses a proxy, then you need to add the --proxy option to the command above. The option has the following format:<br />
<br />
[user: password @] proxy.server: port<br />
<br />
For example:<br />
<br />
pip install --proxy = http: //proxy.jf.intel.com: 911 intelhex pillow</div>Raccoon piratehttps://wiki.wowcube.com/index.php?title=File:Intelhex_and_pillow_installation.png&diff=145File:Intelhex and pillow installation.png2021-06-16T07:37:46Z<p>Raccoon pirate: WOWCube Emulator guide. Python dependencies installation precess.</p>
<hr />
<div>== Summary ==<br />
WOWCube Emulator guide. Python dependencies installation precess.</div>Raccoon piratehttps://wiki.wowcube.com/index.php?title=File:Start_menu_with_PowerShell.png&diff=144File:Start menu with PowerShell.png2021-06-16T07:13:44Z<p>Raccoon pirate: WOWCube Emulator guide. Windows PowerShell in Start menu.</p>
<hr />
<div>== Summary ==<br />
WOWCube Emulator guide. Windows PowerShell in Start menu.</div>Raccoon piratehttps://wiki.wowcube.com/index.php?title=File:Python_disable_path_length_limit.png&diff=143File:Python disable path length limit.png2021-06-16T07:01:11Z<p>Raccoon pirate: WOWCube Emulator guide. Disable path length limit for python libraries.</p>
<hr />
<div>== Summary ==<br />
WOWCube Emulator guide. Disable path length limit for python libraries.</div>Raccoon piratehttps://wiki.wowcube.com/index.php?title=File:Python_installation_configuration.png&diff=142File:Python installation configuration.png2021-06-16T06:50:53Z<p>Raccoon pirate: WOWCube Emulator guide. Recommended configuration for installing python.</p>
<hr />
<div>== Summary ==<br />
WOWCube Emulator guide. Recommended configuration for installing python.</div>Raccoon piratehttps://wiki.wowcube.com/index.php?title=File:Highlight_Latest_Python_3_Release_link.png&diff=141File:Highlight Latest Python 3 Release link.png2021-06-16T06:26:01Z<p>Raccoon pirate: WOWCube Emulator guide. Highlighted link to python 3 for windows.</p>
<hr />
<div>== Summary ==<br />
WOWCube Emulator guide. Highlighted link to python 3 for windows.</div>Raccoon piratehttps://wiki.wowcube.com/index.php?title=SDK&diff=140SDK2021-06-15T13:21:15Z<p>Raccoon pirate: </p>
<hr />
<div>SDK/Framework<br />
<br />
*[[pawn]]<br />
<br />
==WOWCube Emulator installation==<br />
<br />
===Windows===<br />
Launch the wowcube-sdk.exe installer and follow the steps of the installer.<br />
<br />
Installing Dependencies (for Pawn Application Developers) <br />
To run scripts written in the Pawn language, you need to install Python 3, Pip, IntelHex, and Pillow.<br />
<br />
<br />
Installing Python<br />
<br />
Go to the site https://www.python.org/downloads/windows/, click on the "Latest Python 3 Release" link, wait for the download to complete <br />
<br />
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".<br />
<br />
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.<br />
<br />
<br />
Installing libraries<br />
<br />
Open any terminal. This can be done in different ways: by Right-clicking on the "Start" button, or by the keyboard shortcut ⊞ (Win) + X (English).<br />
<br />
Open the Windows administrative menu.<br />
<br />
In it, select Windows PowerShell or Command Prompt (Command Prompt).<br />
<br />
A terminal opens. In the terminal, you need to write a command "pip install intelhex pillow" and press the Enter/↵/Return button on the keyboard:<br />
<br />
This command will download and install the IntelHex and Pillow dependencies. If the installation is successful, a corresponding message will be displayed. <br />
<br />
If your company uses a proxy, then you need to add the --proxy option to the command above. The option has the following format:<br />
<br />
[user: password @] proxy.server: port<br />
For example:<br />
<br />
pip install --proxy = http: //proxy.jf.intel.com: 911 intelhex pillow</div>Raccoon piratehttps://wiki.wowcube.com/index.php?title=About&diff=139About2021-06-15T12:08:02Z<p>Raccoon pirate: </p>
<hr />
<div>== WOWCube® System==<br />
<br />
WOWCube® system is the World’s first mixed-reality entertainment device that combines the best from classical 3D puzzle cube and video games and delivers an unprecedented immersive experience where virtual gameplay is controlled by physically tilting, twisting, and shaking the device.<br />
<br />
It’s an interesting and exciting gadget with tons of games and features, like smartphones and consoles.<br />
<br />
At the same time, it’s a Smart Educational platform for cognitive and motor to brain development for kids and the whole family designed to keep it far from the eyes thinking in 3 dimensions.<br />
<br />
It is a stand-alone digital device that uses a Tangible interface and Mixed Reality to create an exciting development environment with unusual characteristics in which puzzle-like dynamic games can work.<br />
<br />
== Cubios Inc ==<br />
<br />
Cubios Inc. is a company based in Novato, CA which focuses on hi-tech consumer robotic toys and entertainment game platforms design, development, marketing, and distribution. Cubios inc. was founded as an independent research, development, and manufacturing company focused on cutting-edge technologies. Cubios Studio is a game studio for Digital Apps & Widgets.<br />
<br />
'''Ilya Osipov'''<br />
President&Founder<br />
<br />
''' Savva Osipov'''<br />
Idea Creator, Evangelist<br />
<br />
'''Max Filin'''<br />
CEO<br />
<br />
== Inventors ==<br />
<br />
Initially, the idea of the product belongs to [[Savva Osipov]] and [[Ilya Osipov]]. Which were later joined by [[Semyon Orlov]], [[Max Filin]] and other team members.<br />
<br />
The idea was invented on September 10, 2016 and inspired by the products of Sifteo and Rubik's Cube<br />
<br />
== Team ==<br />
:Semyon Orlov - Главный Инженер, со-изобретатель магнитных коннекторов и базовой конструкции куба, автор идеи игр ...<br />
:Max Filin - CEO и операционный директор компании, автор идеи игр Bonbon, BluePrint <br />
:Valentine Zubkov - Главный дизанер компании. Автор внешнего вида устройства и фирменного стиля компании<br />
:...<br />
<br />
== How it was invented? ==<br />
<br />
As Ilya Osipov likes to say he has always loved 3D puzzles. One of the mechanical puzzles he developed won a global puzzle design competition prize. <br />
<br />
The whole house was full of different puzzles, moreover, he was engaged in IT for many years, and he and his son Savva took part in a computer contest based on Arduino, and Raspberry Pi.<br />
<br />
Ilya's son, Savva Osipov, who was 12 years old, gave the idea of the WOWCube® system. <br />
<br />
Ilya and Savva discussed the idea of Sifteo, its concept, pros, and cons. Savva noticed that it would be more interesting to make screens not on separate cubes, but on a single Rubik’s cube. And thus the game characters could run from screen to screen. The way to control them would be the turns, as in the Rubik’s cube. <br />
<br />
Ilya thought that even though it’s more difficult but it would definitely be more interesting. He considered the idea and decided that he could build such a device.<br />
<br />
The most difficult part was the topology of the device. Not only did it need to rotate mechanically like a Rubik’s Cube, but it also needed to do so while supporting electrical and mathematical integrity.<br />
<br />
* How to place microprocessors inside the device? <br />
<br />
* How to make the parts understand their current relative position? <br />
<br />
* How to provide data transfer and synchronize operations? <br />
<br />
* How to make the environment work as a single device while performing distributed computing? <br />
<br />
<br />
In the end, there are 8 processors in the device. All this required an unusual approach. <br />
<br />
When Ilya wrote the first C++ program for an early prototype, he was literally dizzy.<br />
<br />
It was necessary to create mapping matrices of the faces of different screens and to ensure their re-calculation after any rotation done by the user. <br />
<br />
The first thing done was an analog of the game Digger. When the Digger began to successfully run from screen to screen, it became clear that the concept was right, and everything was feasible.<br />
<br />
There was also a very big question of how to make reliable connections between the parts of the device. <br />
<br />
Inspired by Apple’s MagSafe, Ilya designed magnetic connections with self-orientating magnetic contacts, which, unlike MagSafe’s male to female connections, had unisex connections. This allowed any part inside the cube to connect evenly and perfectly to each other, no matter how the cube is rotated.<br />
All these were just conceptual models. <br />
<br />
They received practical implementation when the chief engineer, Semyon Orlov, joined the project. He applied Ilya's ideas in practice to finalize the prototype.<br />
<br />
The idea came up in late 2016. Then it took time to analyze the idea. The first prototype based on Arduino was made in Spring 2017. It was printed on an in-house 3D printer just to prove the concept. <br />
<br />
In total, 4 basic prototypes and dozens of variations were made.<br />
<br />
== Publications ==<br />
<br />
Osipov, I. V. (2017). <b>Cubios Transreality Puzzle as a Mixed Reality Object</b>. In <i>International Journal of Virtual and Augmented Reality (IJVAR)</i>, 1(2), 1-17.<br />
<br />
Osipov, I. V. (2017). <b>Transreality puzzle as new genres of entertainment technology</b>. In <i>arXiv preprint arXiv:1705.03973</i>.<br />
<br />
Osipov, I. V., & Nikulchev, E. (2018, November). <b>WOWCube Puzzle: A Transreality Object of Mixed Reality."</b> In <i>Proceedings of the Future Technologies Conference. Springer</i>, Cham.<br />
<br />
Osipov, I. V., Nikulchev, E., Egoryshkin, I., & Orlov, S. (2018). <b>Gamification Device Wowcube: Design And Program Environment.</b> In <i>ICPE 2018-International Conference on Psychology and Education</i> (pp. 496-505).<br />
<br />
Osipov, I. V., & Nikulchev, E. (2018). <b>Review puzzles and construction sets falling under the category of augmented reality games</b>. In <i>In ITM Web of Conferences (Vol. 18, p. 02003). EDP Sciences.</i><br />
<br />
Orlov, S. O., Egoryshkin, I. S., & Nikulchev, E. V. (2020). <b>Development of a game application for a custom eight-processor device with a tangible interface</b>. In <i>International Journal of Open Information Technologies</i>, 8(3), 40-46.</div>Raccoon piratehttps://wiki.wowcube.com/index.php?title=Development&diff=138Development2021-06-15T12:06:04Z<p>Raccoon pirate: </p>
<hr />
<div>This is a section about developing applications for WOWCUBE<br />
<br />
<br />
<br />
WOWCUBE supports several approaches to programming content for it:<br />
<br />
:1. Development of specialized applets (cublets) that are executed and stored on a cube as on a stand-alone device:<br />
<br />
:It can be carried out in the PAWN language. PAWN is a derivative of “Small C” (See [https://github.com/compuphase/pawn/blob/master/doc/Pawn_Language_Guide.pdf Pawn_Language_Guide.pdf], and [https://wiki.alliedmods.net/Pawn_Tutorial Pawn Tutorial])<br />
<br />
:[[API|WOWCUBE PAWN API]] - Guide to specific pawn cube functions<br />
<br />
<br />
:2. Development using [https://webassembly.org/ WebAssembly] ( based on wasm3 ) <br />
:[[WASM|WOWCUBE WASM API]] - Guide to specific wasm cube functions<br />
<br />
<br />
:3. Development of programs for smartphones (or other external devices) transmitting data and graphics to the cube as to an external device, according to the protocol BlueTooth. We call this mode "Projector"<br />
<br />
<br />
:4. Development using WOWCube Emulator. Software that allows you to develop games and applications for Wowcube without having a physical device.<br />
<br />
:[[SDK|WOWCUBE Emulator]] - Emulator Guide</div>Raccoon piratehttps://wiki.wowcube.com/index.php?title=API&diff=137API2021-06-14T12:40:03Z<p>Raccoon pirate: </p>
<hr />
<div>{{notice|This is a beta version, API changes can be made without warning.}}<br />
<br />
=Introduction=<br />
<br />
The main functions of the API are listed here, the features of the work of the environment are described<br />
<br />
==WOWCube Paradigms==<br />
<br />
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.<br />
<br />
==Pawn API==<br />
===Graphic functions===<br />
<br />
====Graphics 2D acceleration (G2D)====<br />
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:<br />
[[File:Cascade.png|center|G2D cascading scheme]]<br />
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.<br />
Basic coordinate principle:<br />
[[File:G2d_coordinates.png|center|G2D coordinates sceme]]<br />
Coordinates are limited from -2048 to 2047. Maximum layers size is 240x240.<br />
<br />
=====abi_CMD_G2D_BEGIN_BITMAP=====<br />
Syntax:<br />
abi_CMD_G2D_BEGIN_BITMAP(const resID, const width, const height, const bool:replace)<br />
Description:<br />
: 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.<br />
Arguments:<br />
: ''resID''<br />
:: 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.<br />
: ''width'' <br />
:: Width of the resulting resource. G2D engine can keep resource of 240px width maximum.<br />
: ''height'' <br />
:: Height of the resulting resource. G2D engine can keep resource of 240px height maximum.<br />
: ''replace'' <br />
:: If true, then an existing image will be replaced completely, otherwise it will be overwritten by reusing itself as a background layer.<br />
<br />
=====abi_CMD_G2D_BEGIN_DISPLAY=====<br />
Syntax:<br />
abi_CMD_G2D_BEGIN_DISPLAY(const display, const bool:replace)<br />
Description:<br />
: 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.<br />
Arguments:<br />
: ''display''<br />
:: ID of the display which framebuffer will be used for blending. Each module have 3 displays with ID starting from 0.<br />
: ''replace'' <br />
:: If true then an existing image will be replaced completely, otherwise it will be overwritten by reusing itself as a background layer.<br />
<br />
=====abi_CMD_G2D_ADD_SPRITE=====<br />
Syntax:<br />
abi_CMD_G2D_ADD_SPRITE(const resID, const bool:g2d, const x, const y, const alpha, const color, const rotation, const mirror)<br />
Description:<br />
: Specifies game resource which will be used as a layer for blending.<br />
Arguments:<br />
: ''resID''<br />
:: ID of the resource to be uses as a layer.<br />
: ''g2d''<br />
:: Indicates if an internal G2D resource is specified or not.<br />
: ''x'', ''y''<br />
:: Coordinates of the bitmap center to place on the layer.<br />
: ''alpha''<br />
:: Layer transparency in range between 0x00 and 0xFF, where 0x00 is a fully transparent layer.<br />
: ''color''<br />
:: Layer's source key - a color in ARGB8888 format to be avoided.<br />
: ''rotation''<br />
:: Clockwise rotation angle in degrees. It is possible to specify free angle, but only right angles have HW acceleration. Currently rotation only applicable for external resources.<br />
: ''mirror''<br />
:: Mirroring variant. Possible values are self-explained: MIRROR_BLANK, MIRROR_X, MIRROR_Y, MIRROR_XY.<br />
<br />
=====abi_CMD_G2D_ADD_RECTANGLE=====<br />
Syntax:<br />
abi_CMD_G2D_ADD_RECTANGLE(const x, const y, const width, const height, const color)<br />
Description:<br />
: 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.<br />
Arguments:<br />
: ''x'', ''y''<br />
:: Coordinates of top left rectangle corner.<br />
: ''width''<br />
:: Rectangle width.<br />
: ''height''<br />
:: Rectangle height.<br />
: ''color''<br />
:: Rectangle color in ARGB8888 format.<br />
<br />
=====abi_CMD_G2D_END=====<br />
Syntax:<br />
abi_CMD_G2D_END()<br />
Description:<br />
: 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.<br />
<br />
=====Examples=====<br />
1. Render into inner G2D resource buffer #face and display it on the display #face. Please, note that last argument of abi_CMD_BITMAP is a `true` flag, which means G2D resource should be used:<br />
...<br />
abi_CMD_G2D_BEGIN_BITMAP(face, 240, 240, true);<br />
abi_CMD_G2D_ADD_RECTANGLE(120 - animationSquareSize0, 120 - animationSquareSize0, animationSquareSize0 * 2, animationSquareSize0 * 2, 0xdfff0000);<br />
abi_CMD_G2D_ADD_RECTANGLE(120 - animationSquareSize1, 120 - animationSquareSize1, animationSquareSize1 * 2, animationSquareSize1 * 2, 0xdfffff00);<br />
abi_CMD_G2D_ADD_RECTANGLE(120 - animationSquareSize2, 120 - animationSquareSize2, animationSquareSize2 * 2, animationSquareSize2 * 2, 0xdfff00ff);<br />
abi_CMD_G2D_ADD_RECTANGLE(120 - animationSquareSize3, 120 - animationSquareSize3, animationSquareSize3 * 2, animationSquareSize3 * 2, 0xdf00ffff);<br />
abi_CMD_G2D_ADD_SPRITE(resID, false, 120, 120, animationAlpha, 0x00000000, animationAngle, MIRROR_BLANK);<br />
abi_CMD_G2D_END();<br />
...<br />
abi_CMD_BITMAP(face, 120, 120, 0, MIRROR_BLANK, true);<br />
...<br />
abi_CMD_REDRAW(face);<br />
...<br />
2. Render directly into display framebuffer #face. This will produce same result on display as example #1, but the generated image is not saved:<br />
...<br />
abi_CMD_G2D_BEGIN_DISPLAY(face, true);<br />
abi_CMD_G2D_ADD_RECTANGLE(120 - animationSquareSize0, 120 - animationSquareSize0, animationSquareSize0 * 2, animationSquareSize0 * 2, 0xdfff0000);<br />
abi_CMD_G2D_ADD_RECTANGLE(120 - animationSquareSize1, 120 - animationSquareSize1, animationSquareSize1 * 2, animationSquareSize1 * 2, 0xdfffff00);<br />
abi_CMD_G2D_ADD_RECTANGLE(120 - animationSquareSize2, 120 - animationSquareSize2, animationSquareSize2 * 2, animationSquareSize2 * 2, 0xdfff00ff);<br />
abi_CMD_G2D_ADD_RECTANGLE(120 - animationSquareSize3, 120 - animationSquareSize3, animationSquareSize3 * 2, animationSquareSize3 * 2, 0xdf00ffff);<br />
abi_CMD_G2D_ADD_SPRITE(resID, false, 120, 120, animationAlpha, 0x00000000, animationAngle, MIRROR_BLANK);<br />
abi_CMD_G2D_END();<br />
...<br />
<br />
====Font drawing functions====<br />
=====abi_CMD_TEXT=====<br />
API:<br />
abi_CMD_TEXT(const text[], const fontResID, const x, const y, const scale, const angle, const r, const g, const b)<br />
Description:<br />
: Intended to render a system font or a custom font from resources with specified coordinates, scale and rotation at an arbitrary angle.<br />
Arguments:<br />
: ''text''<br />
:: Array of chars.<br />
: ''fontResID''<br />
:: Custom font resource identifier. Provide ''-1'' to use system font resource.<br />
: ''x'', ''y''<br />
:: Coordinates of top left rectangle corner.<br />
: ''scale'', ''angle''<br />
:: Percentage scale and clockwise rotation angle in degrees. Max size of font is 200x200 px. (scale = 100%)<br />
: ''r'', ''g'', ''b''<br />
:: Font color in RGB format.<br />
<br />
Example:<br />
new text[4] = ['A', 'p', 'p', '\0'];<br />
abi_CMD_TEXT(text, RES_ID_FONT, 90, 160, 16, current_angles[face], 255, 0, 0);<br />
<br />
====TEXTURE drawing functions====<br />
=====abi_CMD_DYNAMIC_TEXTURE=====<br />
<br />
API:<br />
<br />
abi_CMD_DYNAMIC_TEXTURE(const effectId = 1, const time = any value, const args[] = {0x04030201, 0x08070605, 0x00000A09}, const argsCount = 3, const bool:g2d = false)<br />
<br />
Description:<br />
: Render a texture with chosen algorithm and parameters.<br />
Arguments:<br />
: ''effectId''<br />
:: Define algorithm to render texture. <br />
:: Available values : G2D_DYNAMIC_TEXTURE_MOSAIC <br />
<br />
: ''time ''<br />
:: Current time value. Use any fixed value to static texture or set current time value in milliseconds to make texture alive.<br />
: ''args'', ''argsCount''<br />
:: Byte stream of algorithm settings it's aligned to 4 bytes, because of pawn supports only 32-bit values.<br />
:: Size of array depends on algorithm. For example mosaic algorithm has size of settings equals 10 bytes , so we must use aligned 4 bytes - 12 bytes array and argsCount = 3<br />
<br />
: ''g2d''<br />
:: false - Use pawn default buffer to draw texture.<br />
:: true - Use g2d buffer to draw texture - not supported now.<br />
<br />
'''G2D_DYNAMIC_TEXTURE_MOSAIC''' alogrithm description<br />
<br />
:So in effect named 'mosaic' we have settings of 10 parameters each one 1 byte<br />
<br />
:Noise factors :<br />
::factor x : values from 0 to 10<br />
::factor y : values from 0 to 10<br />
::factor xy : values from 0 to 10<br />
:Time factors :<br />
::factor x : values from 0 to 10<br />
::factor y : values from 0 to 10<br />
::factor xy : values from 0 to 10<br />
:Color factors :<br />
::r : values from 0 to 10<br />
::g : values from 0 to 10<br />
::b : values from 0 to 10<br />
:Zoom factor :<br />
::zoom values from 0 to 10<br />
<br />
For example we want to set all parameters above with values in order 1,2,3,4,5,6,7,8,9,10. Take in attention that each parameter is 1 byte we must make array of 32-bit values<br />
0x04030201, 0x08070605, 0x00000A09<br />
<br />
Example:<br />
mosaic_effect_settings = { 0x04030201, 0x08070605, 0x00000A09 };<br />
mosaic_effect_settings_length = 3;<br />
abi_CMD_DYNAMIC_TEXTURE(G2D_DYNAMIC_TEXTURE_MOSAIC , currentTime, mosaic_effect_settings, mosaic_effect_settings_length);<br />
<br />
===Motion sensors===<br />
====abi_MTD_GetFaceAccel(X/Y/Z)====<br />
Syntax:<br />
abi_MTD_GetFaceAccelX(const faceN)<br />
abi_MTD_GetFaceAccelY(const faceN)<br />
abi_MTD_GetFaceAccelZ(const faceN)<br />
Description:<br />
: Get the value of acceleration along the requested axis.<br />
Arguments<br />
: ''faceN''<br />
:: Number of the module face for which requested axis is belong.<br />
<br />
====abi_MTD_GetFaceGyro(X/Y/Z)====<br />
Syntax:<br />
abi_MTD_GetFaceGyroX(const faceN)<br />
abi_MTD_GetFaceGyroY(const faceN)<br />
abi_MTD_GetFaceGyroZ(const faceN)<br />
Description:<br />
: Get the gyro value around the requested axis.<br />
Arguments<br />
: ''faceN''<br />
:: Number of the module face for which requested axis is belong.<br />
<br />
====abi_MTD_GetTapFace====<br />
Syntax:<br />
abi_MTD_GetTapFace()<br />
Description:<br />
: Get the face ID which was tapped. ID is not a face number which is used for drawing in abi_CMD_G2D_BEGIN_DISPLAY or abi_CMD_REDRAW, but that number can be calculated by subtracting by one from ID value. See possible values below.<br />
Return values:<br />
: ''MTD_TAP_DIRECTION_NONE = 0''<br />
:: Indicates that the module wan not tapped.<br />
: ''MTD_TAP_DIRECTION_X = 1''<br />
: ''MTD_TAP_DIRECTION_Y = 2''<br />
: ''MTD_TAP_DIRECTION_Z = 3''<br />
:: Indicated direction of tap.<br />
<br />
====abi_MTD_IsTapOpposite====<br />
Syntax:<br />
abi_MTD_IsTapOpposite()<br />
Description:<br />
: Get the flag if the tap was detected in opposite direction.<br />
<br />
====abi_MTD_GetTapsCount====<br />
Syntax:<br />
abi_MTD_GetTapsCount()<br />
Description:<br />
: Get the count of subsequent taps. Tap is treated as a subsequent if it was detected within predefined interval (350ms). Count will be zero until sequence is finished, i.e. next tap is not detected within interval.<br />
<br />
====abi_checkShake====<br />
Syntax:<br />
abi_checkShake()<br />
Description:<br />
: Checks if the number of shakes of the cube was more than a certain threshold then exits the script <br />
<br />
<br />
====Examples====<br />
1. Flash the face on which tap was detected. Print an ID of that face. Color of the flash depends on taps count: red - one tap, green - two taps and blue - three.<br />
new delay = 0;<br />
new color = 0x000000; <br />
ONTICK() {<br />
if (!color) {<br />
switch (abi_MTD_GetTapsCount()) {<br />
case 1:<br />
color = 0xff0000;<br />
case 2:<br />
color = 0x00ff00;<br />
case 3:<br />
color = 0x0000ff;<br />
}<br />
}<br />
if (delay % 25 == 0) {<br />
for (new i = 0; i < FACES_MAX; i++) {<br />
if (i == (abi_MTD_GetTapFace() - 1)) {<br />
abi_CMD_FILL_2(color);<br />
color = 0x000000;<br />
switch (abi_MTD_GetTapFace()) {<br />
case 1:<br />
abi_CMD_TEXT(['1', '\0'], -1, 120, 120, 14, 0, 0xff, 0xff, 0xff);<br />
case 2:<br />
abi_CMD_TEXT(['2', '\0'], -1, 120, 120, 14, 0, 0xff, 0xff, 0xff);<br />
case 3:<br />
abi_CMD_TEXT(['3', '\0'], -1, 120, 120, 14, 0, 0xff, 0xff, 0xff);<br />
}<br />
} else {<br />
abi_CMD_FILL(0, 0, 0);<br />
}<br />
abi_CMD_REDRAW(i);<br />
}<br />
}<br />
delay++;<br />
}<br />
2. Exit from script<br />
ONTICK() {<br />
if (abi_cubeN == 0) {<br />
abi_checkShake();<br />
}<br />
// Script logic<br />
}<br />
<br />
===Save/load functions===<br />
<br />
====abi_CMD_SAVE_STATE====<br />
Syntax:<br />
bool:abi_CMD_SAVE_STATE(const data[], size = sizeof(data))<br />
Description:<br />
: Save maximum 32 bytes of data to wowcube flash memory.<br />
Arguments<br />
: ''data''<br />
:: Game data to save.<br />
: ''size''<br />
:: Size of game data.<br />
Return values:<br />
: ''return false''<br />
:: If size is bigger then 32 bytes.<br />
<br />
<br />
====abi_CMD_LOAD_STATE====<br />
Syntax:<br />
abi_CMD_LOAD_STATE()<br />
Description:<br />
: Sends a command requesting the platform to load script data. The response from the platform is not instantaneous and takes several milliseconds.<br />
<br />
====Examples====<br />
1. Load data at the start.<br />
// This function is called when a response is received from the platform<br />
ON_LOAD_GAME_DATA (const pkt[]) {<br />
// Deserialize pkt<br />
currentLevelNumber = pkt[1]; // Starting with 1 cause 0 pkt element holding command ID<br />
score = pkt[2];<br />
moves = pkt[3];<br />
...<br />
record = pkt[8];<br />
}<br />
ON_INIT () {<br />
abi_CMD_LOAD_STATE ();<br />
}<br />
<br />
2. Save the data after the end of the level.<br />
SaveGameState () {<br />
new saveData [GAME_SAVE_SIZE];<br />
// Assign all necessary data<br />
saveData[0] = currentLevelNumber;<br />
saveData[1] = score;<br />
saveData[2] = moves;<br />
...<br />
saveData[7] = record;<br />
<br />
abi_CMD_SAVE_STATE (saveData);<br />
}<br />
ON_CHECK_ROTATE () {<br />
if (isLevelFinished) {<br />
SaveGameState();<br />
}<br />
}<br />
<br />
===Time functions===<br />
====abi_GetTime====<br />
Syntax:<br />
abi_GetTime()<br />
Description:<br />
: Get current time in milliseconds.<br />
<br />
====Examples====<br />
new previousTime = 0;<br />
new currentTime = 0;<br />
new deltaTime = 0;<br />
ON_INIT() {<br />
previousTime = abi_GetTime();<br />
}<br />
ONTICK() {<br />
currentTime = abi_GetTime();<br />
deltaTime = currentTime - previousTime;<br />
previousTime = currentTime;<br />
}<br />
<br />
<br />
===Topology functions===<br />
====get cube/face====<br />
Syntax:<br />
abi_topCubeN(const _cubeN, const _faceN)<br />
abi_topFaceN(const _cubeN, const _faceN)<br />
abi_rightCubeN(const _cubeN, const _faceN)<br />
abi_rightFaceN(const _cubeN, const _faceN)<br />
abi_bottomCubeN(const _cubeN, const _faceN)<br />
abi_bottomFaceN(const _cubeN, const _faceN)<br />
abi_leftCubeN(const _cubeN, const _faceN)<br />
abi_leftFaceN(const _cubeN, const _faceN)<br />
Description:<br />
: Returns the cube / screen located at the top / bottom / left / right of the specified in parameters.<br />
<br />
====Examples====<br />
Find diagonal face and cube<br />
new diagonalCube = CUBES_MAX;<br />
new diagonalFace = FACES_MAX;<br />
new topCube = abi_topCubeN(cube, face);<br />
new topFace = abi_topFaceN(cube, face);<br />
if (topCube < CUBES_MAX) {<br />
diagonalCube = abi_topCubeN(topCube, topFace);<br />
if (diagonalCube < CUBES_MAX) {<br />
diagonalFace = abi_topFaceN(topCube, topFace);<br />
}<br />
}</div>Raccoon piratehttps://wiki.wowcube.com/index.php?title=API&diff=136API2021-06-14T11:42:10Z<p>Raccoon pirate: </p>
<hr />
<div>{{notice|This is a beta version, API changes can be made without warning.}}<br />
<br />
=Introduction=<br />
<br />
The main functions of the API are listed here, the features of the work of the environment are described<br />
<br />
==WOWCube Paradigms==<br />
<br />
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.<br />
<br />
==Pawn API==<br />
===Graphic functions===<br />
<br />
====Graphics 2D acceleration (G2D)====<br />
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:<br />
[[File:Cascade.png|center|G2D cascading scheme]]<br />
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.<br />
Basic coordinate principle:<br />
[[File:G2d_coordinates.png|center|G2D coordinates sceme]]<br />
Coordinates are limited from -2048 to 2047. Maximum layers size is 240x240.<br />
<br />
=====abi_CMD_G2D_BEGIN_BITMAP=====<br />
Syntax:<br />
abi_CMD_G2D_BEGIN_BITMAP(const resID, const width, const height, const bool:replace)<br />
Description:<br />
: 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.<br />
Arguments:<br />
: ''resID''<br />
:: 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.<br />
: ''width'' <br />
:: Width of the resulting resource. G2D engine can keep resource of 240px width maximum.<br />
: ''height'' <br />
:: Height of the resulting resource. G2D engine can keep resource of 240px height maximum.<br />
: ''replace'' <br />
:: If true, then an existing image will be replaced completely, otherwise it will be overwritten by reusing itself as a background layer.<br />
<br />
=====abi_CMD_G2D_BEGIN_DISPLAY=====<br />
Syntax:<br />
abi_CMD_G2D_BEGIN_DISPLAY(const display, const bool:replace)<br />
Description:<br />
: 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.<br />
Arguments:<br />
: ''display''<br />
:: ID of the display which framebuffer will be used for blending. Each module have 3 displays with ID starting from 0.<br />
: ''replace'' <br />
:: If true then an existing image will be replaced completely, otherwise it will be overwritten by reusing itself as a background layer.<br />
<br />
=====abi_CMD_G2D_ADD_SPRITE=====<br />
Syntax:<br />
abi_CMD_G2D_ADD_SPRITE(const resID, const bool:g2d, const x, const y, const alpha, const color, const rotation, const mirror)<br />
Description:<br />
: Specifies game resource which will be used as a layer for blending.<br />
Arguments:<br />
: ''resID''<br />
:: ID of the resource to be uses as a layer.<br />
: ''g2d''<br />
:: Indicates if an internal G2D resource is specified or not.<br />
: ''x'', ''y''<br />
:: Coordinates of the bitmap center to place on the layer.<br />
: ''alpha''<br />
:: Layer transparency in range between 0x00 and 0xFF, where 0x00 is a fully transparent layer.<br />
: ''color''<br />
:: Layer's source key - a color in ARGB8888 format to be avoided.<br />
: ''rotation''<br />
:: Clockwise rotation angle in degrees. It is possible to specify free angle, but only right angles have HW acceleration. Currently rotation only applicable for external resources.<br />
: ''mirror''<br />
:: Mirroring variant. Possible values are self-explained: MIRROR_BLANK, MIRROR_X, MIRROR_Y, MIRROR_XY.<br />
<br />
=====abi_CMD_G2D_ADD_RECTANGLE=====<br />
Syntax:<br />
abi_CMD_G2D_ADD_RECTANGLE(const x, const y, const width, const height, const color)<br />
Description:<br />
: 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.<br />
Arguments:<br />
: ''x'', ''y''<br />
:: Coordinates of top left rectangle corner.<br />
: ''width''<br />
:: Rectangle width.<br />
: ''height''<br />
:: Rectangle height.<br />
: ''color''<br />
:: Rectangle color in ARGB8888 format.<br />
<br />
=====abi_CMD_G2D_END=====<br />
Syntax:<br />
abi_CMD_G2D_END()<br />
Description:<br />
: 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.<br />
<br />
=====Examples=====<br />
1. Render into inner G2D resource buffer #face and display it on the display #face. Please, note that last argument of abi_CMD_BITMAP is a `true` flag, which means G2D resource should be used:<br />
...<br />
abi_CMD_G2D_BEGIN_BITMAP(face, 240, 240, true);<br />
abi_CMD_G2D_ADD_RECTANGLE(120 - animationSquareSize0, 120 - animationSquareSize0, animationSquareSize0 * 2, animationSquareSize0 * 2, 0xdfff0000);<br />
abi_CMD_G2D_ADD_RECTANGLE(120 - animationSquareSize1, 120 - animationSquareSize1, animationSquareSize1 * 2, animationSquareSize1 * 2, 0xdfffff00);<br />
abi_CMD_G2D_ADD_RECTANGLE(120 - animationSquareSize2, 120 - animationSquareSize2, animationSquareSize2 * 2, animationSquareSize2 * 2, 0xdfff00ff);<br />
abi_CMD_G2D_ADD_RECTANGLE(120 - animationSquareSize3, 120 - animationSquareSize3, animationSquareSize3 * 2, animationSquareSize3 * 2, 0xdf00ffff);<br />
abi_CMD_G2D_ADD_SPRITE(resID, false, 120, 120, animationAlpha, 0x00000000, animationAngle, MIRROR_BLANK);<br />
abi_CMD_G2D_END();<br />
...<br />
abi_CMD_BITMAP(face, 120, 120, 0, MIRROR_BLANK, true);<br />
...<br />
abi_CMD_REDRAW(face);<br />
...<br />
2. Render directly into display framebuffer #face. This will produce same result on display as example #1, but the generated image is not saved:<br />
...<br />
abi_CMD_G2D_BEGIN_DISPLAY(face, true);<br />
abi_CMD_G2D_ADD_RECTANGLE(120 - animationSquareSize0, 120 - animationSquareSize0, animationSquareSize0 * 2, animationSquareSize0 * 2, 0xdfff0000);<br />
abi_CMD_G2D_ADD_RECTANGLE(120 - animationSquareSize1, 120 - animationSquareSize1, animationSquareSize1 * 2, animationSquareSize1 * 2, 0xdfffff00);<br />
abi_CMD_G2D_ADD_RECTANGLE(120 - animationSquareSize2, 120 - animationSquareSize2, animationSquareSize2 * 2, animationSquareSize2 * 2, 0xdfff00ff);<br />
abi_CMD_G2D_ADD_RECTANGLE(120 - animationSquareSize3, 120 - animationSquareSize3, animationSquareSize3 * 2, animationSquareSize3 * 2, 0xdf00ffff);<br />
abi_CMD_G2D_ADD_SPRITE(resID, false, 120, 120, animationAlpha, 0x00000000, animationAngle, MIRROR_BLANK);<br />
abi_CMD_G2D_END();<br />
...<br />
<br />
====Font drawing functions====<br />
=====abi_CMD_TEXT=====<br />
API:<br />
abi_CMD_TEXT(const text[], const fontResID, const x, const y, const scale, const angle, const r, const g, const b)<br />
Description:<br />
: Intended to render a system font or a custom font from resources with specified coordinates, scale and rotation at an arbitrary angle.<br />
Arguments:<br />
: ''text''<br />
:: Array of chars.<br />
: ''fontResID''<br />
:: Custom font resource identifier. Provide ''-1'' to use system font resource.<br />
: ''x'', ''y''<br />
:: Coordinates of top left rectangle corner.<br />
: ''scale'', ''angle''<br />
:: Percentage scale and clockwise rotation angle in degrees. Max size of font is 200x200 px. (scale = 100%)<br />
: ''r'', ''g'', ''b''<br />
:: Font color in RGB format.<br />
<br />
Example:<br />
new text[4] = ['A', 'p', 'p', '\0'];<br />
abi_CMD_TEXT(text, RES_ID_FONT, 90, 160, 16, current_angles[face], 255, 0, 0);<br />
<br />
====TEXTURE drawing functions====<br />
=====abi_CMD_DYNAMIC_TEXTURE=====<br />
<br />
API:<br />
<br />
abi_CMD_DYNAMIC_TEXTURE(const effectId = 1, const time = any value, const args[] = {0x04030201, 0x08070605, 0x00000A09}, const argsCount = 3, const bool:g2d = false)<br />
<br />
Description:<br />
: Render a texture with chosen algorithm and parameters.<br />
Arguments:<br />
: ''effectId''<br />
:: Define algorithm to render texture. <br />
:: Available values : G2D_DYNAMIC_TEXTURE_MOSAIC <br />
<br />
: ''time ''<br />
:: Current time value. Use any fixed value to static texture or set current time value in milliseconds to make texture alive.<br />
: ''args'', ''argsCount''<br />
:: Byte stream of algorithm settings it's aligned to 4 bytes, because of pawn supports only 32-bit values.<br />
:: Size of array depends on algorithm. For example mosaic algorithm has size of settings equals 10 bytes , so we must use aligned 4 bytes - 12 bytes array and argsCount = 3<br />
<br />
: ''g2d''<br />
:: false - Use pawn default buffer to draw texture.<br />
:: true - Use g2d buffer to draw texture - not supported now.<br />
<br />
'''G2D_DYNAMIC_TEXTURE_MOSAIC''' alogrithm description<br />
<br />
:So in effect named 'mosaic' we have settings of 10 parameters each one 1 byte<br />
<br />
:Noise factors :<br />
::factor x : values from 0 to 10<br />
::factor y : values from 0 to 10<br />
::factor xy : values from 0 to 10<br />
:Time factors :<br />
::factor x : values from 0 to 10<br />
::factor y : values from 0 to 10<br />
::factor xy : values from 0 to 10<br />
:Color factors :<br />
::r : values from 0 to 10<br />
::g : values from 0 to 10<br />
::b : values from 0 to 10<br />
:Zoom factor :<br />
::zoom values from 0 to 10<br />
<br />
For example we want to set all parameters above with values in order 1,2,3,4,5,6,7,8,9,10. Take in attention that each parameter is 1 byte we must make array of 32-bit values<br />
0x04030201, 0x08070605, 0x00000A09<br />
<br />
Example:<br />
mosaic_effect_settings = { 0x04030201, 0x08070605, 0x00000A09 };<br />
mosaic_effect_settings_length = 3;<br />
abi_CMD_DYNAMIC_TEXTURE(G2D_DYNAMIC_TEXTURE_MOSAIC , currentTime, mosaic_effect_settings, mosaic_effect_settings_length);<br />
<br />
===Motion sensors===<br />
====abi_MTD_GetFaceAccel(X/Y/Z)====<br />
Syntax:<br />
abi_MTD_GetFaceAccelX(const faceN)<br />
abi_MTD_GetFaceAccelY(const faceN)<br />
abi_MTD_GetFaceAccelZ(const faceN)<br />
Description:<br />
: Get the value of acceleration along the requested axis.<br />
Arguments<br />
: ''faceN''<br />
:: Number of the module face for which requested axis is belong.<br />
<br />
====abi_MTD_GetFaceGyro(X/Y/Z)====<br />
Syntax:<br />
abi_MTD_GetFaceGyroX(const faceN)<br />
abi_MTD_GetFaceGyroY(const faceN)<br />
abi_MTD_GetFaceGyroZ(const faceN)<br />
Description:<br />
: Get the gyro value around the requested axis.<br />
Arguments<br />
: ''faceN''<br />
:: Number of the module face for which requested axis is belong.<br />
<br />
====abi_MTD_GetTapFace====<br />
Syntax:<br />
abi_MTD_GetTapFace()<br />
Description:<br />
: Get the face ID which was tapped. ID is not a face number which is used for drawing in abi_CMD_G2D_BEGIN_DISPLAY or abi_CMD_REDRAW, but that number can be calculated by subtracting by one from ID value. See possible values below.<br />
Return values:<br />
: ''MTD_TAP_DIRECTION_NONE = 0''<br />
:: Indicates that the module wan not tapped.<br />
: ''MTD_TAP_DIRECTION_X = 1''<br />
: ''MTD_TAP_DIRECTION_Y = 2''<br />
: ''MTD_TAP_DIRECTION_Z = 3''<br />
:: Indicated direction of tap.<br />
<br />
====abi_MTD_IsTapOpposite====<br />
Syntax:<br />
abi_MTD_IsTapOpposite()<br />
Description:<br />
: Get the flag if the tap was detected in opposite direction.<br />
<br />
====abi_MTD_GetTapsCount====<br />
Syntax:<br />
abi_MTD_GetTapsCount()<br />
Description:<br />
: Get the count of subsequent taps. Tap is treated as a subsequent if it was detected within predefined interval (350ms). Count will be zero until sequence is finished, i.e. next tap is not detected within interval.<br />
<br />
====abi_checkShake====<br />
Syntax:<br />
abi_checkShake()<br />
Description:<br />
: Checks if the number of shakes of the cube was more than a certain threshold then exits the script <br />
<br />
<br />
====Examples====<br />
1. Flash the face on which tap was detected. Print an ID of that face. Color of the flash depends on taps count: red - one tap, green - two taps and blue - three.<br />
new delay = 0;<br />
new color = 0x000000; <br />
ONTICK() {<br />
if (!color) {<br />
switch (abi_MTD_GetTapsCount()) {<br />
case 1:<br />
color = 0xff0000;<br />
case 2:<br />
color = 0x00ff00;<br />
case 3:<br />
color = 0x0000ff;<br />
}<br />
}<br />
if (delay % 25 == 0) {<br />
for (new i = 0; i < FACES_MAX; i++) {<br />
if (i == (abi_MTD_GetTapFace() - 1)) {<br />
abi_CMD_FILL_2(color);<br />
color = 0x000000;<br />
switch (abi_MTD_GetTapFace()) {<br />
case 1:<br />
abi_CMD_TEXT(['1', '\0'], -1, 120, 120, 14, 0, 0xff, 0xff, 0xff);<br />
case 2:<br />
abi_CMD_TEXT(['2', '\0'], -1, 120, 120, 14, 0, 0xff, 0xff, 0xff);<br />
case 3:<br />
abi_CMD_TEXT(['3', '\0'], -1, 120, 120, 14, 0, 0xff, 0xff, 0xff);<br />
}<br />
} else {<br />
abi_CMD_FILL(0, 0, 0);<br />
}<br />
abi_CMD_REDRAW(i);<br />
}<br />
}<br />
delay++;<br />
}<br />
2. Exit from script<br />
ONTICK() {<br />
if (abi_cubeN == 0) {<br />
abi_checkShake();<br />
}<br />
// Script logic<br />
}<br />
<br />
===Save/load functions===<br />
<br />
====abi_CMD_SAVE_STATE====<br />
Syntax:<br />
bool:abi_CMD_SAVE_STATE(const data[], size = sizeof(data))<br />
Description:<br />
: Save maximum 32 bytes of data to wowcube flash memory.<br />
Arguments<br />
: ''data''<br />
:: Game data to save.<br />
: ''size''<br />
:: Size of game data.<br />
Return values:<br />
: ''return false''<br />
:: If size is bigger then 32 bytes.<br />
<br />
<br />
====abi_CMD_LOAD_STATE====<br />
Syntax:<br />
abi_CMD_LOAD_STATE()<br />
Description:<br />
: Sends a command requesting the platform to load script data. The response from the platform is not instantaneous and takes several milliseconds.<br />
<br />
====Examples====<br />
1. Load data at the start.<br />
// This function is called when a response is received from the platform<br />
ON_LOAD_GAME_DATA (const pkt[]) {<br />
// Deserialize pkt<br />
currentLevelNumber = pkt[1]; // Starting with 1 cause 0 pkt element holding command ID<br />
score = pkt[2];<br />
moves = pkt[3];<br />
...<br />
record = pkt[8];<br />
}<br />
ON_INIT () {<br />
abi_CMD_LOAD_STATE ();<br />
}<br />
<br />
2. Save the data after the end of the level.<br />
SaveGameState () {<br />
new saveData [GAME_SAVE_SIZE];<br />
// Assign all necessary data<br />
saveData[0] = currentLevelNumber;<br />
saveData[1] = score;<br />
saveData[2] = moves;<br />
...<br />
saveData[7] = record;<br />
<br />
abi_CMD_SAVE_STATE (saveData);<br />
}<br />
ON_CHECK_ROTATE () {<br />
if (isLevelFinished) {<br />
SaveGameState();<br />
}<br />
}<br />
<br />
===Time functions===<br />
====abi_GetTime====<br />
Syntax:<br />
abi_GetTime()<br />
Description:<br />
: Get current time in milliseconds.<br />
<br />
====Examples====<br />
new previousTime = 0;<br />
new currentTime = 0;<br />
new deltaTime = 0;<br />
ON_INIT() {<br />
previousTime = abi_GetTime();<br />
}<br />
ONTICK() {<br />
currentTime = abi_GetTime();<br />
deltaTime = currentTime - previousTime;<br />
previousTime = currentTime;<br />
}</div>Raccoon pirate