Guides & Tutorials API Reference Examples & Demos
Documentation

Functional List of V-Play Components

The V-Play Gaming Components are available with the following import statement in your QML file:

import VPlay 2.0

This is a list of all the V-Play components grouped into functional groups.

V-Play Qt 5 Plugins

The V-Play Qt 5 Plugins add platform-specific features and 3rd party SDK integration available from QML.

The V-Play plugins are available as standalone Qt 5 plugins and also work independently from the core V-Play engine. As a V-Play customer, you receive valid license keys for the plugins. To retrieve a license key to use the plugins in your game(s), go to http://v-play.net/license/plugins.

AdMob The Qt 5 AdMob plugin enables you to monetize your game by embedding AdMob ads on Android and iOS.
ChartBoost The Chartboost plugin allows you to add interstitial ads from the Chartboost ad network to your game on Android and iOS.
In-App Purchase Soomla Store The Soomla Plugin fully supports in-app purchases for iOS App Store and Android in-app products on Google Play Store & Amazon AppStore. Monetize your game with in-app purchases and a virtual economy model with this plugin.
Facebook The Facebook plugin allows you to let your users connect with Facebook on Android and iOS.
Flurry Analytics The Flurry plugin gives you valuable insights on how often users open your app, how long they use it and how often they return (retention). It also gives you insights into your app's audience. This includes information about the mobile phone and OS version used or from which countries your users come from.
Local Push Notifications Schedule native local push notifications for iOS & Android in your app to increase user retention. This allows to bring back your users into your game after a certain time of inactivity, even if your app is in the background or already quit.

Note: For running the plugin examples or for testing the V-Play demos which use the plugins, no V-Play license is required. However, when you develop your own game and use your own app idendtifier, this requires a V-Play license. Also see the V-Play Plugins Installation Guide how to install the V-Play plugins.

V-Play Game Network Components

V-Play Game Network components for using leaderboards, achievements and challenges in your game.

Achievement

Reward your players with achievements for reaching certain goals in your game and to give them more incentive to keep playing your game.

VPlayGameNetwork

The root V-Play Game Network component for using leaderboards, achievements and challenges in your game.

WebStorage

The WebStorage item syncs key-value-data with the cloud across devices and platforms with the VPlayGameNetwork.

VPlayGameNetworkView

Default UI for VPlayGameNetwork leaderboards, achievements and player profile.

Level Editor Components

The Level Editor Components provide level creation directly in the game.

EditableComponent

The EditableComponent allows you to edit selected properties of a specific target with an ItemEditor.

ItemEditor

The ItemEditor allows to modify properties at runtime that were marked with the EditableComponent.

BuildEntityButton

A drag and drop button for placing game entities with the LevelEditor.

EntityBaseDraggable

The base class for game entities that should be used with the LevelEditor.

LevelBase

The base class for custom QML levels that are loaded in a game with LevelLoader.

LevelData

The data stored in a dynamically created level with LevelEditor available from LevelBase.

LevelEditor

Allows to create, share & monetize user-generated levels with an in-game level editor.

LevelLoader

Loads qml level files derived from LevelBase dynamically.

LevelSelectionList

Displays a list of available levels from the LevelEditor.

LevelStore

Allows to monetize user-generated levels with in-app purchases.

V-Play Core Components

These components every game will contain. Most important are GameWindow, Scene, EntityBase and EntityManager.

QMLItemName

The base class for custom game entities.

EntityBase

The base class for custom game entities.

EntityManager

Manages all entities derived from the EntityBase component.

GameWindow

The default root V-Play Window containing all other components and Scenes.

GameWindowApplicationWindow

The root V-Play ApplicationWindow containing all other components and Scenes.

GameWindowItem

The root V-Play element usable with existing Qt 5 applications.

Scene

The root element for a single game view.

Storage

The storage item provides a persistent and offline storage for arbitrary key-value pair data.

Utils

Provides often-needed functionality like generating a random number between 2 values.

WebStorage

The WebStorage item syncs key-value-data with the cloud across devices and platforms with the VPlayGameNetwork.

Context Components

The Context Components are global properties that are available in all QML files. They can be used to open native dialogs and browsers, network requests, dynamic QML component creation and provide system information.

Qt Context Objects

The Qt Context Objects page contains information about often-used functionality of the Qt element, for network requests and useful JavaScript elements.

NativeUtils

The nativeUtils context property allows opening native message boxes, input dialogs and browsers.

Visual Components

These components are used for efficient rendering in games and to handle mutliple screen sizes. Most important is MultiResolutionImage for handling different screen sizes and aspect ratios. And SpriteSequenceVPlay or AnimatedSpriteVPlay for animated sprites.

AnimatedSpriteVPlay

Plays a single sprite animation stored as a series of frames.

BackgroundImage

The BackgroundImage improves performance of background image rendering.

LineItem

The LineItem can be used to display coloured single and segmented lines.

MultiResolutionImage

The MultiResolutionImage changes the used image based on the display size to improve performance and memory usage.

ParallaxItem

The ParallaxItem allows to create parallax movement effects.

ParallaxScrollingBackground

The ParallaxScrollingBackground allows to create an endlessly scrollable background, usable by SideScroller games for example.

PolygonItem

The PolygonItem allows to display polygonal primitives with color.

SpriteSequenceVPlay

The SpriteSequence contains a list of Sprite elements and allows switching between them with only one active at a time.

SpriteVPlay

The Sprite element defines a series of sprite frames within an image for a SpriteSequenceVPlay.

In addition to the above list, also these Qt Quick Components are useful.

Image The Image element is used to display image files.
BorderImage Useful for resolution-independent buttons, similar to Android's 9-patch images.
Text The Text element allows displaying text on screen.
Rectangle The Rectangle item provides a filled rectangle.

Input Components

These components allow entity movement with a keyboard or a virtual controller for touchscreens.

JoystickControllerHUD

The JoystickControllerHUD element provides an input controller for a virtual joystick for moving entities, also called a virtual D-pad.

SimpleButton

The SimpleButton represents a basic rectangular button with a clicked handler that can be used during development.

TwoAxisController

Input controller with keyboard support for moving entities.

In addition to the above list, also these Qt Quick Components are useful.

MouseArea Allows mouse and touch input handling.
Flickable Provides a surface that can be swiped.
Keys Allows key handling, including the Android soft keys like Back.

Physics Components

These components add physics behavior to a game. They can either be used for collision detection, or for moving entities based on physics.

BoxCollider

The BoxCollider is a physics body with a rectangular shape.

CircleCollider

The CircleCollider is a physics body with a round shape.

PhysicsWorld

Simulates a physics world and contains all physics bodies.

PolygonCollider

The PolygonCollider is a physics body with a polygonal shape set up with at least 3 vertices.

The above components will be used most of the time. These components are for advanced use:

Body

A physics body which consists of one or more Fixture elements.

DistanceJoint

The DistanceJoint keeps the distance between 2 bodies constant.

Fixture

A physics shape either rectangular (Box), round (Circle) or polygonal (Polygon).

Box

A rectangular physics shape.

Circle

A circular physics shape.

Polygon

A polygonal physics shape.

Joint

The Joint is the base class of all joints.

MouseJoint

The MouseJoint is used to manipulate bodies with the mouse or touch input.

PrismaticJoint

The PrismaticJoint allows relative translation of two bodies along a specified axis and prevents rotation.

RevoluteJoint

The RevoluteJoint forces two bodies to share a common anchor point around which the bodies rotate.

RopeJoint

The RopeJoint restricts the maximum distance between two points.

WeldJoint

The WeldJoint glues two bodies together keeping a referenceAngle.

World

Represents a Box2D physics world including bodies and joints.

ColliderBase

The Base component for BoxCollider, CircleCollider and PolygonCollider. All physics colliders including BoxCollider, CircleCollider and PolygonCollider inherit from ColliderBase.

V-Play & Qt Multimedia Components

These components allow to play audio and video files.

BackgroundMusic

The BackgroundMusic element allows playing long-lasting and looping background sound in wav, mp3 or ogg file format.

SoundEffectVPlay

The SoundEffectVPlay element allows playing short-lasting and looping sound effects in wav file format.

Networking Components

These components handle network activities.

AI Components

The AI components move entities towards a target point, with a constant velocity or along a path.

PathMovement

Interpolates an entity along a path and rotates it towards the target points.

MoveToPointHelper

Provides information for a MovementAnimation or a ColliderBase about the direction and rotation when moving towards a target.

MovementAnimation

Modifies a property with a constant velocity and acceleration.

Particles Components

The Particles components provide particle effect rendering.

ParticleVPlay

The ParticleVPlay component allows visual effects like fire, explosions, smoke or rain.

Most useful QML Components

Item The Item is the most basic of all visual items in QML.
Animation The Animation element is the base of all QML animations lasting for a fixed time.
Timer The Timer item triggers a handler at a specified interval.
Loader The Loader item allows dynamically loading an Item-based subtree from a URL or Component.

Click here to see a full list of all QML components