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.

Note: You can quickly test and explore most of the components in the Examples Section of the V-Play Sample Launcher.

V-Play Plugins

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

AdMob Plugin The Qt 5 AdMob plugin enables you to monetize your game by embedding AdMob ads on Android and iOS.
Chartboost Plugin The Chartboost plugin allows you to add interstitial ads from the Chartboost ad network to your game on Android and iOS. You can also reward your users with virtual currency or in-game items for watching video overlays advertising other games.
In-App Purchase Soomla Store Plugin 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 Plugin The Facebook plugin allows you to let your users connect with Facebook on Android and iOS.
Google Analytics Plugin The Google Analytics plugin gives you valuable insights on how often mobile and Desktop 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 plugin is available for all supported platforms by V-Play, both mobile and Desktop.
Flurry Analytics Plugin 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. This plugin is available for Android and iOS.
Infinario Analytics Plugin The Infinario plugin provides game analytics for game designers to improve your game. This plugin is available for all supported platforms by V-Play, both mobile and Desktop.
Local Push Notification Plugin 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.
Parse Push Notification Plugin Schedule remote push notifications for iOS & Android from a web server 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.
HockeyApp Beta Distribution & Crash Report Plugin With HockeyApp you can upload new versions of your iOS & Android builds and automatically notify your testers about new the new version when they open your app the next time. HockeyApp also collects and uploads crash reports from you apps or games for you, so you know where your app needs improvement.

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.

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

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

VPlayGameNetworkView

Default UI for VPlayGameNetwork leaderboards, achievements and player profile

Level Editor Components

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

BuildEntityButton

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

EditableComponent

Allows you to edit selected properties of a specific target with an ItemEditor

EntityBaseDraggable

Base class for game entities that should be used with the LevelEditor

ItemEditor

Allows to modify properties at runtime that were marked with the EditableComponent

LevelBase

Base class for custom QML levels that are loaded in a game with LevelLoader

LevelData

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.

EntityBase

Base class for custom game entities

EntityManager

Manages all entities derived from the EntityBase component

GameWindow

Default root V-Play Window containing all other components and Scenes

GameWindowApplicationWindow

Root V-Play ApplicationWindow containing all other components and Scenes

GameWindowItem

Root V-Play element usable with existing Qt 5 applications

QMLItemName

Base class for custom game entities

Scene

Root element for a single game view

Storage

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

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.

NativeUtils

NativeUtils context property allows opening native message boxes, input dialogs and browsers

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.

Visual Components

These components are used for efficient rendering in games and to handle multiple screen sizes. Most important is MultiResolutionImage for handling different screen sizes and aspect ratios. And SpriteSequenceVPlay or AnimatedSpriteVPlay for animated sprites. For advanced and performance-improved animations, see TexturePackerAnimatedSpriteVPlay and SpineSkeleton.

AnimatedSpriteVPlay

Plays a single sprite animation stored as a series of frames

BackgroundImage

Improves performance of background image rendering

CameraVPlay

Enables to follow an object, or be moved around freely

LineItem

Can be used to display colored single and segmented lines

MultiResolutionImage

Changes the used image based on the display size to improve performance and memory usage

ParallaxItem

Allows to create parallax movement effects

ParallaxScrollingBackground

Allows to create an endlessly scrollable background, usable by SideScroller games for example

PolygonItem

Allows to display polygonal primitives with color

SpineSkeleton

The base type for all bone-based animations created with the Spine framework

SpriteSequenceVPlay

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

SpriteVPlay

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

TexturePackerAnimatedSpriteVPlay

Component shows a single static sprite or an animated sprite like the AnimatedSpriteVPlay. It has an increased performance thanks to its support for sprite sheets created with TexturePacker

TexturePackerSpriteSequenceVPlay

Contains a list of TexturePackerSpriteVPlay elements and allows switching between them with only one active at a time. It has an increased performance thanks to its support for sprite sheets created with TexturePacker

TexturePackerSpriteVPlay

Element defines a series of sprite frames within an image for a TexturePackerSpriteSequenceVPlay. It has an increased performance thanks to its support for sprite sheets created with TexturePacker

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.

Visual 3D Components

These components are used for 3D rendering.

Render3D

A 3D model with a texture and material to be rendered in a Scene3DVPlay

Scene3DVPlay

Root element for rendering 3D objects within a 2D GameWindow

TargetCamTransformHelper

Provides the position when rotating towards a direction usable for follow or target cameras

Input Components

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

JoystickControllerHUD

Element provides an input controller for a virtual joystick for moving entities, also called a virtual D-pad

SimpleButton

Represents a basic rectangular button with a clicked handler that can be used during development

StyledButton

Has a gradient, radius and border and an optional flatStyle, ready to be published in games & apps

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.
MultiPointTouchArea Allows multi-touch input handling.
Flickable Provides a surface that can be swiped.
Keys Allows key handling, including the Android soft keys like Back.
TextInput Displays a single editable line of text.
TextEdit Displays multiple lines of editable formatted text.

The Qt Quick Controls contain more input elements like native-looking Buttons, CheckBoxes and view components like TableView or StackView. See the Qt Quick Controls QML Types for more details.

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. The physics engine used by V-Play is Box2D.

Basic Physics Components

BoxCollider

Physics body with a rectangular shape

CircleCollider

Physics body with a round shape

PhysicsWorld

Simulates a physics world and contains all physics bodies

PolygonCollider

Physics body with a polygonal shape set up with at least 3 vertices

Fixture Components

To create custom physics objects which use more than the default behavior of BoxCollider, CircleCollider or PolygonCollider, combinations of these Fixture types can be used inside a ColliderBase object:

Box

A rectangular physics shape

Chain

An empty chain of points, or empty polygon (loop)

Circle

A circular physics shape

Edge

A flat edge between two points

Fixture

Abstract base class of all fixture types

Polygon

A filled convex polygonal physics shape

Joint Components

To link multiple physics objects together, the following types of joints can be used:

DistanceJoint

Keeps the distance between 2 bodies constant

FrictionJoint

Top-down friction between 2 bodies

GearJoint

Connects 2 Joint objects together

Joint

Abstract base class of all joints types

MotorJoint

Keeps the relative translation and rotation between 2 bodies constant

MouseJoint

Used to manipulate bodies with the mouse or touch input

PrismaticJoint

Allows relative translation of two bodies along a specified axis and prevents rotation

PulleyJoint

Keeps the total distance between a body, 2 points and another body constant

RevoluteJoint

Forces two bodies to share a common anchor point around which the bodies rotate

RopeJoint

Restricts the maximum distance between two points

WeldJoint

Glues two bodies together keeping a constant relative angle

WheelJoint

Allows relative rotation and translation of two bodies along a specified axis

Advanced Physics Components

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

Box2D

Contains static properties of the Box2D physics engine

ColliderBase

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

Contact

Information about a physics contact event

DebugDraw

Draws a debug view of the physics components

Profile

A property group for getting profiling data about the current state and performance of the physics simulation

RayCast

A RayCast object that reports when a ray hits a Fixture

World

Represents a Box2D physics world including bodies and joints

V-Play & Qt Multimedia Components

These components allow to play audio and video files.

AlphaVideo

Component allows you to show videos with transparency

BackgroundMusic

Element allows playing long-lasting and looping background sound in wav, mp3 or ogg file format

SoundEffectVPlay

Element allows playing short-lasting and looping sound effects in wav file format

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

Audio Add audio playback to a scene
SoundEffect Provides a way to play sound effects in QML
MediaPlayer Add media playback to a scene
Video A convenience type for showing a specified video
VideoOutput Render video or camera viewfinder
Camera Access viewfinder frames, and take photos and movies
Radio Access radio functionality from a QML application
Torch Simple control over torch functionality
QtMultimedia Provides a global object with useful functions from Qt Multimedia

Networking Components

These components handle network activities.

XMLHttpRequest Element

The XMLHttpRequest object can be used to asynchronously obtain data from over a network.

AI Components

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

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

PathMovement

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

RUBE Components

The RUBE components allow loading of levels and Box2D objects created with RUBE, which stands for Really Useful Box2D Editor. You can use RUBE to create side scrollers like Badland or Jetpack Joyride, platformers like Super Mario, and other physics-based games.

RubeBody

Represents a Box2D body as defined in the JSON file from the RUBE level editor

RubeFixtureCircle

Represents a Box2D Circle fixture as defined in the JSON file from the RUBE level editor

RubeFixturePolygon

Represents a Box2D Polygon fixture as defined in the JSON file from the RUBE level editor

RubeImage

Represents an image as defined in the JSON file from the RUBE level editor

RubeParser

Creates QML items based on the description of a JSON file exported by the RUBE level editor

Slot Machine Components

The slot machine components allow to create slot games with V-Play.

SlotMachine

Component allows to easily implement a slot machine with multiple reels and rows. It also provides methods to spin or stop the slot machine and lets you access the visible items in each reel and row

SlotMachineModel

Allows to easily generate reels with randomly shuffled items for a SlotMachine

SlotMachineReel

Element describes a reel to be displayed within the SlotMachine component

Particles Components

The Particles components provide particle effect rendering.

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