mirror of
https://github.com/4ian/GDevelop.git
synced 2025-10-15 10:19:04 +00:00
71e3b65134
* This object displays a field where the player can type a text. * The cursor can be moved and the text can be selected and entered like any other input field according to the platform. For example, you can use all the usual keyboard shortcuts or emoji pickers on desktop. On mobile, all the usual gestures are supported, emoji pickers, text selection, clipboard... * You can choose between different input field types: text, text area, email, password, phone number... This allows the keyboards to be adapted on mobile devices. The password field will also hide what is entered by the user. * Because the object is way more convenient to use (and actually works on mobile devices) than the Text Entry object, it is recommended you use it almost always instead of the Text Entry object. * This object has 2 limitations, because it's using the native capabilities of the platform to display a "native" input field: the Z order can't be changed (the object is *always* displayed on top of the game) and no effects can be displayed. Because it's handled by the operating system, it may also slightly differ on each platform. * It's recommended you avoid displaying the object outside of a menu or a static UI, as it may not always display exactly at a position synchronised with the rest of the rendering of the game, especially if used in a fast paced or moving scene.
389 lines
15 KiB
C++
389 lines
15 KiB
C++
/*
|
|
* GDevelop Core
|
|
* Copyright 2008-2016 Florian Rival (Florian.Rival@gmail.com). All rights
|
|
* reserved. This project is released under the MIT License.
|
|
*/
|
|
#include "ObjectMetadata.h"
|
|
|
|
#include <algorithm>
|
|
#include <iostream>
|
|
|
|
#include "GDCore/Extensions/Metadata/ExpressionMetadata.h"
|
|
#include "GDCore/Extensions/Metadata/InstructionMetadata.h"
|
|
#include "GDCore/Extensions/Metadata/MultipleInstructionMetadata.h"
|
|
#include "GDCore/Extensions/PlatformExtension.h"
|
|
#include "GDCore/Project/Object.h"
|
|
#include "GDCore/Tools/Localization.h"
|
|
|
|
namespace gd {
|
|
|
|
ObjectMetadata::ObjectMetadata(const gd::String& extensionNamespace_,
|
|
const gd::String& name_,
|
|
const gd::String& fullname_,
|
|
const gd::String& description_,
|
|
const gd::String& icon24x24,
|
|
std::shared_ptr<gd::Object> blueprintObject_)
|
|
: extensionNamespace(extensionNamespace_),
|
|
blueprintObject(blueprintObject_) {
|
|
name = name_;
|
|
#if defined(GD_IDE_ONLY)
|
|
SetFullName(gd::String(fullname_));
|
|
SetDescription(gd::String(description_));
|
|
iconFilename = icon24x24;
|
|
#endif
|
|
createFunPtr =
|
|
[blueprintObject_](gd::String name) -> std::unique_ptr<gd::Object> {
|
|
if (blueprintObject_ == std::shared_ptr<gd::Object>()) {
|
|
std::cout
|
|
<< "Error: Unable to create object. Have you declared an extension "
|
|
"(or ObjectMetadata) without specifying an object as blueprint?"
|
|
<< std::endl;
|
|
return nullptr;
|
|
}
|
|
|
|
std::unique_ptr<gd::Object> newObject = blueprintObject_->Clone();
|
|
newObject->SetName(name);
|
|
return newObject;
|
|
};
|
|
}
|
|
|
|
ObjectMetadata::ObjectMetadata(const gd::String& extensionNamespace_,
|
|
const gd::String& name_,
|
|
const gd::String& fullname_,
|
|
const gd::String& description_,
|
|
const gd::String& icon24x24,
|
|
CreateFunPtr createFunPtrP)
|
|
: extensionNamespace(extensionNamespace_) {
|
|
name = name_;
|
|
#if defined(GD_IDE_ONLY)
|
|
SetFullName(gd::String(fullname_));
|
|
SetDescription(gd::String(description_));
|
|
iconFilename = icon24x24;
|
|
#endif
|
|
createFunPtr = createFunPtrP;
|
|
}
|
|
|
|
gd::InstructionMetadata& ObjectMetadata::AddCondition(
|
|
const gd::String& name,
|
|
const gd::String& fullname,
|
|
const gd::String& description,
|
|
const gd::String& sentence,
|
|
const gd::String& group,
|
|
const gd::String& icon,
|
|
const gd::String& smallicon) {
|
|
#if defined(GD_IDE_ONLY)
|
|
gd::String nameWithNamespace =
|
|
extensionNamespace.empty() ? name : extensionNamespace + name;
|
|
conditionsInfos[nameWithNamespace] = InstructionMetadata(extensionNamespace,
|
|
nameWithNamespace,
|
|
fullname,
|
|
description,
|
|
sentence,
|
|
group,
|
|
icon,
|
|
smallicon)
|
|
.SetHelpPath(GetHelpPath())
|
|
.SetIsObjectInstruction();
|
|
return conditionsInfos[nameWithNamespace];
|
|
#endif
|
|
}
|
|
|
|
gd::InstructionMetadata& ObjectMetadata::AddAction(
|
|
const gd::String& name,
|
|
const gd::String& fullname,
|
|
const gd::String& description,
|
|
const gd::String& sentence,
|
|
const gd::String& group,
|
|
const gd::String& icon,
|
|
const gd::String& smallicon) {
|
|
#if defined(GD_IDE_ONLY)
|
|
gd::String nameWithNamespace =
|
|
extensionNamespace.empty() ? name : extensionNamespace + name;
|
|
actionsInfos[nameWithNamespace] = InstructionMetadata(extensionNamespace,
|
|
nameWithNamespace,
|
|
fullname,
|
|
description,
|
|
sentence,
|
|
group,
|
|
icon,
|
|
smallicon)
|
|
.SetHelpPath(GetHelpPath())
|
|
.SetIsObjectInstruction();
|
|
return actionsInfos[nameWithNamespace];
|
|
#endif
|
|
}
|
|
|
|
gd::InstructionMetadata& ObjectMetadata::AddScopedCondition(
|
|
const gd::String& name,
|
|
const gd::String& fullname,
|
|
const gd::String& description,
|
|
const gd::String& sentence,
|
|
const gd::String& group,
|
|
const gd::String& icon,
|
|
const gd::String& smallicon) {
|
|
#if defined(GD_IDE_ONLY)
|
|
gd::String nameWithNamespace =
|
|
GetName().empty()
|
|
? name // Don't insert a namespace separator for the base object.
|
|
: GetName() + gd::PlatformExtension::GetNamespaceSeparator() + name;
|
|
|
|
conditionsInfos[nameWithNamespace] = InstructionMetadata(extensionNamespace,
|
|
nameWithNamespace,
|
|
fullname,
|
|
description,
|
|
sentence,
|
|
group,
|
|
icon,
|
|
smallicon)
|
|
.SetHelpPath(GetHelpPath())
|
|
.SetIsObjectInstruction();
|
|
return conditionsInfos[nameWithNamespace];
|
|
#endif
|
|
}
|
|
|
|
gd::InstructionMetadata& ObjectMetadata::AddScopedAction(
|
|
const gd::String& name,
|
|
const gd::String& fullname,
|
|
const gd::String& description,
|
|
const gd::String& sentence,
|
|
const gd::String& group,
|
|
const gd::String& icon,
|
|
const gd::String& smallicon) {
|
|
#if defined(GD_IDE_ONLY)
|
|
gd::String nameWithNamespace =
|
|
GetName().empty()
|
|
? name // Don't insert a namespace separator for the base object.
|
|
: GetName() + gd::PlatformExtension::GetNamespaceSeparator() + name;
|
|
|
|
actionsInfos[nameWithNamespace] = InstructionMetadata(extensionNamespace,
|
|
nameWithNamespace,
|
|
fullname,
|
|
description,
|
|
sentence,
|
|
group,
|
|
icon,
|
|
smallicon)
|
|
.SetHelpPath(GetHelpPath())
|
|
.SetIsObjectInstruction();
|
|
return actionsInfos[nameWithNamespace];
|
|
#endif
|
|
}
|
|
|
|
gd::ExpressionMetadata& ObjectMetadata::AddExpression(
|
|
const gd::String& name,
|
|
const gd::String& fullname,
|
|
const gd::String& description,
|
|
const gd::String& group,
|
|
const gd::String& smallicon) {
|
|
#if defined(GD_IDE_ONLY)
|
|
// Be careful, objects expression do not have namespace (not necessary as
|
|
// objects inherits from only one derived object).
|
|
expressionsInfos[name] = ExpressionMetadata("number",
|
|
extensionNamespace,
|
|
name,
|
|
fullname,
|
|
description,
|
|
group,
|
|
smallicon)
|
|
.SetHelpPath(GetHelpPath());
|
|
|
|
return expressionsInfos[name];
|
|
#endif
|
|
}
|
|
|
|
gd::ExpressionMetadata& ObjectMetadata::AddStrExpression(
|
|
const gd::String& name,
|
|
const gd::String& fullname,
|
|
const gd::String& description,
|
|
const gd::String& group,
|
|
const gd::String& smallicon) {
|
|
#if defined(GD_IDE_ONLY)
|
|
// Be careful, objects expression do not have namespace (not necessary as
|
|
// objects inherits from only one derived object).
|
|
strExpressionsInfos[name] = ExpressionMetadata("string",
|
|
extensionNamespace,
|
|
name,
|
|
fullname,
|
|
description,
|
|
group,
|
|
smallicon)
|
|
.SetHelpPath(GetHelpPath());
|
|
|
|
return strExpressionsInfos[name];
|
|
#endif
|
|
}
|
|
|
|
gd::MultipleInstructionMetadata ObjectMetadata::AddExpressionAndCondition(
|
|
const gd::String& type,
|
|
const gd::String& name,
|
|
const gd::String& fullname,
|
|
const gd::String& descriptionSubject,
|
|
const gd::String& sentenceName,
|
|
const gd::String& group,
|
|
const gd::String& icon) {
|
|
gd::String expressionDescriptionTemplate = _("Return <subject>.");
|
|
auto& expression =
|
|
type == "number"
|
|
? AddExpression(name,
|
|
fullname,
|
|
expressionDescriptionTemplate.FindAndReplace(
|
|
"<subject>", descriptionSubject),
|
|
group,
|
|
icon)
|
|
: AddStrExpression(name,
|
|
fullname,
|
|
expressionDescriptionTemplate.FindAndReplace(
|
|
"<subject>", descriptionSubject),
|
|
group,
|
|
icon);
|
|
|
|
gd::String conditionDescriptionTemplate = _("Compare <subject>.");
|
|
auto& condition =
|
|
AddScopedCondition(name,
|
|
fullname,
|
|
conditionDescriptionTemplate.FindAndReplace(
|
|
"<subject>", descriptionSubject),
|
|
sentenceName,
|
|
group,
|
|
icon,
|
|
icon);
|
|
|
|
return MultipleInstructionMetadata::WithExpressionAndCondition(expression,
|
|
condition);
|
|
}
|
|
|
|
gd::MultipleInstructionMetadata
|
|
ObjectMetadata::AddExpressionAndConditionAndAction(
|
|
const gd::String& type,
|
|
const gd::String& name,
|
|
const gd::String& fullname,
|
|
const gd::String& descriptionSubject,
|
|
const gd::String& sentenceName,
|
|
const gd::String& group,
|
|
const gd::String& icon) {
|
|
if (type != "number" && type != "string" && type != "boolean") {
|
|
gd::LogError(
|
|
"Unrecognised type passed to AddExpressionAndConditionAndAction: " +
|
|
type + ". Verify this type is valid and supported.");
|
|
}
|
|
|
|
gd::String conditionDescriptionTemplate =
|
|
type == "boolean" ? _("Check if <subject>.") : _("Compare <subject>.");
|
|
auto& condition =
|
|
AddScopedCondition(name,
|
|
fullname,
|
|
conditionDescriptionTemplate.FindAndReplace(
|
|
"<subject>", descriptionSubject),
|
|
sentenceName,
|
|
group,
|
|
icon,
|
|
icon);
|
|
|
|
gd::String actionDescriptionTemplate = type == "boolean"
|
|
? _("Set (or unset) if <subject>.")
|
|
: _("Change <subject>.");
|
|
auto& action = AddScopedAction(
|
|
"Set" + name,
|
|
fullname,
|
|
actionDescriptionTemplate.FindAndReplace("<subject>", descriptionSubject),
|
|
sentenceName,
|
|
group,
|
|
icon,
|
|
icon);
|
|
|
|
|
|
if (type == "boolean") {
|
|
return MultipleInstructionMetadata::WithConditionAndAction(condition, action);
|
|
}
|
|
|
|
gd::String expressionDescriptionTemplate = _("Return <subject>.");
|
|
auto& expression =
|
|
type == "number"
|
|
? AddExpression(name,
|
|
fullname,
|
|
expressionDescriptionTemplate.FindAndReplace(
|
|
"<subject>", descriptionSubject),
|
|
group,
|
|
icon)
|
|
: AddStrExpression(name,
|
|
fullname,
|
|
expressionDescriptionTemplate.FindAndReplace(
|
|
"<subject>", descriptionSubject),
|
|
group,
|
|
icon);
|
|
|
|
return MultipleInstructionMetadata::WithExpressionAndConditionAndAction(
|
|
expression, condition, action);
|
|
}
|
|
|
|
gd::InstructionMetadata& ObjectMetadata::AddDuplicatedAction(
|
|
const gd::String& newActionName, const gd::String& copiedActionName) {
|
|
gd::String newNameWithNamespace = extensionNamespace + newActionName;
|
|
gd::String copiedNameWithNamespace = extensionNamespace + copiedActionName;
|
|
|
|
auto copiedAction = actionsInfos.find(copiedNameWithNamespace);
|
|
if (copiedAction == actionsInfos.end()) {
|
|
gd::LogWarning("Could not find an action with name " +
|
|
copiedNameWithNamespace + " to copy.");
|
|
} else {
|
|
actionsInfos[newNameWithNamespace] = copiedAction->second;
|
|
}
|
|
|
|
return actionsInfos[newNameWithNamespace];
|
|
}
|
|
|
|
gd::InstructionMetadata& ObjectMetadata::AddDuplicatedCondition(
|
|
const gd::String& newConditionName, const gd::String& copiedConditionName) {
|
|
gd::String newNameWithNamespace = extensionNamespace + newConditionName;
|
|
gd::String copiedNameWithNamespace = extensionNamespace + copiedConditionName;
|
|
|
|
auto copiedCondition = conditionsInfos.find(copiedNameWithNamespace);
|
|
if (copiedCondition == conditionsInfos.end()) {
|
|
gd::LogWarning("Could not find a condition with name " +
|
|
copiedNameWithNamespace + " to copy.");
|
|
} else {
|
|
conditionsInfos[newNameWithNamespace] = copiedCondition->second;
|
|
}
|
|
|
|
return conditionsInfos[newNameWithNamespace];
|
|
}
|
|
|
|
ObjectMetadata& ObjectMetadata::SetFullName(const gd::String& fullname_) {
|
|
#if defined(GD_IDE_ONLY)
|
|
fullname = fullname_;
|
|
#endif
|
|
return *this;
|
|
}
|
|
|
|
ObjectMetadata& ObjectMetadata::SetHelpUrl(const gd::String& helpUrl_) {
|
|
#if defined(GD_IDE_ONLY)
|
|
helpUrl = helpUrl_;
|
|
#endif
|
|
return *this;
|
|
}
|
|
|
|
ObjectMetadata& ObjectMetadata::SetDescription(const gd::String& description_) {
|
|
#if defined(GD_IDE_ONLY)
|
|
description = description_;
|
|
#endif
|
|
return *this;
|
|
}
|
|
|
|
ObjectMetadata& ObjectMetadata::SetIncludeFile(const gd::String& includeFile) {
|
|
#if defined(GD_IDE_ONLY)
|
|
includeFiles.clear();
|
|
includeFiles.push_back(includeFile);
|
|
#endif
|
|
return *this;
|
|
}
|
|
ObjectMetadata& ObjectMetadata::AddIncludeFile(const gd::String& includeFile) {
|
|
#if defined(GD_IDE_ONLY)
|
|
if (std::find(includeFiles.begin(), includeFiles.end(), includeFile) ==
|
|
includeFiles.end())
|
|
includeFiles.push_back(includeFile);
|
|
#endif
|
|
return *this;
|
|
}
|
|
|
|
} // namespace gd
|