VPlayGameNetworkView

Default UI for VPlayGameNetwork leaderboards, achievements and player profile. More...

Import Statement: import VPlay 2.0
Inherits:

Item

Properties

Signals

Methods

  • show(newState, initialState)

Detailed Description

This view contains all standalone views for leaderboards, achievements and profile settings. Thus using this component is the easiest way for adding social features in your game, because no customization of the views is required.

These are the default views in the VPlayGameNetworkView:

Default Views
LeaderboardView

AchievementView

ProfileView

Customize GameNetworkView UI to your game

You can also customize the views to match your game UI: either change the open-source code of VPlayGameNetworkView (browse the engine sources for the source code), or customize each of the views individually. The GameNetworkExample contains an example with source code how to do so.

Example Usage

The following example shows how to use the VPlayGameNetworkView in a game:

 import VPlay 2.0
 import QtQuick 2.0

 GameWindow {
   // add other components like the EntityManager here

   VPlayGameNetwork {
     id: gameNetwork
     // created in the V-Play Web Dashboard
     gameId: 5
     secret: "abcdefg1234567890"
     gameNetworkView: myGameNetworkView
   }

   Scene {
     id: scene
     // add your game functionality here

     SimpleButton {
       text: "Show Leaderboards"
       onClicked: {
         // open the leaderboard view of the VPlayGameNetworkView
         gameNetwork.showLeaderboard()
       }
     }

     VPlayGameNetworkView {
       id: myGameNetworkView
       anchors.fill: scene.gameWindowAnchorItem

       gameNetworkItem: gameNetwork

       onShowCalled: {
         myGameNetworkView.visible = true
       }

       onBackClicked: {
         myGameNetworkView.visible = false
       }
     }// VPlayGameNetworkView

   }// Scene
 }// GameWindow

In the example above the VPlayGameNetworkView gets changed its visible property in onShowCalled and onBackClicked. You can also put the VPlayGameNetworkView into an own Scene for more advanced effects and to prevent loading the VPlayGameNetworkView when the app starts. See the ChickenOutbreak Demo how this is done in this live app store game. You can also download it from the app stores and watch the VPlayGameNetworkView in a real app from here: http://v-play.net/showcases/#chicken_outbreak

Property Documentation

bodyColor : color

Set this property to match the overall style with your game's color scheme. The default color is #484848.


bodyFontSource : alias

Set this property to a custom font to match your game style. The default font is Lato-Light.ttf.


bodyLightColor : color

Set this property to match the overall style with your game's color scheme. The default color is #9a9a9a.


countryCodeEnabled : bool

Set this property to enable displaying the country in the leaderboard and a country selector in the ProfileView.

This QML property was introduced in V-Play 2.8.5.


gameNetworkItem : variant

Set this property to the id of V-Play Game Network.

By default, it will be set to the id gameNetwork if one is found in the project, or it is undefined if no such id is found.

This is an example how to use it:

 // ...

 VPlayGameNetwork {
   id: myGameNetwork

   gameNetworkView: myGameNetworkView

   // other gameNetwork code here

 }

 VPlayGameNetworkView {
   id: myGameNetworkView

   gameNetworkItem: myGameNetwork
 }

 // ...

headerFontSource : alias

Set this property to a custom font to match your game style. The default font is Dosis-Regular.ttf.


higlightFriendPlayersWithColorEnabled : bool

Set this property to enable a different color for friends in the global leaderboard view. In the friend-only leaderboard view, no coloring is used as all the other players are your friends anyway. By default, this property is set to true. You can customize highlight color with tintFriendPlayerHighlightColor.

This QML property was introduced in V-Play 2.8.5.


iconFontName : string

Set this property to specify a custom icon font name. You can also use your own FontLoader object by setting iconFontSource to "" and then specifying the font name instead.


iconFontSource : string

Set this property to a custom font to match your game style. The default font is fa.ttf.


initialStateBeforeShow : string

Set this property to the state your game was in before calling show(). The initialStateBeforeShow can either be provided as second argument of show(), or set it explicitly in your logic.

You can then reset your game to the initial state when you handle onBackClicked. For example, go back to the main menu if the game state before show() was the main menu.

See also show().


separatorColor : color

Set this property to match the overall style with your game's color scheme. The default color is #f4f4f4.


showAchievementsHeaderIcon : alias

Set this property to false if you do not have Achievements in your game and want to hide the achievements icon in the VPlayGameNetworkView header. By default it is true.


showLeaderboardsHeaderIcon : alias

Set this property to false if you do not have Leaderboards in your game and want to hide the leaderboard icon in the VPlayGameNetworkView header. By default it is true.


tintColor : color

Set this property to match the overall style with your game's main tint color. The default color is #f05352 which is a red color.


tintFriendPlayerHighlightColor : color

Set this property to match the overall style with your game's light tint color. The default color is Qt.lighter(tintLightColor, 1.3), which is a lighter color than the tintLightColor.

This QML property was introduced in V-Play 2.8.5.

See also higlightFriendPlayersWithColorEnabled.


tintLightColor : color

Set this property to match the overall style with your game's main tint color. The default color is Qt.lighter(tintColor, 1.5), which is a lighter color than the tintColor.


Signal Documentation

backClicked()

This handler is called after the back button was clicked. You should either make the VPlayGameNetworkView invisible in that case, or switch to another game state, preferably the initialStateBeforeShow.

See also showCalled.


showCalled()


Method Documentation

show(newState, initialState)

Updates the initialStateBeforeShow to initialState if this parameter is provided. If newState is set, the internal state property changes to one of the possible newState values: "leaderboard", "achievement" or "profile".

Afterwards onShowCalled is called.

Note: The VPlayGameNetworkView does not get its visible property set to true in this function. This must be handled explicitly for example in onShowCalled.


Videos

Voted #1 for:

  • Easiest to learn
  • Most time saving
  • Best support

Develop Cross-Platform Apps and Games 50% Faster!

  • Voted the best supported, most time-saving and easiest to learn cross-platform development tool
  • Based on the Qt framework, with native performance and appearance on all platforms including iOS and Android
  • Offers a variety of plugins to monetize, analyze and engage users
FREE!
create apps
create games
cross platform
native performance
3rd party services
game network
multiplayer
level editor
easiest to learn
biggest time saving
best support