PawnLibs/splashscreen/SPLASH_SCREEN_MAX_LEADERS

Summary

How many leaders can be displayed on the splash screen.

Synopsis

1#define SPLASH_SCREEN_MAX_LEADERS 10
2 

PawnLibs/splashscreen/SPLASH_SCREEN_MAX_NAME_RESULTS

Summary

Maximum length of result type name.

Synopsis

1#define SPLASH_SCREEN_MAX_NAME_RESULTS 10
2 

PawnLibs/splashscreen/SPLASH_SCREEN_MAX_RESULTS

Summary

How many different detailed result types exist.

Synopsis

1#define SPLASH_SCREEN_MAX_RESULTS 4
2 

PawnLibs/splashscreen/USER_NAME_LENGTH_IN_CELLS

Summary

Maximum length of user name in cells.

Synopsis

1#define USER_NAME_LENGTH_IN_CELLS 3
2 

PawnLibs/splashscreen/LEADER_DATA

Summary

Array with named fields which represents a line in score table.

Synopsis

1#define LEADER_DATA .leaderName[USER_NAME_LENGTH_IN_CELLS], .leaderScore[4], .longNameFlag
2 

Description

Fields:

• leaderName - user name
• leaderScore - user score
• longNameFlag - flag that user name is too long and should be truncated

See also

• USER_NAME_LENGTH_IN_CELLS

PawnLibs/splashscreen/RESULT_DATA

Summary

Array with named fields which represents result data line

Synopsis

1#define RESULT_DATA .parameterName[SPLASH_SCREEN_MAX_NAME_RESULTS], .value[4], .valueType
2 

Description

Fields:

• parameterName - result name to display
• value - result value to display
• valueType - result type

See also

• SPLASH_SCREEN_MAX_NAME_RESULTS

PawnLibs/splashscreen/e_ssLeaderBoardType

Summary

Enumeration of the leader board types.

Synopsis

1const e_ssLeaderBoardType:  {
2    ssNoSaves = 0,
3        ssContinue = 1,
4        ssResultsOnly = 2,
5}
6 

Description

• ssNoSaves - first run of the application and it does not have saves and previous results
• ssContinue - application has a save to continue from
• ssResultsOnly - application has previous results but does not have a save to continue from

PawnLibs/splashscreen/e_ssLeadersDataType

Summary

Enumeration of results type in the leader board.

Synopsis

1const e_ssLeadersDataType:  {
2    ssTypeNumber = 1,
3        ssTypeTime = 2,
4}
5 

Description

• ssTypeNumber - display scores in the leader board
• ssTypeTime - display time in the leader board

PawnLibs/splashscreen/DrawSplashScreen

Summary

Add splash screen on a scene for rendering.

Synopsis

1stock DrawSplashScreen(screen, backgroundAngle = 0, localDeltaTime = 0)
2 

Description

Adds graphical primitives on the scene to render the splash screen. Should be used in between GFX_setRenderTarget() and GFX_render() calls. Technically it can be used for be used in baked image but it does not make sense because splash screen implements a twist animation.

Inputs

• screen - number of the screen to draw the splash screen
• backgroundAngle - at which angle background should be drawn on that screen, useful for complex non-symmetrical backgrounds
• localDeltaTime - time delta from previous call for the twist animation

See also

• GFX_setRenderTarget()
• GFX_render()

PawnLibs/splashscreen/InitSplashScreenBasics

Summary

Set how splash screen should be displayed.

Synopsis

1stock InitSplashScreenBasics(base = 0xFFFFFFFF, key = 0xFFFFFFFF,
2    e_ssLeaderBoardType:leaderBoardType = ssNoSaves,
3    e_ssLeadersDataType:dataType = ssTypeNumber)
4 

Inputs

• 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

PawnLibs/splashscreen/InitSplashScreenLeaders

Summary

Set leaders table to draw on a splash screen.

Synopsis

1stock InitSplashScreenLeaders(gameLeaders[SPLASH_SCREEN_MAX_LEADERS][LEADER_DATA])
2 

Inputs

• gameLeaders - leaders data

See also

• SPLASH_SCREEN_MAX_LEADERS
• LEADER_DATA

PawnLibs/splashscreen/InitSplashScreenResults

Summary

Set game results to draw on a splash screen.

Synopsis

1stock InitSplashScreenResults(gameResults[SPLASH_SCREEN_MAX_RESULTS][RESULT_DATA])
2 

Inputs

• gameResults - game results data

See also

• SPLASH_SCREEN_MAX_RESULTS
• RESULT_DATA

PawnLibs/splashscreen/InitSplashScreenSprites

Summary

Customize splash screen.

Synopsis

1stock InitSplashScreenSprites(backgroundSprite = -1,
2    mainImageSprite = -1,
3    gameNameSprite = -1,
4    QRcodeSprite = -1,
5    leaderboardIcon = -1,
6    resultsIcon = -1,
7    twistIcon_1 = -1,
8    twistIcon_2 = -1,
9    tapIcon = -1)
10 

Description

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

Inputs

• backgroundSprite - ID of a background image
• 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
• tapIcon - ID of the tap icon

PawnLibs/splashscreen/ssSetApplicationVersion

Summary

Set text for application version.

Synopsis

1ssSetApplicationVersion(appVersion[])
2 

Description

Receive application version in text format and concatenate with 'v' symbol. Version is written under QR code.

Inputs

• appVersion - application version in string format like "1.2.3"