BuildEntityButton

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

Import Statement: import VPlay 2.0
Inherits:

Item

Properties

Signals

Detailed Description

The BuildEntityButton allows to set an entity type that should be draggable into the game with the LevelEditor. This component works together with the EntityBaseDraggable, the base class for entities that should be create-able from the LevelEditor. The BuildEntityButton takes care of the creation of the entity at the dragged position, if it does not collide with other entities.

The collision check is possible, because an instance of the entity defined with toCreateEntityType is added. It is marked as invisible, until the button gets pressed. Thus it is important to set a button size, so the internal MouseArea knows when the entity dragging should start. It then activates the colliders and reports whether the dragged position is available based on the collider information.

Defining the BuildEntityButton Appearance

Every game has different requirements to display the entity that should be draggable into the level. Thus you can add any QML element you want your button to look like, as child of the BuildEntityButton. In most cases, displaying an Image will be sufficient, but you could also add an animation of the entity with a SpriteSequence for example.

Example Usage

This example shows how to define a button for creating the entity type Obstacle.qml. Its base class is EntityBaseDraggable, and performs collision checks if the entity is dragged to a free space in the level automatically. The visual appearance of the button is added with the Image element. However, you could use any element, for example a SpriteSequence. The visual representation is decoupled from the actual entity that is built, which makes it more flexible.

 import QtQuick 2.0
 import VPlay 2.0

 BuildEntityButton {

   width: 50
   height: 50

   // an instance of this entity is created when the entity is dragged to a free spot in the level
   toCreateEntityType: "entities/Obstacle.qml"

   // this is decoupled from the entity, can be set to any QML element that should be displayed
   Image {

     // make it the size of the parent
     anchors.fill: parent
     source: "obstacle-creationbutton.png"
   }
 }

Advanced Usage

You can add all your game entities that should be draggable into a level as buttons. In the following example, the base component MyGameBuildEntityButton.qml adds an Image element for the visual appearance of the dragging item. From the HUD.qml file, this component is then added multiple times and placed in a row for all the entities that should be draggable into the level:

MyGameBuildEntityButton.qml:

 BuildEntityButton {

   width: 50
   height: 50

   // an instance of this entity is created when the entity is dragged to a free spot in the level
   toCreateEntityType: "entities/Obstacle.qml"

   Image {
     anchors.fill: parent
     // there are multiple images, based on the variationType
     // e.g. obstacle-chocolate.png, obstacle-teddy.png, etc.
     source: "obstacle-" + variationType + ".png"
   }
 }

HUD.qml:

 Row {
   // place the buttons next to each other in a Row

   MyGameBuildEntityButton {
     variationType: "teddy"
   }

   MyGameBuildEntityButton {
     variationType: "chocolate"
   }

   MyGameBuildEntityButton {
     variationType: "pillow"
   }

   // ... add soccerball, toys and book here as well
 }

The above example will then look like the following image:

In this image, the pillow was dragged into the level, and a collision with the path was detected. Thus the collider turned red. This behavior is also customizable, in the EntityBaseDraggable.

Note: The BuildEntityButton can also be used as part of the game design - for example a tower defense game, has the ability to drag entities (the towers) into the scene. This image is a screenshot from the Squaby Demo, where this approach is used:

Also see the OneMoreLevel Demo for an example of the LevelEditor.

Property Documentation

createdEntity : variant

This property holds the entity instance that got created internally based on the toCreateEntityType. You can use it to modify any properties or call functions on it.


creationProperties : variant

You can set this property to change the initial properties of the entity that should be created. This might be useful, when the entity should look or behave differently when it gets created for dragging into the level. By default, the properties are empty.

For example, you could change the image when dragging from the level with the following code:

 BuildEntityButton {
   creationProperties: { "levelDraggingMode" : true }
   toCreateEntityType: "Fish.qml"
 }

Fish.qml:

 EntityBaseDraggable {
   // if normally created, this is false
   // if it is created for dragging into the level, it gets set to true from BuildEntityButton
   property bool levelDraggingMode: false

   Image {
     // either use the normal fish image, or another one when it is dragged for level creation
     source: levelDraggingMode ? "fish-levelmode.png" : "fish.png"
   }
 }

entityManagerItem : variant

Set this property to the entityManager in your game. This is a required property to store and load entities with a level.

By default, it will be set to the id entityManager if one is found in the main qml file, or it is null if no such id is found.

This QML property was introduced in V-Play 2.3.0.


initialEntityPosition : point

With this property you can manually set the initial position of the createdEntity. By default this is the location of this BuildEntityButton.

This QML property was introduced in V-Play 2.6.2.


toCreateEntityTypeString : string

The entityType string of the entity that should be created when it is released on an available spot in the level. This or toCreateEntityType is a required property for this component to work.

If you use this property to define the entityType that should be created, make sure the entity was created once so its type is known. You can set it as EntityManager::dynamicCreationEntityList to create and then remove the entity again after application start.

See also toCreateEntityTypeUrl and EntityManager::dynamicCreationEntityList.


toCreateEntityTypeUrl : url

The url of the entity that should be created when it is released on an available spot in the level. This or toCreateEntityTypeString is a required property for this component to work.

See also toCreateEntityTypeString.


variationType : string

This property lets you define the variationType of the entity that should be created. The variationType is optional.

See also EntityBase::variationType.


Signal Documentation

clicked()

This handler is called when the BuildEntityButton is clicked


entityPressed()

This handler is called when the entity got pressed. That happens when dragging is started.


entityReleased()

This handler is called when the entity got released. That happens when dragging is stopped.


entityWasBuilt(string builtEntityId)

This handler is called when the entity got released and successfully created. In case the entity could not be created, because it collided with another entity, this handler is not called.

You can use this function for example for playing a construction sound when the entity was built.

In V-Play version 1.3.8 and above, this signal also contains a parameter builtEntityId with the entityId of the created entity. Example usage:

 BuildEntityButton {
   //...
   onEntityWasBuilt: {
     console.log("created entityId: "+builtEntityId)
     // get the entity with the given entityId from the entityManagerItem
     var newEntity = entityManagerItem.getEntityById(builtEntityId)
   }
 }

pressed()

This handler is called when the BuildEntityButton is clicked


released()

This handler is called when the BuildEntityButton is clicked


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
Sign up for Free and start developing right away!
I want to make Games
I want to make Apps
Game Development
Cross-Platform, Any Resolution

Use one IDE to deploy to all supported platforms, including iOS and Android, from a single code base.

Support all screen resolutions, aspect ratios and sizes with auto-adapting UI elements, smart scene scaling and memory efficient asset selection.

Learn More

V-Play ranked #1 at research2guidance cross-platform tool benchmarking 2014 by 2188 developers comparing 40 leading tools.

Multiplayer

V-Play Multiplayer supports both real-time and turn-based gameplay, so you can use it to make many different types of cross-platform multiplayer games. It's perfect for making player-vs-player games like 'Words with Friends' or games for a large amount of players, such as 'Clash of Clans'.

Learn More Video

Highscores & Achievements

The V-Play Game Network is a cross-platform gaming service that allows players around the world to compare game highscores and achievements. Players can also challenge each other across multiple platforms and share their progress on Facebook.

Learn More

QML & JavaScript

Qt Meta Language is a highly intuitive reactive language, which is super easy to learn, yet it's extremely powerful and flexible. Mix it with JavaScript to create awesome stuff, with just a few lines of code.

import QtQuick 2.0
import VPlay 2.0

GameWindow {
  Scene {
    
    SimpleButton {
      anchors.centerIn: parent
      text: "Press Me"
      onClicked: {
        console.debug("Wow you pressed me!")
      }
    }
  }
}

Learn More

Monetize & Analyze

With V-Play, you can use many 3rd party services for ads, in-app purchases, analytics and more, with just a few lines of code. All of these plugins work cross-platform, which allows you to maintain a single code base.

Learn More

Level Editor

The LevelEditor can be used during development to create and modify levels for your game, which you can then bundle in your final publishing build. Additionally, you can also integrate the in-game level editor to your published game and let your gamers create new levels.

Learn More Video

Card Game like UNO, Hearthstone or Poker

We got a demo game for you!

The V-Play SDK includes an open-source demo for this game genre. You can use its source code and build your game in record time. After installing V-Play, you can simply open the .pro file with Qt Creator, the development environment used for V-Play.

<Path to V-PlaySDK>/Examples/V-Play/demos/OneCard/OneCard.pro

Match-3 like Candy Crush Saga

We got a demo game for you!

The V-Play SDK includes an open-source demo for this game genre. You can use its source code and build your game in record time. After installing V-Play, you can simply open the .pro file with Qt Creator, the development environment used for V-Play.

<Path to V-PlaySDK>/Examples/V-Play/demos/JuicySquash/JuicySquash.pro

<Path to V-PlaySDK>/Examples/V-Play/demos/JuicySquashAdvanced/JuicySquashAdvanced.pro

Puzzle like 2048 or Threes!

We got a demo game for you!

The V-Play SDK includes an open-source demo for this game genre. You can use its source code and build your game in record time. After installing V-Play, you can simply open the .pro file with Qt Creator, the development environment used for V-Play.

<Path to V-PlaySDK>/Examples/V-Play/demos/2048/2048.pro

Casino like Big Win Slots

We got a demo game for you!

The V-Play SDK includes an open-source demo for this game genre. You can use its source code and build your game in record time. After installing V-Play, you can simply open the .pro file with Qt Creator, the development environment used for V-Play.

<Path to V-PlaySDK>/Examples/V-Play/demos/FlaskOfRum/FlaskOfRum.pro

Side Scroller like Jetpack Joyride or Flappy Bird

We got a demo game for you!

The V-Play SDK includes an open-source demo for this game genre. You can use its source code and build your game in record time. After installing V-Play, you can simply open the .pro file with Qt Creator, the development environment used for V-Play.

<Path to V-PlaySDK>/Examples/V-Play/demos/FlappyBird/FlappyBird.pro

Tower Defense like Castle Defense or Bloons TD

We got a demo game for you!

The V-Play SDK includes an open-source demo for this game genre. You can use its source code and build your game in record time. After installing V-Play, you can simply open the .pro file with Qt Creator, the development environment used for V-Play.

<Path to V-PlaySDK>/Examples/V-Play/demos/Squaby/Squaby.pro

Falldown & Jump like Doodle Jump or Mega Jump

We got a demo game for you!

The V-Play SDK includes an open-source demo for this game genre. You can use its source code and build your game in record time. After installing V-Play, you can simply open the .pro file with Qt Creator, the development environment used for V-Play.

<Path to V-PlaySDK>/Examples/V-Play/demos/ChickenOutbreak/ChickenOutbreak.pro

<Path to V-PlaySDK>/Examples/V-Play/demos/ChickenOutbreak2/ChickenOutbreak2.pro

<Path to V-PlaySDK>/Examples/V-Play/demos/DoodleJump/DoodleJump.pro

Platformer like Super Mario or Lep's World

We got a demo game for you!

The V-Play SDK includes an open-source demo for this game genre. You can use its source code and build your game in record time. After installing V-Play, you can simply open the .pro file with Qt Creator, the development environment used for V-Play.

<Path to V-PlaySDK>/Examples/V-Play/demos/Platformer/Platformer.pro

<Path to V-PlaySDK>/Examples/V-Play/demos/PlatformerWithLevelEditor/PlatformerWithLevelEditor.pro

Action like Angry Birds, Fruit Ninja, Cut the Rope

We got a demo game for you!

The V-Play SDK includes an open-source demo for this game genre. You can use its source code and build your game in record time. After installing V-Play, you can simply open the .pro file with Qt Creator, the development environment used for V-Play.

<Path to V-PlaySDK>/Examples/V-Play/demos/StackTheBoxWithCommunityEditor/StackTheBoxWithCommunityEditor.pro

<Path to V-PlaySDK>/Examples/V-Play/demos/BalloonPop/BalloonPop.pro

<Path to V-PlaySDK>/Examples/V-Play/demos/CarChallenge/CarChallenge.pro

Arcade like Arkanoid or Space Invaders

We got a demo game for you!

The V-Play SDK includes an open-source demo for this game genre. You can use its source code and build your game in record time. After installing V-Play, you can simply open the .pro file with Qt Creator, the development environment used for V-Play.

<Path to V-PlaySDK>/Examples/V-Play/demos/ZombieBreak/ZombieBreak.pro

Community like Super Mario Maker or Minecraft

We got a demo game for you!

The V-Play SDK includes an open-source demo for this game genre. You can use its source code and build your game in record time. After installing V-Play, you can simply open the .pro file with Qt Creator, the development environment used for V-Play.

<Path to V-PlaySDK>/examples/Squaby/Squaby.pro

<Path to V-PlaySDK>/Examples/V-Play/demos/StackTheBoxWithCommunityEditor/StackTheBoxWithCommunityEditor.pro

<Path to V-PlaySDK>/Examples/V-Play/demos/PlatformerWithLevelEditor/PlatformerWithLevelEditor.pro

Any other Idea? let us know how we can help you

You are looking for another demo?

The V-Play SDK includes many open-source demos for different game genres. You can use their source code and build your game in record time. After installing V-Play, you can simply open the .pro file with Qt Creator, the development environment used for V-Play.

If you do not find your game genre in this list and wonder if V-Play is the right choice, just contact us, we are happy to help!

Contact Us

App Development
Better Apps, Less Effort

Develop feature-rich, cross-platform mobile apps from a single code base.

V-Play apps look, feel and perform exactly like native iOS, Android and Desktop apps. With less code & much faster development time.

Learn More Highlights Video

V-Play ranked #1 at research2guidance cross-platform tool benchmarking 2014 by 2188 developers comparing 40 leading tools.

Save Time, Code & Money

Save up to 90% source code with V-Play, compared to frameworks like Xamarin, Titanium, React Native and others.

Learn More

QML & JavaScript

Qt Meta Language is a highly intuitive reactive language, which is super easy to learn, yet it's extremely powerful and flexible. Mix it with JavaScript to create awesome stuff, with just a few lines of code. QML also allows you to easily create smooth and complex animations.

import QtQuick 2.0
import VPlayApps 2.0

App {
  Page {
    
    AppButton {
      anchors.centerIn: parent
      text: "Press Me"
      onClicked: {
        console.debug("Wow you pressed me!")
      }
    }
  }
}

Learn More

Monetize & Analyze

With V-Play, you can use many 3rd party services for ads, in-app purchases, analytics and more, with just a few lines of code. All of these plugins work cross-platform, which allows you to maintain a single code base.

Learn More

Native Sensors & More

V-Play Apps harness the power of Qt, the leading cross-platform development framework used by over 1,000,000 developers.

This gives your access to native device features like sensors, camera, file system as well as multimedia, networking, localization and much more.

Learn More

Responsive Design

V-Play has built in responsive design capabilities, you can target phones and tablets with the same source code.

Learn More

Highly Extensible

You have existing JavaScript, C++ or native code? You want to add any 3rd party SDK that we do not offer already?

No worries, you can add any JS, C++, Java or Objective-C code to your project.

Learn More

Component Showcase App shows the most important V-Play features and components

We got a demo app for you!

The V-Play SDK includes an open-source demo for this app type. You can use its source code and build your app in record time. After installing V-Play, you can simply open the .pro file with Qt Creator, the development environment used for V-Play.

<Path to V-PlaySDK>/Examples/V-Play/appdemos/showcase/Showcase.pro

Qt World Summit Conference App a full-featured conference management app made by V-Play

We got a demo app for you!

The V-Play SDK includes an open-source demo for this app type. You can use its source code and build your app in record time. After installing V-Play, you can simply open the .pro file with Qt Creator, the development environment used for V-Play.

<Path to V-PlaySDK>/Examples/V-Play/appdemos/qtws2016/QtWS2016.pro

Twitter App how to build layouts like in the official Twitter app for iOS and Android

We got a demo app for you!

The V-Play SDK includes an open-source demo for this app type. You can use its source code and build your app in record time. After installing V-Play, you can simply open the .pro file with Qt Creator, the development environment used for V-Play.

<Path to V-PlaySDK>/Examples/V-Play/appdemos/twitter/Twitter.pro

Maps App displays free bikes or boxes at bike stations for Vienna's bike sharing service Citybike Wien

We got a demo app for you!

The V-Play SDK includes an open-source demo for this app type. You can use its source code and build your app in record time. After installing V-Play, you can simply open the .pro file with Qt Creator, the development environment used for V-Play.

<Path to V-PlaySDK>/Examples/V-Play/appdemos/maps/Maps.pro

Messaging App demonstrates how to create the UI of a Facebook Messenger like app

We got a demo app for you!

The V-Play SDK includes an open-source demo for this app type. You can use its source code and build your app in record time. After installing V-Play, you can simply open the .pro file with Qt Creator, the development environment used for V-Play.

<Path to V-PlaySDK>/Examples/V-Play/appdemos/messaging/Messaging.pro

Weather App how to include powerful animations into your user interface

We got a demo app for you!

The V-Play SDK includes an open-source demo for this app type. You can use its source code and build your app in record time. After installing V-Play, you can simply open the .pro file with Qt Creator, the development environment used for V-Play.

<Path to V-PlaySDK>/Examples/V-Play/appdemos/waether/Weather.pro

Any other Idea? let us know how we can help you

You are looking for another app demo?

The V-Play SDK includes many open-source demos for different app types. You can use their source code and build your app in record time. After installing V-Play, you can simply open the .pro file with Qt Creator, the development environment used for V-Play..

If you do not find your app type in this list and wonder if V-Play is the right choice, just contact us, we are happy to help!

Contact Us