SDK 6.3/PAWN/Splash Screen

From WowWiki
Revision as of 19:19, 25 July 2026 by WowBot (talk | contribs) (Official WOWCube SDK 6.3 documentation (automated publish from SDK headers))
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search
Official WOWCube SDK documentation. SDK 6.3, PAWN API. Generated from the canonical SDK headers — do not edit by hand; regenerate from source.

Enumerations

e_ssLeadersDataType

Syntax: 

const e_ssLeadersDataType:  {
    ssTypeNumber = 1,
        ssTypeTime = 2,
}

Description:

Enumeration of results type in the leader board.
  • ssTypeNumber - display scores in the leader board
  • ssTypeTime - display time in the leader board

e_ssLeaderBoardType

Syntax: 

const e_ssLeaderBoardType:  {
    ssWithoutSaves = 0,
        ssWithSaves = 1,
}

Description:

Enumeration of the leader board types.
  • ssWithoutSaves - first run of the application and it does not have saves and
previous results
  • ssWithSaves - application has a save to continue from

Constants and defines

e_ssScreensType

Syntax: 

const e_ssScreensType:  {
    ssEmpty = 0,
        ssFirstLeaderGroup,
        ssSecondLeaderGroup,
        ssHighScore,
        ssLeaderboardSprite,
        ssAppName,
        ssMainImage,
        ssLastResultsSprite,
        ssLastParameter1,
        ssLastParameter2,
        ssLastParameter3,
        ssTwistIcon,
        ssTwistLabelWithIcon,
        ssTwistLabelWithoutIcon,
        ssPatIcon,
        ssPatLabelWithIcon,
        ssPatLabelWithoutIcon,
        ssQRCode,
        ssTypeMax,
}

Description:

Enum the main preset types of screens.
  • ssEmpty - A blank screen, only the background is displayed
  • ssFirstLeaderGroup - Leaderboard screen with 1-5 positions
  • ssSecondLeaderGroup - Leaderboard screen with 6-10 positions
  • ssHighScore - The display screen of the personal best or
the top score of the leaderboard
  • ssLeaderboardSprite - Leaderboard sprite screen
  • ssAppName - App title screen
  • ssMainImage - App logo screen
  • ssLastResultsSprite - Last results sprite screen
  • ssLastParameter1 - Parameter1 screen
  • ssLastParameter2 - Parameter2 screen
  • ssLastParameter3 - Parameter3 screen
  • ssTwistIcon - Twist icon screen without label
  • ssTwistLabelWithIcon - Twist label screen with icon
  • ssTwistLabelWithoutIcon - Twist label screen without label
  • ssPatIcon - Pat icon screen without label
  • ssPatLabelWithIcon - Pat label screen with icon
  • ssPatLabelWithoutIcon - Pat label screen without label
  • ssQRCode - QR code screen
  • ssTypeMax - The maximum value of the types is used as the
first value of the user-defined types

SPLASH_SCREEN_MAX_LEADERS

Syntax: 

#define SPLASH_SCREEN_MAX_LEADERS 10

Description:

How many leaders can be displayed on the splash screen.

SPLASH_SCREEN_MAX_PARAMETERS

Syntax: 

#define SPLASH_SCREEN_MAX_PARAMETERS 3

Description:

How many different detailed parametr types exist.

LEADERBOARD_SIZE

Syntax: 

#define LEADERBOARD_SIZE 30

Description:

The size of the leaderboard array obtained in LB_getScore.

STRING_VALUE_SIZE

Syntax: 

#define STRING_VALUE_SIZE 15

Description:

The maximum length of a string to output a value.

Data structures

LEADER_DATA

Syntax: 

#define LEADER_DATA .name{16}, .value{STRING_VALUE_SIZE}

Description:

Array with named fields which represents a line in score table.
Fields:
  • name - user name
  • value - user score

LEADER_DATA

Syntax: 

#define PARAMETRS_DATA .name{10}, .value{STRING_VALUE_SIZE}, .fontSize

Description:

An array with named fields, which represents the values on
the parameters screen.
Fields:
  • name - user name
  • value - user score
  • fontSize - font size

LEADER_DATA

Syntax: 

#define RECORD_DATA .value{STRING_VALUE_SIZE}, .fontSize

Description:

An array with named fields, which represents the values on
the record screen.
Fields:
  • name - user name
  • value - user score
  • fontSize - font size

Functions

ssON_Render

Syntax: 

stock ssON_Render()

Description:

Splash screen ON_Render
Splash screen rendering

ssON_Tick

Syntax: 

stock ssON_Tick(dt)

Description:

Splash screen ON_Tick
Splash screen rendering

Arguments:

dt
Delta time between ticks

ssSetPlaces

Syntax: 

stock ssSetPlaces(place0[TOPOLOGY_PLACE], place1[TOPOLOGY_PLACE], place2[TOPOLOGY_PLACE])

Description:

Customize topology
Set user-defined topology

Arguments:

place0
the place for the 0 screen
place1
the place for the 1 screen
place2
the place for the 2 screen

ssSetPlaces

Syntax: 

stock ssGetPlace(screen)

Description:

Get topology for customize
Get topology for customize screens

Arguments:

screen
The ID of the screen

ssSetSplashScreenNamedValue

Syntax: 

stock ssSetSplashScreenNamedValue(name { 10 }, value, e_ssLeadersDataType:valueType = e_ssLeadersDataType:ssTypeNumber)

Description:

Set named value, for example: 'time', 'level' etc
Set named value, for example: 'time', 'level' etc

Arguments:

name
name of the parameter
value
value of the parameter
valueType
type of the parameter value

ssSetSplashScreenRecord

Syntax: 

stock ssSetSplashScreenRecord(value, e_ssLeadersDataType:valueType = e_ssLeadersDataType:ssTypeNumber)

Description:

Customize record
Set user-defined record

Arguments:

value
value of the record
valueType
type of the record value

SetSeparator

Syntax: 

stock ssSetSeparator(l_separator)

Description:

Customize twist and Pat labels
Set user-defined separator

Arguments:

l_separator
text separator for splitting into 2 lines

ssSetTexts

Syntax: 

stock ssSetTexts(patWI[] = "", patWoI[] = "", twistWI[] = "", twistWoI[] = "")

Description:

Customize twist and Pat labels
Set user-defined twist and Pat labels

Arguments:

patWI
the text for pat screen with icon
patWoI
the text for pat screen without icon
twistWI
the text for twist screen with icon
twistWoI
the text for twist screen without icon

ssSetApplicationNameText

Syntax: 

stock ssSetApplicationNameText(title { 64 })

Description:

Customize text of the application name
Set user-defined text of the application name. Used if the s
prite of the application title is missing

Arguments:

title
name of application

ssSetLeaderBoardTablePreset

Syntax: 

stock ssSetLeaderBoardTablePreset(e_ssLeaderBoardType:type)

Description:

Customize leaderboard table from preset
Set leaderBoardMapping from preset by type

Arguments:

type
The type of the preset table

See also: e_ssLeaderBoardType, e_ssLeadersDataType

ssSetLeaderBoardTable

Syntax: 

stock ssSetLeaderBoardTable(e_ssLeaderBoardType:leaderBoardTable[TOPOLOGY_FACES_MAX] { TOPOLOGY_POSITIONS_MAX })

Description:

Customize leaderboard table from user-defined table
Customize playback speed for animated icons
Set leaderBoardMapping from user-defined table
Set playback speed for animated icons

Arguments:

leaderBoardTable
user-defined table
pat
playback speed for pat icon
twist
playback speed for twist icon

See also: e_ssLeaderBoardType, e_ssLeadersDataType

ssSetQRCodeLink

Syntax: 

stock ssSetQRCodeLink(qrCodeLink { 32 })

Description:

Customize link for a QR Code
Set link for a QR Code. If not specified, the QR code sprite will be displayed

Arguments:

qrCodeLink
qrCodeLink

InitSplashScreenSprites

Syntax: 

stock InitSplashScreenSprites(backgroundSprite = -1,
    mainImageSprite = -1,
    gameNameSprite = -1,
    QRcodeSprite = -1,
    leaderboardIcon = -1,
    resultsIcon = -1,
    twistIcon_1 = -1,
    twistIcon_2 = -1,
    patIcon_1 = -1,
    patIcon_2 = -1,
    borderYou = -1)

Description:

Customize splash screen.
Set IDs of sprite used to draw different elements of the splash screen.

Arguments:

backgroundSprite
ID of a background image. If ID=-1, then a user defined render will be called
mainImageSprite
ID of an application logo, may differ from a menu
icon
gameNameSprite
ID of an image with application name, to display it with
some custom font
QRcodeSprite
ID of a QR code
leaderboardIcon
ID of a leader board icon
resultsIcon
ID of a result icon
twistIcon_1, twistIcon_2
IDs of twist animation images
patIcon_1, patIcon_2
IDs of Pat animation images
borderYou
a border that highlights you in the leaderboard

InitSplashScreenBasics

Syntax: 

stock InitSplashScreenBasics(base = 0xFFFFFFFF, key = 0xFFFFFFFF,
    e_ssLeadersDataType:dataType = ssTypeNumber)

Description:

Set how splash screen should be displayed.

Arguments:

base
base color for all text labels in ARGB8888 format
key
accent color for text labels in ARGB8888 format
leaderBoardType
type of splash screen
dataType
type of results in the leader board

See also: e_ssLeaderBoardType, e_ssLeadersDataType

InitSplashScreenBasics

Syntax: 

stock ssSetPosition(screen, x = 120, y = 120, angle = 0)

Description:

Calculation of coordinates and rotation angle relative to screen
rotation in topology

Arguments:

screen
The ID of the screen relative to which the coordinates
and rotation angle will be transformed
x
X coordinate
y
Y coordinate
angle
angle of rotation of sprite or text

InitSplashScreenBasics

Syntax: 

stock ssRenderImage(id)

Description:

Rendering image

Arguments:

id
Image ID

InitSplashScreenBasics

Syntax: 

stock ssRenderText(text[], size, color, align = TEXT_ALIGN_CENTER)

Description:

Rendering text

Arguments:

text
text to display
size
text size
color
text color
align
text align
Retrieved from "https://wiki.wowcube.com/index.php?title=SDK_6.3/PAWN/Splash_Screen&oldid=16855"