mirror of
https://github.com/4ian/GDevelop.git
synced 2025-10-15 10:19:04 +00:00
Compare commits
62 Commits
feat/impro
...
cursor/imp
Author | SHA1 | Date | |
---|---|---|---|
![]() |
d8174561d2 | ||
![]() |
d474c2a47e | ||
![]() |
086d4a1c6f | ||
![]() |
65bc9ef4a8 | ||
![]() |
073268160f | ||
![]() |
40c576bc2d | ||
![]() |
0bbf7ed804 | ||
![]() |
f05fa88eec | ||
![]() |
6d67965c63 | ||
![]() |
98a24dc8fc | ||
![]() |
7fa55409ed | ||
![]() |
20f2c0460e | ||
![]() |
dc36bf96f1 | ||
![]() |
426e654f44 | ||
![]() |
6d0f93c3ce | ||
![]() |
11d3c52197 | ||
![]() |
2ee1050083 | ||
![]() |
ca00afb918 | ||
![]() |
02953a1436 | ||
![]() |
e14215c679 | ||
![]() |
c60ea0701a | ||
![]() |
de6ae1cc8f | ||
![]() |
ad24acd72f | ||
![]() |
3c0bb83032 | ||
![]() |
d5c96d74ed | ||
![]() |
43aada8ae7 | ||
![]() |
17a7c2815f | ||
![]() |
9441774a22 | ||
![]() |
d279276cc0 | ||
![]() |
c7f8a7a2eb | ||
![]() |
0fb92e000b | ||
![]() |
d70e3f71a6 | ||
![]() |
fe50ea3c01 | ||
![]() |
77f821250a | ||
![]() |
ff028ffa62 | ||
![]() |
64cc788d43 | ||
![]() |
a85668c8d9 | ||
![]() |
add042ec16 | ||
![]() |
e174136fb4 | ||
![]() |
ff8697ed71 | ||
![]() |
542a841791 | ||
![]() |
b9640f0049 | ||
![]() |
a6cc3dc85b | ||
![]() |
6083c71e0e | ||
![]() |
e844ea819b | ||
![]() |
27f0300bc7 | ||
![]() |
35cea2eaba | ||
![]() |
7c4617da99 | ||
![]() |
d6d7c5c1fb | ||
![]() |
b7f7a39aa7 | ||
![]() |
8c04771a87 | ||
![]() |
febf15b279 | ||
![]() |
a05e4b7ecc | ||
![]() |
3568a999f9 | ||
![]() |
207097bf03 | ||
![]() |
0e3d2b9570 | ||
![]() |
87fac429e8 | ||
![]() |
3b1097931b | ||
![]() |
ec7e408cd1 | ||
![]() |
f8a99b9cfa | ||
![]() |
4c7231e6ae | ||
![]() |
883d32515c |
@@ -42,15 +42,19 @@ gd::String EventsCodeGenerator::GenerateRelationalOperatorCall(
|
||||
const vector<gd::String>& arguments,
|
||||
const gd::String& callStartString,
|
||||
std::size_t startFromArgument) {
|
||||
std::size_t relationalOperatorIndex = instrInfos.parameters.GetParametersCount();
|
||||
for (std::size_t i = startFromArgument; i < instrInfos.parameters.GetParametersCount();
|
||||
std::size_t relationalOperatorIndex =
|
||||
instrInfos.parameters.GetParametersCount();
|
||||
for (std::size_t i = startFromArgument;
|
||||
i < instrInfos.parameters.GetParametersCount();
|
||||
++i) {
|
||||
if (instrInfos.parameters.GetParameter(i).GetType() == "relationalOperator") {
|
||||
if (instrInfos.parameters.GetParameter(i).GetType() ==
|
||||
"relationalOperator") {
|
||||
relationalOperatorIndex = i;
|
||||
}
|
||||
}
|
||||
// Ensure that there is at least one parameter after the relational operator
|
||||
if (relationalOperatorIndex + 1 >= instrInfos.parameters.GetParametersCount()) {
|
||||
if (relationalOperatorIndex + 1 >=
|
||||
instrInfos.parameters.GetParametersCount()) {
|
||||
ReportError();
|
||||
return "";
|
||||
}
|
||||
@@ -87,20 +91,23 @@ gd::String EventsCodeGenerator::GenerateRelationalOperation(
|
||||
const gd::String& relationalOperator,
|
||||
const gd::String& lhs,
|
||||
const gd::String& rhs) {
|
||||
return lhs + " " + GenerateRelationalOperatorCodes(relationalOperator) + " " + rhs;
|
||||
return lhs + " " + GenerateRelationalOperatorCodes(relationalOperator) + " " +
|
||||
rhs;
|
||||
}
|
||||
|
||||
const gd::String EventsCodeGenerator::GenerateRelationalOperatorCodes(const gd::String &operatorString) {
|
||||
if (operatorString == "=") {
|
||||
return "==";
|
||||
}
|
||||
if (operatorString != "<" && operatorString != ">" &&
|
||||
operatorString != "<=" && operatorString != ">=" && operatorString != "!=" &&
|
||||
operatorString != "startsWith" && operatorString != "endsWith" && operatorString != "contains") {
|
||||
cout << "Warning: Bad relational operator: Set to == by default." << endl;
|
||||
return "==";
|
||||
}
|
||||
return operatorString;
|
||||
const gd::String EventsCodeGenerator::GenerateRelationalOperatorCodes(
|
||||
const gd::String& operatorString) {
|
||||
if (operatorString == "=") {
|
||||
return "==";
|
||||
}
|
||||
if (operatorString != "<" && operatorString != ">" &&
|
||||
operatorString != "<=" && operatorString != ">=" &&
|
||||
operatorString != "!=" && operatorString != "startsWith" &&
|
||||
operatorString != "endsWith" && operatorString != "contains") {
|
||||
cout << "Warning: Bad relational operator: Set to == by default." << endl;
|
||||
return "==";
|
||||
}
|
||||
return operatorString;
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -124,7 +131,8 @@ gd::String EventsCodeGenerator::GenerateOperatorCall(
|
||||
const gd::String& getterStartString,
|
||||
std::size_t startFromArgument) {
|
||||
std::size_t operatorIndex = instrInfos.parameters.GetParametersCount();
|
||||
for (std::size_t i = startFromArgument; i < instrInfos.parameters.GetParametersCount();
|
||||
for (std::size_t i = startFromArgument;
|
||||
i < instrInfos.parameters.GetParametersCount();
|
||||
++i) {
|
||||
if (instrInfos.parameters.GetParameter(i).GetType() == "operator") {
|
||||
operatorIndex = i;
|
||||
@@ -195,7 +203,8 @@ gd::String EventsCodeGenerator::GenerateCompoundOperatorCall(
|
||||
const gd::String& callStartString,
|
||||
std::size_t startFromArgument) {
|
||||
std::size_t operatorIndex = instrInfos.parameters.GetParametersCount();
|
||||
for (std::size_t i = startFromArgument; i < instrInfos.parameters.GetParametersCount();
|
||||
for (std::size_t i = startFromArgument;
|
||||
i < instrInfos.parameters.GetParametersCount();
|
||||
++i) {
|
||||
if (instrInfos.parameters.GetParameter(i).GetType() == "operator") {
|
||||
operatorIndex = i;
|
||||
@@ -248,7 +257,8 @@ gd::String EventsCodeGenerator::GenerateMutatorCall(
|
||||
const gd::String& callStartString,
|
||||
std::size_t startFromArgument) {
|
||||
std::size_t operatorIndex = instrInfos.parameters.GetParametersCount();
|
||||
for (std::size_t i = startFromArgument; i < instrInfos.parameters.GetParametersCount();
|
||||
for (std::size_t i = startFromArgument;
|
||||
i < instrInfos.parameters.GetParametersCount();
|
||||
++i) {
|
||||
if (instrInfos.parameters.GetParameter(i).GetType() == "operator") {
|
||||
operatorIndex = i;
|
||||
@@ -323,83 +333,97 @@ gd::String EventsCodeGenerator::GenerateConditionCode(
|
||||
}
|
||||
|
||||
// Insert code only parameters and be sure there is no lack of parameter.
|
||||
while (condition.GetParameters().size() < instrInfos.parameters.GetParametersCount()) {
|
||||
while (condition.GetParameters().size() <
|
||||
instrInfos.parameters.GetParametersCount()) {
|
||||
vector<gd::Expression> parameters = condition.GetParameters();
|
||||
parameters.push_back(gd::Expression(""));
|
||||
condition.SetParameters(parameters);
|
||||
}
|
||||
|
||||
gd::EventsCodeGenerator::CheckBehaviorParameters(condition, instrInfos);
|
||||
// Verify that there are no mismatches between object type in parameters.
|
||||
for (std::size_t pNb = 0; pNb < instrInfos.parameters.GetParametersCount(); ++pNb) {
|
||||
if (ParameterMetadata::IsObject(instrInfos.parameters.GetParameter(pNb).GetType())) {
|
||||
for (std::size_t pNb = 0; pNb < instrInfos.parameters.GetParametersCount();
|
||||
++pNb) {
|
||||
if (ParameterMetadata::IsObject(
|
||||
instrInfos.parameters.GetParameter(pNb).GetType())) {
|
||||
gd::String objectInParameter =
|
||||
condition.GetParameter(pNb).GetPlainString();
|
||||
|
||||
const auto &expectedObjectType =
|
||||
const auto& expectedObjectType =
|
||||
instrInfos.parameters.GetParameter(pNb).GetExtraInfo();
|
||||
const auto &actualObjectType =
|
||||
const auto& actualObjectType =
|
||||
GetObjectsContainersList().GetTypeOfObject(objectInParameter);
|
||||
if (!GetObjectsContainersList().HasObjectOrGroupNamed(
|
||||
objectInParameter)) {
|
||||
gd::ProjectDiagnostic projectDiagnostic(
|
||||
gd::ProjectDiagnostic::ErrorType::UnknownObject, "",
|
||||
objectInParameter, "");
|
||||
gd::ProjectDiagnostic::ErrorType::UnknownObject,
|
||||
"",
|
||||
objectInParameter,
|
||||
"");
|
||||
if (diagnosticReport) diagnosticReport->Add(projectDiagnostic);
|
||||
return "/* Unknown object - skipped. */";
|
||||
} else if (!expectedObjectType.empty() &&
|
||||
actualObjectType != expectedObjectType) {
|
||||
gd::ProjectDiagnostic projectDiagnostic(
|
||||
gd::ProjectDiagnostic::ErrorType::MismatchedObjectType, "",
|
||||
actualObjectType, expectedObjectType, objectInParameter);
|
||||
gd::ProjectDiagnostic::ErrorType::MismatchedObjectType,
|
||||
"",
|
||||
actualObjectType,
|
||||
expectedObjectType,
|
||||
objectInParameter);
|
||||
if (diagnosticReport) diagnosticReport->Add(projectDiagnostic);
|
||||
return "/* Mismatched object type - skipped. */";
|
||||
}
|
||||
}
|
||||
}
|
||||
bool isAnyBehaviorMissing =
|
||||
gd::EventsCodeGenerator::CheckBehaviorParameters(condition, instrInfos);
|
||||
if (isAnyBehaviorMissing) {
|
||||
return "/* Missing behavior - skipped. */";
|
||||
}
|
||||
|
||||
if (instrInfos.IsObjectInstruction()) {
|
||||
gd::String objectName = condition.GetParameter(0).GetPlainString();
|
||||
if (!objectName.empty() && instrInfos.parameters.GetParametersCount() > 0) {
|
||||
std::vector<gd::String> realObjects =
|
||||
GetObjectsContainersList().ExpandObjectName(objectName, context.GetCurrentObject());
|
||||
GetObjectsContainersList().ExpandObjectName(
|
||||
objectName, context.GetCurrentObject());
|
||||
for (std::size_t i = 0; i < realObjects.size(); ++i) {
|
||||
// Set up the context
|
||||
gd::String objectType = GetObjectsContainersList().GetTypeOfObject(realObjects[i]);
|
||||
gd::String objectType =
|
||||
GetObjectsContainersList().GetTypeOfObject(realObjects[i]);
|
||||
const ObjectMetadata& objInfo =
|
||||
MetadataProvider::GetObjectMetadata(platform, objectType);
|
||||
|
||||
AddIncludeFiles(objInfo.includeFiles);
|
||||
context.SetCurrentObject(realObjects[i]);
|
||||
context.ObjectsListNeeded(realObjects[i]);
|
||||
AddIncludeFiles(objInfo.includeFiles);
|
||||
context.SetCurrentObject(realObjects[i]);
|
||||
context.ObjectsListNeeded(realObjects[i]);
|
||||
|
||||
// Prepare arguments and generate the condition whole code
|
||||
vector<gd::String> arguments = GenerateParametersCodes(
|
||||
condition.GetParameters(), instrInfos.parameters, context);
|
||||
conditionCode += GenerateObjectCondition(realObjects[i],
|
||||
objInfo,
|
||||
arguments,
|
||||
instrInfos,
|
||||
returnBoolean,
|
||||
condition.IsInverted(),
|
||||
context);
|
||||
// Prepare arguments and generate the condition whole code
|
||||
vector<gd::String> arguments = GenerateParametersCodes(
|
||||
condition.GetParameters(), instrInfos.parameters, context);
|
||||
conditionCode += GenerateObjectCondition(realObjects[i],
|
||||
objInfo,
|
||||
arguments,
|
||||
instrInfos,
|
||||
returnBoolean,
|
||||
condition.IsInverted(),
|
||||
context);
|
||||
|
||||
context.SetNoCurrentObject();
|
||||
context.SetNoCurrentObject();
|
||||
}
|
||||
}
|
||||
} else if (instrInfos.IsBehaviorInstruction()) {
|
||||
if (instrInfos.parameters.GetParametersCount() >= 2) {
|
||||
const gd::String &objectName = condition.GetParameter(0).GetPlainString();
|
||||
const gd::String &behaviorName =
|
||||
const gd::String& objectName = condition.GetParameter(0).GetPlainString();
|
||||
const gd::String& behaviorName =
|
||||
condition.GetParameter(1).GetPlainString();
|
||||
const gd::String &actualBehaviorType =
|
||||
const gd::String& actualBehaviorType =
|
||||
GetObjectsContainersList().GetTypeOfBehavior(behaviorName);
|
||||
|
||||
std::vector<gd::String> realObjects =
|
||||
GetObjectsContainersList().ExpandObjectName(
|
||||
objectName, context.GetCurrentObject());
|
||||
|
||||
const BehaviorMetadata &autoInfo =
|
||||
const BehaviorMetadata& autoInfo =
|
||||
MetadataProvider::GetBehaviorMetadata(platform, actualBehaviorType);
|
||||
|
||||
for (std::size_t i = 0; i < realObjects.size(); ++i) {
|
||||
@@ -411,15 +435,14 @@ gd::String EventsCodeGenerator::GenerateConditionCode(
|
||||
// Prepare arguments and generate the whole condition code
|
||||
vector<gd::String> arguments = GenerateParametersCodes(
|
||||
condition.GetParameters(), instrInfos.parameters, context);
|
||||
conditionCode += GenerateBehaviorCondition(
|
||||
realObjects[i],
|
||||
behaviorName,
|
||||
autoInfo,
|
||||
arguments,
|
||||
instrInfos,
|
||||
returnBoolean,
|
||||
condition.IsInverted(),
|
||||
context);
|
||||
conditionCode += GenerateBehaviorCondition(realObjects[i],
|
||||
behaviorName,
|
||||
autoInfo,
|
||||
arguments,
|
||||
instrInfos,
|
||||
returnBoolean,
|
||||
condition.IsInverted(),
|
||||
context);
|
||||
|
||||
context.SetNoCurrentObject();
|
||||
}
|
||||
@@ -488,31 +511,50 @@ gd::String EventsCodeGenerator::GenerateConditionsListCode(
|
||||
return outputCode;
|
||||
}
|
||||
|
||||
void EventsCodeGenerator::CheckBehaviorParameters(
|
||||
const gd::Instruction &instruction,
|
||||
const gd::InstructionMetadata &instrInfos) {
|
||||
gd::ParameterMetadataTools::IterateOverParameters(
|
||||
instruction.GetParameters(), instrInfos.parameters,
|
||||
[this](const gd::ParameterMetadata ¶meterMetadata,
|
||||
const gd::Expression ¶meterValue,
|
||||
const gd::String &lastObjectName) {
|
||||
bool EventsCodeGenerator::CheckBehaviorParameters(
|
||||
const gd::Instruction& instruction,
|
||||
const gd::InstructionMetadata& instrInfos) {
|
||||
bool isAnyBehaviorMissing = false;
|
||||
gd::ParameterMetadataTools::IterateOverParametersWithIndex(
|
||||
instruction.GetParameters(),
|
||||
instrInfos.parameters,
|
||||
[this, &isAnyBehaviorMissing, &instrInfos](
|
||||
const gd::ParameterMetadata& parameterMetadata,
|
||||
const gd::Expression& parameterValue,
|
||||
size_t parameterIndex,
|
||||
const gd::String& lastObjectName,
|
||||
size_t lastObjectIndex) {
|
||||
if (ParameterMetadata::IsBehavior(parameterMetadata.GetType())) {
|
||||
const gd::String &behaviorName = parameterValue.GetPlainString();
|
||||
const gd::String &actualBehaviorType =
|
||||
const gd::String& behaviorName = parameterValue.GetPlainString();
|
||||
const gd::String& actualBehaviorType =
|
||||
GetObjectsContainersList().GetTypeOfBehaviorInObjectOrGroup(
|
||||
lastObjectName, behaviorName);
|
||||
const gd::String &expectedBehaviorType =
|
||||
const gd::String& expectedBehaviorType =
|
||||
parameterMetadata.GetExtraInfo();
|
||||
|
||||
if (!expectedBehaviorType.empty() &&
|
||||
actualBehaviorType != expectedBehaviorType) {
|
||||
const auto& objectParameterMetadata =
|
||||
instrInfos.GetParameter(lastObjectIndex);
|
||||
// Event functions crash if some objects in a group are missing
|
||||
// the required behaviors, since they lose reference to the original
|
||||
// objects. Missing behaviors are considered "fatal" only for
|
||||
// ObjectList parameters, in order to minimize side effects on
|
||||
// built-in functions.
|
||||
if (objectParameterMetadata.GetType() == "objectList") {
|
||||
isAnyBehaviorMissing = true;
|
||||
}
|
||||
gd::ProjectDiagnostic projectDiagnostic(
|
||||
gd::ProjectDiagnostic::ErrorType::MissingBehavior, "",
|
||||
actualBehaviorType, expectedBehaviorType, lastObjectName);
|
||||
gd::ProjectDiagnostic::ErrorType::MissingBehavior,
|
||||
"",
|
||||
actualBehaviorType,
|
||||
expectedBehaviorType,
|
||||
lastObjectName);
|
||||
if (diagnosticReport) diagnosticReport->Add(projectDiagnostic);
|
||||
}
|
||||
}
|
||||
});
|
||||
return isAnyBehaviorMissing;
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -521,7 +563,8 @@ void EventsCodeGenerator::CheckBehaviorParameters(
|
||||
gd::String EventsCodeGenerator::GenerateActionCode(
|
||||
gd::Instruction& action,
|
||||
EventsCodeGenerationContext& context,
|
||||
const gd::String& optionalAsyncCallbackName) {
|
||||
const gd::String& optionalAsyncCallbackName,
|
||||
const gd::String& optionalAsyncCallbackId) {
|
||||
gd::String actionCode;
|
||||
|
||||
const gd::InstructionMetadata& instrInfos =
|
||||
@@ -546,39 +589,51 @@ gd::String EventsCodeGenerator::GenerateActionCode(
|
||||
: instrInfos.codeExtraInformation.functionCallName;
|
||||
|
||||
// Be sure there is no lack of parameter.
|
||||
while (action.GetParameters().size() < instrInfos.parameters.GetParametersCount()) {
|
||||
while (action.GetParameters().size() <
|
||||
instrInfos.parameters.GetParametersCount()) {
|
||||
vector<gd::Expression> parameters = action.GetParameters();
|
||||
parameters.push_back(gd::Expression(""));
|
||||
action.SetParameters(parameters);
|
||||
}
|
||||
|
||||
gd::EventsCodeGenerator::CheckBehaviorParameters(action, instrInfos);
|
||||
// Verify that there are no mismatches between object type in parameters.
|
||||
for (std::size_t pNb = 0; pNb < instrInfos.parameters.GetParametersCount(); ++pNb) {
|
||||
if (ParameterMetadata::IsObject(instrInfos.parameters.GetParameter(pNb).GetType())) {
|
||||
for (std::size_t pNb = 0; pNb < instrInfos.parameters.GetParametersCount();
|
||||
++pNb) {
|
||||
if (ParameterMetadata::IsObject(
|
||||
instrInfos.parameters.GetParameter(pNb).GetType())) {
|
||||
gd::String objectInParameter = action.GetParameter(pNb).GetPlainString();
|
||||
|
||||
const auto &expectedObjectType =
|
||||
const auto& expectedObjectType =
|
||||
instrInfos.parameters.GetParameter(pNb).GetExtraInfo();
|
||||
const auto &actualObjectType =
|
||||
const auto& actualObjectType =
|
||||
GetObjectsContainersList().GetTypeOfObject(objectInParameter);
|
||||
if (!GetObjectsContainersList().HasObjectOrGroupNamed(
|
||||
objectInParameter)) {
|
||||
gd::ProjectDiagnostic projectDiagnostic(
|
||||
gd::ProjectDiagnostic::ErrorType::UnknownObject, "",
|
||||
objectInParameter, "");
|
||||
gd::ProjectDiagnostic::ErrorType::UnknownObject,
|
||||
"",
|
||||
objectInParameter,
|
||||
"");
|
||||
if (diagnosticReport) diagnosticReport->Add(projectDiagnostic);
|
||||
return "/* Unknown object - skipped. */";
|
||||
} else if (!expectedObjectType.empty() &&
|
||||
actualObjectType != expectedObjectType) {
|
||||
gd::ProjectDiagnostic projectDiagnostic(
|
||||
gd::ProjectDiagnostic::ErrorType::MismatchedObjectType, "",
|
||||
actualObjectType, expectedObjectType, objectInParameter);
|
||||
gd::ProjectDiagnostic::ErrorType::MismatchedObjectType,
|
||||
"",
|
||||
actualObjectType,
|
||||
expectedObjectType,
|
||||
objectInParameter);
|
||||
if (diagnosticReport) diagnosticReport->Add(projectDiagnostic);
|
||||
return "/* Mismatched object type - skipped. */";
|
||||
}
|
||||
}
|
||||
}
|
||||
bool isAnyBehaviorMissing =
|
||||
gd::EventsCodeGenerator::CheckBehaviorParameters(action, instrInfos);
|
||||
if (isAnyBehaviorMissing) {
|
||||
return "/* Missing behavior - skipped. */";
|
||||
}
|
||||
|
||||
// Call free function first if available
|
||||
if (instrInfos.IsObjectInstruction()) {
|
||||
@@ -586,43 +641,46 @@ gd::String EventsCodeGenerator::GenerateActionCode(
|
||||
|
||||
if (instrInfos.parameters.GetParametersCount() > 0) {
|
||||
std::vector<gd::String> realObjects =
|
||||
GetObjectsContainersList().ExpandObjectName(objectName, context.GetCurrentObject());
|
||||
GetObjectsContainersList().ExpandObjectName(
|
||||
objectName, context.GetCurrentObject());
|
||||
for (std::size_t i = 0; i < realObjects.size(); ++i) {
|
||||
// Setup context
|
||||
gd::String objectType = GetObjectsContainersList().GetTypeOfObject(realObjects[i]);
|
||||
gd::String objectType =
|
||||
GetObjectsContainersList().GetTypeOfObject(realObjects[i]);
|
||||
const ObjectMetadata& objInfo =
|
||||
MetadataProvider::GetObjectMetadata(platform, objectType);
|
||||
|
||||
AddIncludeFiles(objInfo.includeFiles);
|
||||
context.SetCurrentObject(realObjects[i]);
|
||||
context.ObjectsListNeeded(realObjects[i]);
|
||||
AddIncludeFiles(objInfo.includeFiles);
|
||||
context.SetCurrentObject(realObjects[i]);
|
||||
context.ObjectsListNeeded(realObjects[i]);
|
||||
|
||||
// Prepare arguments and generate the whole action code
|
||||
vector<gd::String> arguments = GenerateParametersCodes(
|
||||
action.GetParameters(), instrInfos.parameters, context);
|
||||
actionCode += GenerateObjectAction(realObjects[i],
|
||||
objInfo,
|
||||
functionCallName,
|
||||
arguments,
|
||||
instrInfos,
|
||||
context,
|
||||
optionalAsyncCallbackName);
|
||||
// Prepare arguments and generate the whole action code
|
||||
vector<gd::String> arguments = GenerateParametersCodes(
|
||||
action.GetParameters(), instrInfos.parameters, context);
|
||||
actionCode += GenerateObjectAction(realObjects[i],
|
||||
objInfo,
|
||||
functionCallName,
|
||||
arguments,
|
||||
instrInfos,
|
||||
context,
|
||||
optionalAsyncCallbackName,
|
||||
optionalAsyncCallbackId);
|
||||
|
||||
context.SetNoCurrentObject();
|
||||
context.SetNoCurrentObject();
|
||||
}
|
||||
}
|
||||
} else if (instrInfos.IsBehaviorInstruction()) {
|
||||
if (instrInfos.parameters.GetParametersCount() >= 2) {
|
||||
const gd::String &objectName = action.GetParameter(0).GetPlainString();
|
||||
const gd::String &behaviorName = action.GetParameter(1).GetPlainString();
|
||||
const gd::String &actualBehaviorType =
|
||||
const gd::String& objectName = action.GetParameter(0).GetPlainString();
|
||||
const gd::String& behaviorName = action.GetParameter(1).GetPlainString();
|
||||
const gd::String& actualBehaviorType =
|
||||
GetObjectsContainersList().GetTypeOfBehavior(behaviorName);
|
||||
|
||||
std::vector<gd::String> realObjects =
|
||||
GetObjectsContainersList().ExpandObjectName(
|
||||
objectName, context.GetCurrentObject());
|
||||
|
||||
const BehaviorMetadata &autoInfo =
|
||||
const BehaviorMetadata& autoInfo =
|
||||
MetadataProvider::GetBehaviorMetadata(platform, actualBehaviorType);
|
||||
|
||||
AddIncludeFiles(autoInfo.includeFiles);
|
||||
@@ -634,15 +692,15 @@ gd::String EventsCodeGenerator::GenerateActionCode(
|
||||
// Prepare arguments and generate the whole action code
|
||||
vector<gd::String> arguments = GenerateParametersCodes(
|
||||
action.GetParameters(), instrInfos.parameters, context);
|
||||
actionCode +=
|
||||
GenerateBehaviorAction(realObjects[i],
|
||||
behaviorName,
|
||||
autoInfo,
|
||||
functionCallName,
|
||||
arguments,
|
||||
instrInfos,
|
||||
context,
|
||||
optionalAsyncCallbackName);
|
||||
actionCode += GenerateBehaviorAction(realObjects[i],
|
||||
behaviorName,
|
||||
autoInfo,
|
||||
functionCallName,
|
||||
arguments,
|
||||
instrInfos,
|
||||
context,
|
||||
optionalAsyncCallbackName,
|
||||
optionalAsyncCallbackId);
|
||||
|
||||
context.SetNoCurrentObject();
|
||||
}
|
||||
@@ -654,7 +712,8 @@ gd::String EventsCodeGenerator::GenerateActionCode(
|
||||
arguments,
|
||||
instrInfos,
|
||||
context,
|
||||
optionalAsyncCallbackName);
|
||||
optionalAsyncCallbackName,
|
||||
optionalAsyncCallbackId);
|
||||
}
|
||||
|
||||
return actionCode;
|
||||
@@ -667,8 +726,8 @@ gd::String EventsCodeGenerator::GenerateLocalVariablesStackAccessor() {
|
||||
}
|
||||
|
||||
gd::String EventsCodeGenerator::GenerateAnyOrSceneVariableGetter(
|
||||
const gd::Expression &variableExpression,
|
||||
EventsCodeGenerationContext &context) {
|
||||
const gd::Expression& variableExpression,
|
||||
EventsCodeGenerationContext& context) {
|
||||
const auto variableName = gd::ExpressionVariableNameFinder::GetVariableName(
|
||||
*variableExpression.GetRootNode());
|
||||
|
||||
@@ -679,8 +738,12 @@ gd::String EventsCodeGenerator::GenerateAnyOrSceneVariableGetter(
|
||||
: "scenevar";
|
||||
|
||||
return gd::ExpressionCodeGenerator::GenerateExpressionCode(
|
||||
*this, context, variableParameterType,
|
||||
variableExpression.GetPlainString(), "", "AllowUndeclaredVariable");
|
||||
*this,
|
||||
context,
|
||||
variableParameterType,
|
||||
variableExpression.GetPlainString(),
|
||||
"",
|
||||
"AllowUndeclaredVariable");
|
||||
}
|
||||
|
||||
const EventsCodeGenerator::CallbackDescriptor
|
||||
@@ -727,6 +790,11 @@ EventsCodeGenerator::GenerateCallback(
|
||||
|
||||
AddCustomCodeOutsideMain(callbackCode);
|
||||
|
||||
const gd::String idToCallbackMapUpdate = GetCodeNamespaceAccessor() +
|
||||
"idToCallbackMap.set(" + callbackID +
|
||||
", " + callbackFunctionName + ");\n";
|
||||
AddCustomCodeOutsideMain(idToCallbackMapUpdate);
|
||||
|
||||
std::set<gd::String> requiredObjects;
|
||||
// Build the list of all objects required by the callback. Any object that has
|
||||
// already been declared could have gone through previous object picking, so
|
||||
@@ -769,7 +837,7 @@ gd::String EventsCodeGenerator::GenerateActionsListCode(
|
||||
} else {
|
||||
outputCode += actionCode;
|
||||
}
|
||||
outputCode += "}";
|
||||
outputCode += "}\n";
|
||||
}
|
||||
|
||||
return outputCode;
|
||||
@@ -786,13 +854,28 @@ gd::String EventsCodeGenerator::GenerateParameterCodes(
|
||||
|
||||
if (ParameterMetadata::IsExpression("number", metadata.GetType())) {
|
||||
argOutput = gd::ExpressionCodeGenerator::GenerateExpressionCode(
|
||||
*this, context, "number", parameter, lastObjectName, metadata.GetExtraInfo());
|
||||
*this,
|
||||
context,
|
||||
"number",
|
||||
parameter,
|
||||
lastObjectName,
|
||||
metadata.GetExtraInfo());
|
||||
} else if (ParameterMetadata::IsExpression("string", metadata.GetType())) {
|
||||
argOutput = gd::ExpressionCodeGenerator::GenerateExpressionCode(
|
||||
*this, context, "string", parameter, lastObjectName, metadata.GetExtraInfo());
|
||||
*this,
|
||||
context,
|
||||
"string",
|
||||
parameter,
|
||||
lastObjectName,
|
||||
metadata.GetExtraInfo());
|
||||
} else if (ParameterMetadata::IsExpression("variable", metadata.GetType())) {
|
||||
argOutput = gd::ExpressionCodeGenerator::GenerateExpressionCode(
|
||||
*this, context, metadata.GetType(), parameter, lastObjectName, metadata.GetExtraInfo());
|
||||
*this,
|
||||
context,
|
||||
metadata.GetType(),
|
||||
parameter,
|
||||
lastObjectName,
|
||||
metadata.GetExtraInfo());
|
||||
} else if (ParameterMetadata::IsObject(metadata.GetType())) {
|
||||
// It would be possible to run a gd::ExpressionCodeGenerator if later
|
||||
// objects can have nested objects, or function returning objects.
|
||||
@@ -827,7 +910,8 @@ gd::String EventsCodeGenerator::GenerateParameterCodes(
|
||||
metadata.GetType() == "atlasResource" ||
|
||||
metadata.GetType() == "spineResource" ||
|
||||
// Deprecated, old parameter names:
|
||||
metadata.GetType() == "password" || metadata.GetType() == "musicfile" ||
|
||||
metadata.GetType() == "password" ||
|
||||
metadata.GetType() == "musicfile" ||
|
||||
metadata.GetType() == "soundfile") {
|
||||
argOutput = "\"" + ConvertToString(parameter.GetPlainString()) + "\"";
|
||||
} else if (metadata.GetType() == "mouse") {
|
||||
@@ -977,7 +1061,8 @@ gd::String EventsCodeGenerator::GenerateEventsListCode(
|
||||
for (std::size_t eId = 0; eId < events.size(); ++eId) {
|
||||
auto& event = events[eId];
|
||||
if (event.HasVariables()) {
|
||||
GetProjectScopedContainers().GetVariablesContainersList().Push(event.GetVariables());
|
||||
GetProjectScopedContainers().GetVariablesContainersList().Push(
|
||||
event.GetVariables());
|
||||
}
|
||||
|
||||
// Each event has its own context : Objects picked in an event are totally
|
||||
@@ -1102,7 +1187,7 @@ gd::String EventsCodeGenerator::GenerateFreeCondition(
|
||||
instrInfos.codeExtraInformation.functionCallName);
|
||||
} else {
|
||||
predicate = instrInfos.codeExtraInformation.functionCallName + "(" +
|
||||
GenerateArgumentsList(arguments, 0) + ")";
|
||||
GenerateArgumentsList(arguments, 0) + ")";
|
||||
}
|
||||
|
||||
// Add logical not if needed
|
||||
@@ -1146,7 +1231,7 @@ gd::String EventsCodeGenerator::GenerateObjectCondition(
|
||||
instrInfos, arguments, objectFunctionCallNamePart, 1);
|
||||
} else {
|
||||
predicate = objectFunctionCallNamePart + "(" +
|
||||
GenerateArgumentsList(arguments, 1) + ")";
|
||||
GenerateArgumentsList(arguments, 1) + ")";
|
||||
}
|
||||
if (conditionInverted) predicate = GenerateNegatedPredicate(predicate);
|
||||
|
||||
@@ -1178,18 +1263,20 @@ gd::String EventsCodeGenerator::GenerateBehaviorCondition(
|
||||
}
|
||||
|
||||
gd::String EventsCodeGenerator::GenerateFreeAction(
|
||||
const gd::String& functionCallName,
|
||||
const gd::String& functionCallName,
|
||||
const std::vector<gd::String>& arguments,
|
||||
const gd::InstructionMetadata& instrInfos,
|
||||
gd::EventsCodeGenerationContext& context,
|
||||
const gd::String& optionalAsyncCallbackName) {
|
||||
const gd::String& optionalAsyncCallbackName,
|
||||
const gd::String& optionalAsyncCallbackId) {
|
||||
// Generate call
|
||||
gd::String call;
|
||||
if (instrInfos.codeExtraInformation.type == "number" ||
|
||||
instrInfos.codeExtraInformation.type == "string" ||
|
||||
// Boolean actions declared with addExpressionAndConditionAndAction uses
|
||||
// MutatorAndOrAccessor even though they don't declare an operator parameter.
|
||||
// Boolean operators are only used with SetMutators or SetCustomCodeGenerator.
|
||||
// MutatorAndOrAccessor even though they don't declare an operator
|
||||
// parameter. Boolean operators are only used with SetMutators or
|
||||
// SetCustomCodeGenerator.
|
||||
(instrInfos.codeExtraInformation.type == "boolean" &&
|
||||
instrInfos.codeExtraInformation.accessType ==
|
||||
gd::InstructionMetadata::ExtraInformation::AccessType::Mutators)) {
|
||||
@@ -1202,23 +1289,19 @@ gd::String EventsCodeGenerator::GenerateFreeAction(
|
||||
instrInfos.codeExtraInformation.optionalAssociatedInstruction);
|
||||
else if (instrInfos.codeExtraInformation.accessType ==
|
||||
gd::InstructionMetadata::ExtraInformation::Mutators)
|
||||
call =
|
||||
GenerateMutatorCall(instrInfos,
|
||||
arguments,
|
||||
functionCallName);
|
||||
call = GenerateMutatorCall(instrInfos, arguments, functionCallName);
|
||||
else
|
||||
call = GenerateCompoundOperatorCall(
|
||||
instrInfos,
|
||||
arguments,
|
||||
functionCallName);
|
||||
call =
|
||||
GenerateCompoundOperatorCall(instrInfos, arguments, functionCallName);
|
||||
} else {
|
||||
call = functionCallName + "(" +
|
||||
GenerateArgumentsList(arguments) + ")";
|
||||
call = functionCallName + "(" + GenerateArgumentsList(arguments) + ")";
|
||||
}
|
||||
|
||||
if (!optionalAsyncCallbackName.empty())
|
||||
if (!optionalAsyncCallbackName.empty() && !optionalAsyncCallbackId.empty()) {
|
||||
call = "runtimeScene.getAsyncTasksManager().addTask(" + call + ", " +
|
||||
optionalAsyncCallbackName + ")";
|
||||
optionalAsyncCallbackName + ", " + optionalAsyncCallbackId +
|
||||
", asyncObjectsList)";
|
||||
}
|
||||
|
||||
return call + ";\n";
|
||||
}
|
||||
@@ -1230,7 +1313,8 @@ gd::String EventsCodeGenerator::GenerateObjectAction(
|
||||
const std::vector<gd::String>& arguments,
|
||||
const gd::InstructionMetadata& instrInfos,
|
||||
gd::EventsCodeGenerationContext& context,
|
||||
const gd::String& optionalAsyncCallbackName) {
|
||||
const gd::String& optionalAsyncCallbackName,
|
||||
const gd::String& optionalAsyncCallbackId) {
|
||||
// Create call
|
||||
gd::String call;
|
||||
if ((instrInfos.codeExtraInformation.type == "number" ||
|
||||
@@ -1271,7 +1355,8 @@ gd::String EventsCodeGenerator::GenerateBehaviorAction(
|
||||
const std::vector<gd::String>& arguments,
|
||||
const gd::InstructionMetadata& instrInfos,
|
||||
gd::EventsCodeGenerationContext& context,
|
||||
const gd::String& optionalAsyncCallbackName) {
|
||||
const gd::String& optionalAsyncCallbackName,
|
||||
const gd::String& optionalAsyncCallbackId) {
|
||||
// Create call
|
||||
gd::String call;
|
||||
if ((instrInfos.codeExtraInformation.type == "number" ||
|
||||
@@ -1286,17 +1371,13 @@ gd::String EventsCodeGenerator::GenerateBehaviorAction(
|
||||
2);
|
||||
else
|
||||
call = GenerateCompoundOperatorCall(
|
||||
instrInfos,
|
||||
arguments,
|
||||
functionCallName,
|
||||
2);
|
||||
instrInfos, arguments, functionCallName, 2);
|
||||
return "For each picked object \"" + objectName + "\", call " + call +
|
||||
" for behavior \"" + behaviorName + "\".\n";
|
||||
} else {
|
||||
gd::String argumentsStr = GenerateArgumentsList(arguments, 2);
|
||||
|
||||
call = functionCallName + "(" +
|
||||
argumentsStr + ")";
|
||||
call = functionCallName + "(" + argumentsStr + ")";
|
||||
|
||||
return "For each picked object \"" + objectName + "\", call " + call + "(" +
|
||||
argumentsStr + ")" + " for behavior \"" + behaviorName + "\"" +
|
||||
@@ -1351,42 +1432,47 @@ gd::String EventsCodeGenerator::GenerateArgumentsList(
|
||||
return argumentsStr;
|
||||
}
|
||||
|
||||
gd::String EventsCodeGenerator::GeneratePropertyGetter(const gd::PropertiesContainer& propertiesContainer,
|
||||
const gd::NamedPropertyDescriptor& property,
|
||||
const gd::String& type,
|
||||
gd::EventsCodeGenerationContext& context) {
|
||||
gd::String EventsCodeGenerator::GeneratePropertyGetter(
|
||||
const gd::PropertiesContainer& propertiesContainer,
|
||||
const gd::NamedPropertyDescriptor& property,
|
||||
const gd::String& type,
|
||||
gd::EventsCodeGenerationContext& context) {
|
||||
return "getProperty" + property.GetName() + "As" + type + "()";
|
||||
}
|
||||
|
||||
gd::String EventsCodeGenerator::GeneratePropertyGetterWithoutCasting(
|
||||
const gd::PropertiesContainer &propertiesContainer,
|
||||
const gd::NamedPropertyDescriptor &property) {
|
||||
const gd::PropertiesContainer& propertiesContainer,
|
||||
const gd::NamedPropertyDescriptor& property) {
|
||||
return "getProperty" + property.GetName() + "()";
|
||||
}
|
||||
|
||||
gd::String EventsCodeGenerator::GeneratePropertySetterWithoutCasting(
|
||||
const gd::PropertiesContainer &propertiesContainer,
|
||||
const gd::NamedPropertyDescriptor &property,
|
||||
const gd::String &operandCode) {
|
||||
const gd::PropertiesContainer& propertiesContainer,
|
||||
const gd::NamedPropertyDescriptor& property,
|
||||
const gd::String& operandCode) {
|
||||
return "setProperty" + property.GetName() + "(" + operandCode + ")";
|
||||
}
|
||||
}
|
||||
|
||||
gd::String EventsCodeGenerator::GenerateParameterGetter(const gd::ParameterMetadata& parameter,
|
||||
const gd::String& type,
|
||||
gd::EventsCodeGenerationContext& context) {
|
||||
gd::String EventsCodeGenerator::GenerateParameterGetter(
|
||||
const gd::ParameterMetadata& parameter,
|
||||
const gd::String& type,
|
||||
gd::EventsCodeGenerationContext& context) {
|
||||
return "getParameter" + parameter.GetName() + "As" + type + "()";
|
||||
}
|
||||
|
||||
gd::String EventsCodeGenerator::GenerateParameterGetterWithoutCasting(
|
||||
const gd::ParameterMetadata ¶meter) {
|
||||
return "getParameter" + parameter.GetName() + "()";
|
||||
}
|
||||
const gd::ParameterMetadata& parameter) {
|
||||
return "getParameter" + parameter.GetName() + "()";
|
||||
}
|
||||
|
||||
EventsCodeGenerator::EventsCodeGenerator(const gd::Project& project_,
|
||||
const gd::Layout& layout,
|
||||
const gd::Platform& platform_)
|
||||
: platform(platform_),
|
||||
projectScopedContainers(gd::ProjectScopedContainers::MakeNewProjectScopedContainersForProjectAndLayout(project_, layout)),
|
||||
projectScopedContainers(
|
||||
gd::ProjectScopedContainers::
|
||||
MakeNewProjectScopedContainersForProjectAndLayout(project_,
|
||||
layout)),
|
||||
hasProjectAndLayout(true),
|
||||
project(&project_),
|
||||
scene(&layout),
|
||||
@@ -1395,7 +1481,7 @@ EventsCodeGenerator::EventsCodeGenerator(const gd::Project& project_,
|
||||
maxCustomConditionsDepth(0),
|
||||
maxConditionsListsSize(0),
|
||||
eventsListNextUniqueId(0),
|
||||
diagnosticReport(nullptr){};
|
||||
diagnosticReport(nullptr) {};
|
||||
|
||||
EventsCodeGenerator::EventsCodeGenerator(
|
||||
const gd::Platform& platform_,
|
||||
@@ -1410,6 +1496,6 @@ EventsCodeGenerator::EventsCodeGenerator(
|
||||
maxCustomConditionsDepth(0),
|
||||
maxConditionsListsSize(0),
|
||||
eventsListNextUniqueId(0),
|
||||
diagnosticReport(nullptr){};
|
||||
diagnosticReport(nullptr) {};
|
||||
|
||||
} // namespace gd
|
||||
|
@@ -9,9 +9,9 @@
|
||||
#include <utility>
|
||||
#include <vector>
|
||||
|
||||
#include "GDCore/Events/CodeGeneration/DiagnosticReport.h"
|
||||
#include "GDCore/Events/Event.h"
|
||||
#include "GDCore/Events/Instruction.h"
|
||||
#include "GDCore/Events/CodeGeneration/DiagnosticReport.h"
|
||||
#include "GDCore/Project/ProjectScopedContainers.h"
|
||||
#include "GDCore/String.h"
|
||||
|
||||
@@ -62,7 +62,7 @@ class GD_CORE_API EventsCodeGenerator {
|
||||
EventsCodeGenerator(
|
||||
const gd::Platform& platform,
|
||||
const gd::ProjectScopedContainers& projectScopedContainers_);
|
||||
virtual ~EventsCodeGenerator(){};
|
||||
virtual ~EventsCodeGenerator() {};
|
||||
|
||||
/**
|
||||
* \brief Preprocess an events list (replacing for example links with the
|
||||
@@ -160,7 +160,8 @@ class GD_CORE_API EventsCodeGenerator {
|
||||
gd::String GenerateActionCode(
|
||||
gd::Instruction& action,
|
||||
EventsCodeGenerationContext& context,
|
||||
const gd::String& optionalAsyncCallbackName = "");
|
||||
const gd::String& optionalAsyncCallbackName = "",
|
||||
const gd::String& optionalAsyncCallbackId = "");
|
||||
|
||||
struct CallbackDescriptor {
|
||||
CallbackDescriptor(const gd::String functionName_,
|
||||
@@ -168,7 +169,7 @@ class GD_CORE_API EventsCodeGenerator {
|
||||
const std::set<gd::String> requiredObjects_)
|
||||
: functionName(functionName_),
|
||||
argumentsList(argumentsList_),
|
||||
requiredObjects(requiredObjects_){};
|
||||
requiredObjects(requiredObjects_) {};
|
||||
/**
|
||||
* The name by which the function can be invoked.
|
||||
*/
|
||||
@@ -338,9 +339,9 @@ class GD_CORE_API EventsCodeGenerator {
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief Give access to the project scoped containers as code generation might
|
||||
* push and pop variable containers (for local variables).
|
||||
* This could be passed as a parameter recursively in code generation, but this requires
|
||||
* @brief Give access to the project scoped containers as code generation
|
||||
* might push and pop variable containers (for local variables). This could be
|
||||
* passed as a parameter recursively in code generation, but this requires
|
||||
* heavy refactoring. Instead, we use this single instance.
|
||||
*/
|
||||
gd::ProjectScopedContainers& GetProjectScopedContainers() {
|
||||
@@ -387,9 +388,7 @@ class GD_CORE_API EventsCodeGenerator {
|
||||
diagnosticReport = diagnosticReport_;
|
||||
}
|
||||
|
||||
gd::DiagnosticReport* GetDiagnosticReport() {
|
||||
return diagnosticReport;
|
||||
}
|
||||
gd::DiagnosticReport* GetDiagnosticReport() { return diagnosticReport; }
|
||||
|
||||
/**
|
||||
* \brief Generate the full name for accessing to a boolean variable used for
|
||||
@@ -513,16 +512,16 @@ class GD_CORE_API EventsCodeGenerator {
|
||||
* \brief Generate an any variable getter that fallbacks on scene variable for
|
||||
* compatibility reason.
|
||||
*/
|
||||
gd::String
|
||||
GenerateAnyOrSceneVariableGetter(const gd::Expression &variableExpression,
|
||||
EventsCodeGenerationContext &context);
|
||||
gd::String GenerateAnyOrSceneVariableGetter(
|
||||
const gd::Expression& variableExpression,
|
||||
EventsCodeGenerationContext& context);
|
||||
|
||||
virtual gd::String GeneratePropertySetterWithoutCasting(
|
||||
const gd::PropertiesContainer &propertiesContainer,
|
||||
const gd::NamedPropertyDescriptor &property,
|
||||
const gd::String &operandCode);
|
||||
const gd::PropertiesContainer& propertiesContainer,
|
||||
const gd::NamedPropertyDescriptor& property,
|
||||
const gd::String& operandCode);
|
||||
|
||||
protected:
|
||||
protected:
|
||||
virtual const gd::String GenerateRelationalOperatorCodes(
|
||||
const gd::String& operatorString);
|
||||
|
||||
@@ -643,16 +642,16 @@ protected:
|
||||
gd::EventsCodeGenerationContext& context);
|
||||
|
||||
virtual gd::String GeneratePropertyGetterWithoutCasting(
|
||||
const gd::PropertiesContainer &propertiesContainer,
|
||||
const gd::NamedPropertyDescriptor &property);
|
||||
const gd::PropertiesContainer& propertiesContainer,
|
||||
const gd::NamedPropertyDescriptor& property);
|
||||
|
||||
virtual gd::String GenerateParameterGetter(
|
||||
const gd::ParameterMetadata& parameter,
|
||||
const gd::String& type,
|
||||
gd::EventsCodeGenerationContext& context);
|
||||
|
||||
virtual gd::String
|
||||
GenerateParameterGetterWithoutCasting(const gd::ParameterMetadata ¶meter);
|
||||
virtual gd::String GenerateParameterGetterWithoutCasting(
|
||||
const gd::ParameterMetadata& parameter);
|
||||
|
||||
/**
|
||||
* \brief Generate the code to reference an object which is
|
||||
@@ -769,7 +768,8 @@ protected:
|
||||
const std::vector<gd::String>& arguments,
|
||||
const gd::InstructionMetadata& instrInfos,
|
||||
gd::EventsCodeGenerationContext& context,
|
||||
const gd::String& optionalAsyncCallbackName = "");
|
||||
const gd::String& optionalAsyncCallbackName = "",
|
||||
const gd::String& optionalAsyncCallbackId = "");
|
||||
|
||||
virtual gd::String GenerateObjectAction(
|
||||
const gd::String& objectName,
|
||||
@@ -778,7 +778,8 @@ protected:
|
||||
const std::vector<gd::String>& arguments,
|
||||
const gd::InstructionMetadata& instrInfos,
|
||||
gd::EventsCodeGenerationContext& context,
|
||||
const gd::String& optionalAsyncCallbackName = "");
|
||||
const gd::String& optionalAsyncCallbackName = "",
|
||||
const gd::String& optionalAsyncCallbackId = "");
|
||||
|
||||
virtual gd::String GenerateBehaviorAction(
|
||||
const gd::String& objectName,
|
||||
@@ -788,7 +789,8 @@ protected:
|
||||
const std::vector<gd::String>& arguments,
|
||||
const gd::InstructionMetadata& instrInfos,
|
||||
gd::EventsCodeGenerationContext& context,
|
||||
const gd::String& optionalAsyncCallbackName = "");
|
||||
const gd::String& optionalAsyncCallbackName = "",
|
||||
const gd::String& optionalAsyncCallbackId = "");
|
||||
|
||||
gd::String GenerateRelationalOperatorCall(
|
||||
const gd::InstructionMetadata& instrInfos,
|
||||
@@ -837,9 +839,8 @@ protected:
|
||||
virtual gd::String GenerateGetBehaviorNameCode(
|
||||
const gd::String& behaviorName);
|
||||
|
||||
void CheckBehaviorParameters(
|
||||
const gd::Instruction &instruction,
|
||||
const gd::InstructionMetadata &instrInfos);
|
||||
bool CheckBehaviorParameters(const gd::Instruction& instruction,
|
||||
const gd::InstructionMetadata& instrInfos);
|
||||
|
||||
const gd::Platform& platform; ///< The platform being used.
|
||||
|
||||
@@ -876,4 +877,3 @@ protected:
|
||||
};
|
||||
|
||||
} // namespace gd
|
||||
|
||||
|
@@ -293,6 +293,25 @@ void GD_CORE_API BuiltinExtensionsImplementer::ImplementsBaseObjectExtension(
|
||||
.AddCodeOnlyParameter("currentScene", "")
|
||||
.MarkAsAdvanced();
|
||||
|
||||
obj.AddAction(
|
||||
"RotateTowardObject",
|
||||
_("Rotate toward another object"),
|
||||
_("Rotate an object towards another object, with the specified speed. "
|
||||
"Note that if multiple instances of the target object are picked, "
|
||||
"only the first one will be used. Use a For Each event or actions "
|
||||
"like \"Pick nearest object\", \"Pick a random object\" to refine "
|
||||
"the choice of the target object."),
|
||||
_("Rotate _PARAM0_ towards _PARAM1_ at speed _PARAM2_ deg/second"),
|
||||
_("Angle"),
|
||||
"res/actions/rotate24_black.png",
|
||||
"res/actions/rotate_black.png")
|
||||
.AddParameter("object", _("Object"))
|
||||
.AddParameter("objectPtr", _("Target object"))
|
||||
.AddParameter("expression", _("Angular speed (in degrees per second)"))
|
||||
.SetParameterLongDescription(_("Enter 0 for an immediate rotation."))
|
||||
.AddCodeOnlyParameter("currentScene", "")
|
||||
.MarkAsAdvanced();
|
||||
|
||||
obj.AddAction(
|
||||
"AddForceXY",
|
||||
_("Add a force"),
|
||||
@@ -1617,7 +1636,7 @@ void GD_CORE_API BuiltinExtensionsImplementer::ImplementsBaseObjectExtension(
|
||||
|
||||
extension
|
||||
.AddAction("AjoutObjConcern",
|
||||
_("Pick all instances"),
|
||||
_("Pick all object instances"),
|
||||
_("Pick all instances of the specified object(s). When you "
|
||||
"pick all instances, "
|
||||
"the next conditions and actions of this event work on all "
|
||||
@@ -1631,20 +1650,34 @@ void GD_CORE_API BuiltinExtensionsImplementer::ImplementsBaseObjectExtension(
|
||||
.MarkAsAdvanced();
|
||||
|
||||
extension
|
||||
.AddAction(
|
||||
"AjoutHasard",
|
||||
_("Pick a random object"),
|
||||
_("Pick one object from all the specified objects. When an object "
|
||||
"is picked, the next conditions and actions of this event work "
|
||||
"only on that object."),
|
||||
_("Pick a random _PARAM1_"),
|
||||
_("Objects"),
|
||||
"res/actions/ajouthasard24.png",
|
||||
"res/actions/ajouthasard.png")
|
||||
.AddAction("AjoutHasard",
|
||||
_("Pick a random object"),
|
||||
_("Pick one instance from all the specified objects. When an "
|
||||
"instance is picked, the next conditions and actions of "
|
||||
"this event work only on that object instance."),
|
||||
_("Pick a random _PARAM1_"),
|
||||
_("Objects"),
|
||||
"res/actions/ajouthasard24.png",
|
||||
"res/actions/ajouthasard.png")
|
||||
.AddCodeOnlyParameter("objectsContext", "")
|
||||
.AddParameter("objectList", _("Object"))
|
||||
.MarkAsSimple();
|
||||
|
||||
extension
|
||||
.AddAction(
|
||||
"PickNearest",
|
||||
_("Pick nearest object"),
|
||||
_("Pick the instance of this object that is nearest to the specified "
|
||||
"position."),
|
||||
_("Pick the _PARAM0_ that is nearest to _PARAM1_;_PARAM2_"),
|
||||
_("Objects"),
|
||||
"res/conditions/distance24.png",
|
||||
"res/conditions/distance.png")
|
||||
.AddParameter("objectList", _("Object"))
|
||||
.AddParameter("expression", _("X position"))
|
||||
.AddParameter("expression", _("Y position"))
|
||||
.MarkAsSimple();
|
||||
|
||||
extension
|
||||
.AddAction(
|
||||
"MoveObjects",
|
||||
@@ -1694,11 +1727,12 @@ void GD_CORE_API BuiltinExtensionsImplementer::ImplementsBaseObjectExtension(
|
||||
extension
|
||||
.AddCondition(
|
||||
"AjoutObjConcern",
|
||||
_("Pick all objects"),
|
||||
_("Pick all the specified objects. When you pick all objects, "
|
||||
_("Pick all object instances"),
|
||||
_("Pick all instances of the specified object(s). When you "
|
||||
"pick all instances, "
|
||||
"the next conditions and actions of this event work on all "
|
||||
"of them."),
|
||||
_("Pick all _PARAM1_ objects"),
|
||||
_("Pick all instances of _PARAM1_"),
|
||||
_("Objects"),
|
||||
"res/conditions/add24.png",
|
||||
"res/conditions/add.png")
|
||||
@@ -1707,16 +1741,15 @@ void GD_CORE_API BuiltinExtensionsImplementer::ImplementsBaseObjectExtension(
|
||||
.MarkAsAdvanced();
|
||||
|
||||
extension
|
||||
.AddCondition(
|
||||
"AjoutHasard",
|
||||
_("Pick a random object"),
|
||||
_("Pick one object from all the specified objects. When an object "
|
||||
"is picked, the next conditions and actions of this event work "
|
||||
"only on that object."),
|
||||
_("Pick a random _PARAM1_"),
|
||||
_("Objects"),
|
||||
"res/conditions/ajouthasard24.png",
|
||||
"res/conditions/ajouthasard.png")
|
||||
.AddCondition("AjoutHasard",
|
||||
_("Pick a random object"),
|
||||
_("Pick one instance from all the specified objects. When "
|
||||
"an instance is picked, the next conditions and actions "
|
||||
"of this event work only on that object instance."),
|
||||
_("Pick a random _PARAM1_"),
|
||||
_("Objects"),
|
||||
"res/conditions/ajouthasard24.png",
|
||||
"res/conditions/ajouthasard.png")
|
||||
.AddCodeOnlyParameter("objectsContext", "")
|
||||
.AddParameter("objectList", _("Object"))
|
||||
.MarkAsSimple();
|
||||
@@ -1725,9 +1758,9 @@ void GD_CORE_API BuiltinExtensionsImplementer::ImplementsBaseObjectExtension(
|
||||
.AddCondition(
|
||||
"PickNearest",
|
||||
_("Pick nearest object"),
|
||||
_("Pick the object of this type that is nearest to the specified "
|
||||
"position. If the condition is inverted, the object farthest from "
|
||||
"the specified position is picked instead."),
|
||||
_("Pick the instance of this object that is nearest to the specified "
|
||||
"position. If the condition is inverted, the instance farthest "
|
||||
"from the specified position is picked instead."),
|
||||
_("Pick the _PARAM0_ that is nearest to _PARAM1_;_PARAM2_"),
|
||||
_("Objects"),
|
||||
"res/conditions/distance24.png",
|
||||
|
@@ -42,13 +42,17 @@ void GD_CORE_API BuiltinExtensionsImplementer::ImplementsFileExtension(
|
||||
extension
|
||||
.AddAction(
|
||||
"LoadFile",
|
||||
_("Load a storage in memory"),
|
||||
_("This action loads the specified storage in memory, so you can "
|
||||
"write and read it.\nYou can open and write without using this "
|
||||
"action, but it will be slower.\nIf you use this action, do not "
|
||||
"forget to unload the storage from memory."),
|
||||
_("Load storage _PARAM0_ in memory"),
|
||||
"",
|
||||
_("Manually preload a storage in memory"),
|
||||
_("Forces the specified storage to be loaded and kept in "
|
||||
"memory, allowing faster reads/writes. "
|
||||
"However, it requires manual management: if you use this "
|
||||
"action, you *must* also unload the storage manually when "
|
||||
"it's no longer needed to ensure data is persisted.\n\n"
|
||||
"Unless you have a specific performance need, avoid using this "
|
||||
"action. The system already handles loading/unloading "
|
||||
"automatically."),
|
||||
_("Load data storage _PARAM0_ in memory"),
|
||||
_("Advanced"),
|
||||
"res/actions/fichier24.png",
|
||||
"res/actions/fichier.png")
|
||||
.AddParameter("string", _("Storage name"))
|
||||
@@ -56,11 +60,11 @@ void GD_CORE_API BuiltinExtensionsImplementer::ImplementsFileExtension(
|
||||
|
||||
extension
|
||||
.AddAction("UnloadFile",
|
||||
_("Close a storage"),
|
||||
_("This action closes the structured data previously loaded "
|
||||
_("Manually unload and persist a storage"),
|
||||
_("Close the specified storage previously loaded "
|
||||
"in memory, saving all changes made."),
|
||||
_("Close structured data _PARAM0_"),
|
||||
"",
|
||||
_("Unload and persist data storage _PARAM0_"),
|
||||
_("Advanced"),
|
||||
"res/actions/fichier24.png",
|
||||
"res/actions/fichier.png")
|
||||
.AddParameter("string", _("Storage name"))
|
||||
|
@@ -194,7 +194,8 @@ void ParameterMetadataTools::IterateOverParameters(
|
||||
[&fn](const gd::ParameterMetadata& parameterMetadata,
|
||||
const gd::Expression& parameterValue,
|
||||
size_t parameterIndex,
|
||||
const gd::String& lastObjectName) {
|
||||
const gd::String& lastObjectName,
|
||||
size_t lastObjectIndex) {
|
||||
fn(parameterMetadata, parameterValue, lastObjectName);
|
||||
});
|
||||
}
|
||||
@@ -205,8 +206,10 @@ void ParameterMetadataTools::IterateOverParametersWithIndex(
|
||||
std::function<void(const gd::ParameterMetadata& parameterMetadata,
|
||||
const gd::Expression& parameterValue,
|
||||
size_t parameterIndex,
|
||||
const gd::String& lastObjectName)> fn) {
|
||||
const gd::String& lastObjectName,
|
||||
size_t lastObjectIndex)> fn) {
|
||||
gd::String lastObjectName = "";
|
||||
size_t lastObjectIndex = 0;
|
||||
for (std::size_t pNb = 0; pNb < parametersMetadata.GetParametersCount();
|
||||
++pNb) {
|
||||
const gd::ParameterMetadata ¶meterMetadata =
|
||||
@@ -218,15 +221,17 @@ void ParameterMetadataTools::IterateOverParametersWithIndex(
|
||||
? Expression(parameterMetadata.GetDefaultValue())
|
||||
: parameterValue;
|
||||
|
||||
fn(parameterMetadata, parameterValueOrDefault, pNb, lastObjectName);
|
||||
fn(parameterMetadata, parameterValueOrDefault, pNb, lastObjectName, lastObjectIndex);
|
||||
|
||||
// Memorize the last object name. By convention, parameters that require
|
||||
// an object (mainly, "objectvar" and "behavior") should be placed after
|
||||
// the object in the list of parameters (if possible, just after).
|
||||
// Search "lastObjectName" in the codebase for other place where this
|
||||
// convention is enforced.
|
||||
if (gd::ParameterMetadata::IsObject(parameterMetadata.GetType()))
|
||||
if (gd::ParameterMetadata::IsObject(parameterMetadata.GetType())) {
|
||||
lastObjectName = parameterValueOrDefault.GetPlainString();
|
||||
lastObjectIndex = pNb;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
|
@@ -64,7 +64,8 @@ class GD_CORE_API ParameterMetadataTools {
|
||||
std::function<void(const gd::ParameterMetadata& parameterMetadata,
|
||||
const gd::Expression& parameterValue,
|
||||
size_t parameterIndex,
|
||||
const gd::String& lastObjectName)> fn);
|
||||
const gd::String& lastObjectName,
|
||||
size_t lastObjectIndex)> fn);
|
||||
|
||||
/**
|
||||
* Iterate over the parameters of a FunctionCallNode.
|
||||
|
@@ -29,7 +29,7 @@ bool BehaviorParametersFiller::DoVisitInstruction(gd::Instruction &instruction,
|
||||
instruction.GetParameters(), metadata.GetParameters(),
|
||||
[&](const gd::ParameterMetadata ¶meterMetadata,
|
||||
const gd::Expression ¶meterValue, size_t parameterIndex,
|
||||
const gd::String &lastObjectName) {
|
||||
const gd::String &lastObjectName, size_t lastObjectIndex) {
|
||||
if (parameterMetadata.GetValueTypeMetadata().IsBehavior() &&
|
||||
parameterValue.GetPlainString().length() == 0) {
|
||||
|
||||
|
@@ -108,12 +108,10 @@ bool EventsBehaviorRenamer::DoVisitInstruction(gd::Instruction& instruction,
|
||||
platform, instruction.GetType());
|
||||
|
||||
gd::ParameterMetadataTools::IterateOverParametersWithIndex(
|
||||
instruction.GetParameters(),
|
||||
metadata.GetParameters(),
|
||||
[&](const gd::ParameterMetadata& parameterMetadata,
|
||||
const gd::Expression& parameterValue,
|
||||
size_t parameterIndex,
|
||||
const gd::String& lastObjectName) {
|
||||
instruction.GetParameters(), metadata.GetParameters(),
|
||||
[&](const gd::ParameterMetadata ¶meterMetadata,
|
||||
const gd::Expression ¶meterValue, size_t parameterIndex,
|
||||
const gd::String &lastObjectName, size_t lastObjectIndex) {
|
||||
const gd::String& type = parameterMetadata.GetType();
|
||||
|
||||
if (gd::ParameterMetadata::IsBehavior(type)) {
|
||||
|
@@ -183,12 +183,10 @@ bool EventsParameterReplacer::DoVisitInstruction(gd::Instruction& instruction,
|
||||
platform, instruction.GetType());
|
||||
|
||||
gd::ParameterMetadataTools::IterateOverParametersWithIndex(
|
||||
instruction.GetParameters(),
|
||||
metadata.GetParameters(),
|
||||
[&](const gd::ParameterMetadata& parameterMetadata,
|
||||
const gd::Expression& parameterValue,
|
||||
size_t parameterIndex,
|
||||
const gd::String& lastObjectName) {
|
||||
instruction.GetParameters(), metadata.GetParameters(),
|
||||
[&](const gd::ParameterMetadata ¶meterMetadata,
|
||||
const gd::Expression ¶meterValue, size_t parameterIndex,
|
||||
const gd::String &lastObjectName, size_t lastObjectIndex) {
|
||||
if (!gd::EventsParameterReplacer::CanContainParameter(
|
||||
parameterMetadata.GetValueTypeMetadata())) {
|
||||
return;
|
||||
|
@@ -217,12 +217,10 @@ bool EventsPropertyReplacer::DoVisitInstruction(gd::Instruction& instruction,
|
||||
bool shouldDeleteInstruction = false;
|
||||
|
||||
gd::ParameterMetadataTools::IterateOverParametersWithIndex(
|
||||
instruction.GetParameters(),
|
||||
metadata.GetParameters(),
|
||||
[&](const gd::ParameterMetadata& parameterMetadata,
|
||||
const gd::Expression& parameterValue,
|
||||
size_t parameterIndex,
|
||||
const gd::String& lastObjectName) {
|
||||
instruction.GetParameters(), metadata.GetParameters(),
|
||||
[&](const gd::ParameterMetadata ¶meterMetadata,
|
||||
const gd::Expression ¶meterValue, size_t parameterIndex,
|
||||
const gd::String &lastObjectName, size_t lastObjectIndex) {
|
||||
if (!gd::EventsPropertyReplacer::CanContainProperty(
|
||||
parameterMetadata.GetValueTypeMetadata())) {
|
||||
return;
|
||||
|
@@ -334,7 +334,7 @@ private:
|
||||
instruction.GetParameters(), metadata.GetParameters(),
|
||||
[&](const gd::ParameterMetadata ¶meterMetadata,
|
||||
const gd::Expression ¶meterValue, size_t parameterIndex,
|
||||
const gd::String &lastObjectName) {
|
||||
const gd::String &lastObjectName, size_t lastObjectIndex) {
|
||||
if (!gd::EventsObjectReplacer::CanContainObject(
|
||||
parameterMetadata.GetValueTypeMetadata())) {
|
||||
return;
|
||||
|
@@ -42,18 +42,16 @@ bool EventsVariableInstructionTypeSwitcher::DoVisitInstruction(gd::Instruction&
|
||||
platform, instruction.GetType());
|
||||
|
||||
gd::ParameterMetadataTools::IterateOverParametersWithIndex(
|
||||
instruction.GetParameters(),
|
||||
metadata.GetParameters(),
|
||||
[&](const gd::ParameterMetadata& parameterMetadata,
|
||||
const gd::Expression& parameterValue,
|
||||
size_t parameterIndex,
|
||||
const gd::String& lastObjectName) {
|
||||
instruction.GetParameters(), metadata.GetParameters(),
|
||||
[&](const gd::ParameterMetadata ¶meterMetadata,
|
||||
const gd::Expression ¶meterValue, size_t parameterIndex,
|
||||
const gd::String &lastObjectName, size_t lastObjectIndex) {
|
||||
const gd::String& type = parameterMetadata.GetType();
|
||||
|
||||
if (!gd::ParameterMetadata::IsExpression("variable", type) ||
|
||||
!gd::VariableInstructionSwitcher::IsSwitchableVariableInstruction(
|
||||
instruction.GetType())) {
|
||||
return;
|
||||
return;
|
||||
}
|
||||
const auto variableName =
|
||||
gd::ExpressionVariableNameFinder::GetVariableName(
|
||||
@@ -72,10 +70,11 @@ bool EventsVariableInstructionTypeSwitcher::DoVisitInstruction(gd::Instruction&
|
||||
.GetObjectOrGroupVariablesContainer(lastObjectName);
|
||||
}
|
||||
} else if (type == "variableOrProperty") {
|
||||
variablesContainer =
|
||||
&GetProjectScopedContainers()
|
||||
.GetVariablesContainersList()
|
||||
.GetVariablesContainerFromVariableOrPropertyName(variableName);
|
||||
variablesContainer =
|
||||
&GetProjectScopedContainers()
|
||||
.GetVariablesContainersList()
|
||||
.GetVariablesContainerFromVariableOrPropertyName(
|
||||
variableName);
|
||||
} else {
|
||||
if (GetProjectScopedContainers().GetVariablesContainersList().Has(
|
||||
variableName)) {
|
||||
|
@@ -448,12 +448,10 @@ bool EventsVariableReplacer::DoVisitInstruction(gd::Instruction& instruction,
|
||||
bool shouldDeleteInstruction = false;
|
||||
|
||||
gd::ParameterMetadataTools::IterateOverParametersWithIndex(
|
||||
instruction.GetParameters(),
|
||||
metadata.GetParameters(),
|
||||
[&](const gd::ParameterMetadata& parameterMetadata,
|
||||
const gd::Expression& parameterValue,
|
||||
size_t parameterIndex,
|
||||
const gd::String& lastObjectName) {
|
||||
instruction.GetParameters(), metadata.GetParameters(),
|
||||
[&](const gd::ParameterMetadata ¶meterMetadata,
|
||||
const gd::Expression ¶meterValue, size_t parameterIndex,
|
||||
const gd::String &lastObjectName, size_t lastObjectIndex) {
|
||||
const gd::String& type = parameterMetadata.GetType();
|
||||
|
||||
if (!gd::ParameterMetadata::IsExpression("variable", type) &&
|
||||
|
@@ -150,7 +150,7 @@ bool ProjectElementRenamer::DoVisitInstruction(gd::Instruction &instruction,
|
||||
instruction.GetParameters(), metadata.GetParameters(),
|
||||
[&](const gd::ParameterMetadata ¶meterMetadata,
|
||||
const gd::Expression ¶meterValue, size_t parameterIndex,
|
||||
const gd::String &lastObjectName) {
|
||||
const gd::String &lastObjectName, size_t lastObjectIndex) {
|
||||
if (parameterMetadata.GetType() == "layer") {
|
||||
if (parameterValue.GetPlainString().length() < 2) {
|
||||
// This is either the base layer or an invalid layer name.
|
||||
|
@@ -227,12 +227,11 @@ bool ResourceWorkerInEventsWorker::DoVisitInstruction(gd::Instruction& instructi
|
||||
platform, instruction.GetType());
|
||||
|
||||
gd::ParameterMetadataTools::IterateOverParametersWithIndex(
|
||||
instruction.GetParameters(),
|
||||
metadata.GetParameters(),
|
||||
[this, &instruction](const gd::ParameterMetadata& parameterMetadata,
|
||||
const gd::Expression& parameterExpression,
|
||||
size_t parameterIndex,
|
||||
const gd::String& lastObjectName) {
|
||||
instruction.GetParameters(), metadata.GetParameters(),
|
||||
[this, &instruction](
|
||||
const gd::ParameterMetadata ¶meterMetadata,
|
||||
const gd::Expression ¶meterExpression, size_t parameterIndex,
|
||||
const gd::String &lastObjectName, size_t lastObjectIndex) {
|
||||
const String& parameterValue = parameterExpression.GetPlainString();
|
||||
if (parameterMetadata.GetType() == "fontResource") {
|
||||
gd::String updatedParameterValue = parameterValue;
|
||||
|
@@ -37,6 +37,7 @@ void EventsBasedObjectVariant::SerializeTo(SerializerElement &element) const {
|
||||
|
||||
layers.SerializeLayersTo(element.AddChild("layers"));
|
||||
initialInstances.SerializeTo(element.AddChild("instances"));
|
||||
editorSettings.SerializeTo(element.AddChild("editionSettings"));
|
||||
}
|
||||
|
||||
void EventsBasedObjectVariant::UnserializeFrom(
|
||||
@@ -66,6 +67,7 @@ void EventsBasedObjectVariant::UnserializeFrom(
|
||||
layers.Reset();
|
||||
}
|
||||
initialInstances.UnserializeFrom(element.GetChild("instances"));
|
||||
editorSettings.UnserializeFrom(element.GetChild("editionSettings"));
|
||||
}
|
||||
|
||||
} // namespace gd
|
||||
|
@@ -5,6 +5,7 @@
|
||||
*/
|
||||
#pragma once
|
||||
|
||||
#include "GDCore/IDE/Dialogs/LayoutEditorCanvas/EditorSettings.h"
|
||||
#include "GDCore/Project/InitialInstancesContainer.h"
|
||||
#include "GDCore/Project/LayersContainer.h"
|
||||
#include "GDCore/Project/ObjectsContainer.h"
|
||||
@@ -199,6 +200,19 @@ public:
|
||||
const gd::String &GetAssetStoreOriginalName() const {
|
||||
return assetStoreOriginalName;
|
||||
};
|
||||
|
||||
/**
|
||||
*
|
||||
* \brief Get the user settings for the IDE.
|
||||
*/
|
||||
const gd::EditorSettings& GetAssociatedEditorSettings() const {
|
||||
return editorSettings;
|
||||
}
|
||||
|
||||
/**
|
||||
* \brief Get the user settings for the IDE.
|
||||
*/
|
||||
gd::EditorSettings& GetAssociatedEditorSettings() { return editorSettings; }
|
||||
|
||||
void SerializeTo(SerializerElement &element) const;
|
||||
|
||||
@@ -224,6 +238,7 @@ private:
|
||||
* store.
|
||||
*/
|
||||
gd::String assetStoreOriginalName;
|
||||
gd::EditorSettings editorSettings;
|
||||
};
|
||||
|
||||
} // namespace gd
|
||||
|
@@ -24,7 +24,7 @@ The rest of this page is an introduction to the main concepts of GDevelop archit
|
||||
|
||||
Extensions do have the same distinction between the "**IDE**" part and the "**Runtime**" part. For example, most extensions have:
|
||||
|
||||
- A file called [`JsExtension.js`(https://github.com/4ian/GDevelop/blob/master/Extensions/ExampleJsExtension/JsExtension.js)], which contains the _declaration_ of the extension for the **IDE**
|
||||
- A file called [`JsExtension.js`](https://github.com/4ian/GDevelop/blob/master/Extensions/ExampleJsExtension/JsExtension.js), which contains the _declaration_ of the extension for the **IDE**
|
||||
- One or more files implementing the feature for the game, in other words for **Runtime**. This can be a [Runtime Object](https://github.com/4ian/GDevelop/blob/master/Extensions/ExampleJsExtension/dummyruntimeobject.ts) or a [Runtime Behavior](https://github.com/4ian/GDevelop/blob/master/Extensions/ExampleJsExtension/dummyruntimebehavior.ts), [functions called by actions or conditions](https://github.com/4ian/GDevelop/blob/master/Extensions/ExampleJsExtension/examplejsextensiontools.ts) or by the game engine.
|
||||
|
||||
### "Runtime" and "IDE" difference using an example: the `gd::Variable` class
|
||||
|
@@ -97,6 +97,14 @@ namespace gdjs {
|
||||
oldObjectData: Object3DData,
|
||||
newObjectData: Object3DData
|
||||
): boolean {
|
||||
this.updateOriginalDimensionsFromObjectData(oldObjectData, newObjectData);
|
||||
return true;
|
||||
}
|
||||
|
||||
updateOriginalDimensionsFromObjectData(
|
||||
oldObjectData: Object3DData,
|
||||
newObjectData: Object3DData
|
||||
): void {
|
||||
// There is no need to check if they changed because events can't modify them.
|
||||
this._setOriginalWidth(
|
||||
getValidDimensionValue(newObjectData.content.width)
|
||||
@@ -107,12 +115,13 @@ namespace gdjs {
|
||||
this._setOriginalDepth(
|
||||
getValidDimensionValue(newObjectData.content.depth)
|
||||
);
|
||||
return true;
|
||||
}
|
||||
|
||||
getNetworkSyncData(): Object3DNetworkSyncData {
|
||||
getNetworkSyncData(
|
||||
syncOptions: GetNetworkSyncDataOptions
|
||||
): Object3DNetworkSyncData {
|
||||
return {
|
||||
...super.getNetworkSyncData(),
|
||||
...super.getNetworkSyncData(syncOptions),
|
||||
z: this.getZ(),
|
||||
d: this.getDepth(),
|
||||
rx: this.getRotationX(),
|
||||
@@ -123,8 +132,11 @@ namespace gdjs {
|
||||
};
|
||||
}
|
||||
|
||||
updateFromNetworkSyncData(networkSyncData: Object3DNetworkSyncData) {
|
||||
super.updateFromNetworkSyncData(networkSyncData);
|
||||
updateFromNetworkSyncData(
|
||||
networkSyncData: Object3DNetworkSyncData,
|
||||
options: UpdateFromNetworkSyncDataOptions
|
||||
) {
|
||||
super.updateFromNetworkSyncData(networkSyncData, options);
|
||||
if (networkSyncData.z !== undefined) this.setZ(networkSyncData.z);
|
||||
if (networkSyncData.d !== undefined) this.setDepth(networkSyncData.d);
|
||||
if (networkSyncData.rx !== undefined)
|
||||
|
@@ -452,9 +452,11 @@ namespace gdjs {
|
||||
return true;
|
||||
}
|
||||
|
||||
getNetworkSyncData(): Cube3DObjectNetworkSyncData {
|
||||
getNetworkSyncData(
|
||||
syncOptions: GetNetworkSyncDataOptions
|
||||
): Cube3DObjectNetworkSyncData {
|
||||
return {
|
||||
...super.getNetworkSyncData(),
|
||||
...super.getNetworkSyncData(syncOptions),
|
||||
mt: this._materialType,
|
||||
fo: this._facesOrientation,
|
||||
bfu: this._backFaceUpThroughWhichAxisRotation,
|
||||
@@ -466,9 +468,10 @@ namespace gdjs {
|
||||
}
|
||||
|
||||
updateFromNetworkSyncData(
|
||||
networkSyncData: Cube3DObjectNetworkSyncData
|
||||
networkSyncData: Cube3DObjectNetworkSyncData,
|
||||
options: UpdateFromNetworkSyncDataOptions
|
||||
): void {
|
||||
super.updateFromNetworkSyncData(networkSyncData);
|
||||
super.updateFromNetworkSyncData(networkSyncData, options);
|
||||
|
||||
if (networkSyncData.mt !== undefined) {
|
||||
this._materialType = networkSyncData.mt;
|
||||
|
@@ -1,12 +1,16 @@
|
||||
namespace gdjs {
|
||||
type CustomObject3DNetworkSyncDataType = CustomObjectNetworkSyncDataType & {
|
||||
type CustomObject3DNetworkSyncDataType = {
|
||||
z: float;
|
||||
d: float;
|
||||
rx: float;
|
||||
ry: float;
|
||||
ifz: boolean;
|
||||
ccz: float;
|
||||
};
|
||||
|
||||
type CustomObject3DNetworkSyncData = CustomObjectNetworkSyncData &
|
||||
CustomObject3DNetworkSyncDataType;
|
||||
|
||||
/**
|
||||
* Base class for 3D custom objects.
|
||||
*/
|
||||
@@ -85,21 +89,25 @@ namespace gdjs {
|
||||
}
|
||||
}
|
||||
|
||||
getNetworkSyncData(): CustomObject3DNetworkSyncDataType {
|
||||
getNetworkSyncData(
|
||||
syncOptions: GetNetworkSyncDataOptions
|
||||
): CustomObject3DNetworkSyncData {
|
||||
return {
|
||||
...super.getNetworkSyncData(),
|
||||
...super.getNetworkSyncData(syncOptions),
|
||||
z: this.getZ(),
|
||||
d: this.getDepth(),
|
||||
rx: this.getRotationX(),
|
||||
ry: this.getRotationY(),
|
||||
ifz: this.isFlippedZ(),
|
||||
ccz: this._customCenterZ,
|
||||
};
|
||||
}
|
||||
|
||||
updateFromNetworkSyncData(
|
||||
networkSyncData: CustomObject3DNetworkSyncDataType
|
||||
networkSyncData: CustomObject3DNetworkSyncData,
|
||||
options: UpdateFromNetworkSyncDataOptions
|
||||
): void {
|
||||
super.updateFromNetworkSyncData(networkSyncData);
|
||||
super.updateFromNetworkSyncData(networkSyncData, options);
|
||||
if (networkSyncData.z !== undefined) this.setZ(networkSyncData.z);
|
||||
if (networkSyncData.d !== undefined) this.setDepth(networkSyncData.d);
|
||||
if (networkSyncData.rx !== undefined)
|
||||
@@ -107,6 +115,8 @@ namespace gdjs {
|
||||
if (networkSyncData.ry !== undefined)
|
||||
this.setRotationY(networkSyncData.ry);
|
||||
if (networkSyncData.ifz !== undefined) this.flipZ(networkSyncData.ifz);
|
||||
if (networkSyncData.ccz !== undefined)
|
||||
this._customCenterZ = networkSyncData.ccz;
|
||||
}
|
||||
|
||||
/**
|
||||
|
@@ -1901,6 +1901,11 @@ module.exports = {
|
||||
.getOrCreate('density')
|
||||
.setValue('0.0012')
|
||||
.setLabel(_('Density'))
|
||||
.setDescription(
|
||||
_(
|
||||
'Density of the fog. Usual values are between 0.0005 (far away) and 0.005 (very thick fog).'
|
||||
)
|
||||
)
|
||||
.setType('number');
|
||||
}
|
||||
{
|
||||
@@ -2063,6 +2068,48 @@ module.exports = {
|
||||
.setType('number')
|
||||
.setGroup(_('Orientation'));
|
||||
}
|
||||
{
|
||||
const effect = extension
|
||||
.addEffect('Skybox')
|
||||
.setFullName(_('Skybox'))
|
||||
.setDescription(
|
||||
_('Display a background on a cube surrounding the scene.')
|
||||
)
|
||||
.markAsNotWorkingForObjects()
|
||||
.markAsOnlyWorkingFor3D()
|
||||
.addIncludeFile('Extensions/3D/Skybox.js');
|
||||
const properties = effect.getProperties();
|
||||
properties
|
||||
.getOrCreate('rightFaceResourceName')
|
||||
.setType('resource')
|
||||
.addExtraInfo('image')
|
||||
.setLabel(_('Right face (X+)'));
|
||||
properties
|
||||
.getOrCreate('leftFaceResourceName')
|
||||
.setType('resource')
|
||||
.addExtraInfo('image')
|
||||
.setLabel(_('Left face (X-)'));
|
||||
properties
|
||||
.getOrCreate('bottomFaceResourceName')
|
||||
.setType('resource')
|
||||
.addExtraInfo('image')
|
||||
.setLabel(_('Bottom face (Y+)'));
|
||||
properties
|
||||
.getOrCreate('topFaceResourceName')
|
||||
.setType('resource')
|
||||
.addExtraInfo('image')
|
||||
.setLabel(_('Top face (Y-)'));
|
||||
properties
|
||||
.getOrCreate('frontFaceResourceName')
|
||||
.setType('resource')
|
||||
.addExtraInfo('image')
|
||||
.setLabel(_('Front face (Z+)'));
|
||||
properties
|
||||
.getOrCreate('backFaceResourceName')
|
||||
.setType('resource')
|
||||
.addExtraInfo('image')
|
||||
.setLabel(_('Back face (Z-)'));
|
||||
}
|
||||
{
|
||||
const effect = extension
|
||||
.addEffect('HueAndSaturation')
|
||||
|
@@ -8,6 +8,7 @@ namespace gdjs {
|
||||
anis: Model3DAnimation[];
|
||||
ai: integer;
|
||||
ass: float;
|
||||
aet: float;
|
||||
ap: boolean;
|
||||
cfd: float;
|
||||
};
|
||||
@@ -152,6 +153,14 @@ namespace gdjs {
|
||||
}
|
||||
}
|
||||
|
||||
override updateOriginalDimensionsFromObjectData(
|
||||
oldObjectData: Object3DData,
|
||||
newObjectData: Object3DData
|
||||
): void {
|
||||
// Original dimensions must not be reset by `super.updateFromObjectData`.
|
||||
// `_updateModel` has a different logic to evaluate them using `keepAspectRatio`.
|
||||
}
|
||||
|
||||
updateFromObjectData(
|
||||
oldObjectData: Model3DObjectData,
|
||||
newObjectData: Model3DObjectData
|
||||
@@ -181,8 +190,14 @@ namespace gdjs {
|
||||
oldObjectData.content.keepAspectRatio !==
|
||||
newObjectData.content.keepAspectRatio ||
|
||||
oldObjectData.content.materialType !==
|
||||
newObjectData.content.materialType
|
||||
newObjectData.content.materialType ||
|
||||
oldObjectData.content.centerLocation !==
|
||||
newObjectData.content.centerLocation
|
||||
) {
|
||||
// The center is applied to the model by `_updateModel`.
|
||||
this._centerPoint = getPointForLocation(
|
||||
newObjectData.content.centerLocation
|
||||
);
|
||||
this._updateModel(newObjectData);
|
||||
}
|
||||
if (
|
||||
@@ -192,14 +207,7 @@ namespace gdjs {
|
||||
this._originPoint = getPointForLocation(
|
||||
newObjectData.content.originLocation
|
||||
);
|
||||
}
|
||||
if (
|
||||
oldObjectData.content.centerLocation !==
|
||||
newObjectData.content.centerLocation
|
||||
) {
|
||||
this._centerPoint = getPointForLocation(
|
||||
newObjectData.content.centerLocation
|
||||
);
|
||||
this._renderer.updatePosition();
|
||||
}
|
||||
if (
|
||||
oldObjectData.content.isCastingShadow !==
|
||||
@@ -216,24 +224,28 @@ namespace gdjs {
|
||||
return true;
|
||||
}
|
||||
|
||||
getNetworkSyncData(): Model3DObjectNetworkSyncData {
|
||||
getNetworkSyncData(
|
||||
syncOptions: GetNetworkSyncDataOptions
|
||||
): Model3DObjectNetworkSyncData {
|
||||
return {
|
||||
...super.getNetworkSyncData(),
|
||||
...super.getNetworkSyncData(syncOptions),
|
||||
mt: this._materialType,
|
||||
op: this._originPoint,
|
||||
cp: this._centerPoint,
|
||||
anis: this._animations,
|
||||
ai: this._currentAnimationIndex,
|
||||
ass: this._animationSpeedScale,
|
||||
aet: this.getAnimationElapsedTime(),
|
||||
ap: this._animationPaused,
|
||||
cfd: this._crossfadeDuration,
|
||||
};
|
||||
}
|
||||
|
||||
updateFromNetworkSyncData(
|
||||
networkSyncData: Model3DObjectNetworkSyncData
|
||||
networkSyncData: Model3DObjectNetworkSyncData,
|
||||
options: UpdateFromNetworkSyncDataOptions
|
||||
): void {
|
||||
super.updateFromNetworkSyncData(networkSyncData);
|
||||
super.updateFromNetworkSyncData(networkSyncData, options);
|
||||
|
||||
if (networkSyncData.mt !== undefined) {
|
||||
this._materialType = networkSyncData.mt;
|
||||
@@ -247,11 +259,14 @@ namespace gdjs {
|
||||
if (networkSyncData.anis !== undefined) {
|
||||
this._animations = networkSyncData.anis;
|
||||
}
|
||||
if (networkSyncData.ass !== undefined) {
|
||||
this.setAnimationSpeedScale(networkSyncData.ass);
|
||||
}
|
||||
if (networkSyncData.ai !== undefined) {
|
||||
this.setAnimationIndex(networkSyncData.ai);
|
||||
}
|
||||
if (networkSyncData.ass !== undefined) {
|
||||
this.setAnimationSpeedScale(networkSyncData.ass);
|
||||
if (networkSyncData.aet !== undefined) {
|
||||
this.setAnimationElapsedTime(networkSyncData.aet);
|
||||
}
|
||||
if (networkSyncData.ap !== undefined) {
|
||||
if (networkSyncData.ap !== this.isAnimationPaused()) {
|
||||
@@ -273,14 +288,17 @@ namespace gdjs {
|
||||
const rotationX = objectData.content.rotationX || 0;
|
||||
const rotationY = objectData.content.rotationY || 0;
|
||||
const rotationZ = objectData.content.rotationZ || 0;
|
||||
const width = objectData.content.width || 100;
|
||||
const height = objectData.content.height || 100;
|
||||
const depth = objectData.content.depth || 100;
|
||||
const keepAspectRatio = objectData.content.keepAspectRatio;
|
||||
this._renderer._updateModel(
|
||||
rotationX,
|
||||
rotationY,
|
||||
rotationZ,
|
||||
this._getOriginalWidth(),
|
||||
this._getOriginalHeight(),
|
||||
this._getOriginalDepth(),
|
||||
width,
|
||||
height,
|
||||
depth,
|
||||
keepAspectRatio
|
||||
);
|
||||
}
|
||||
|
@@ -233,6 +233,10 @@ namespace gdjs {
|
||||
this._object._setOriginalWidth(scaleRatio * modelWidth);
|
||||
this._object._setOriginalHeight(scaleRatio * modelHeight);
|
||||
this._object._setOriginalDepth(scaleRatio * modelDepth);
|
||||
} else {
|
||||
this._object._setOriginalWidth(originalWidth);
|
||||
this._object._setOriginalHeight(originalHeight);
|
||||
this._object._setOriginalDepth(originalDepth);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -286,6 +290,7 @@ namespace gdjs {
|
||||
this.get3DRendererObject().remove(this._threeObject);
|
||||
this.get3DRendererObject().add(threeObject);
|
||||
this._threeObject = threeObject;
|
||||
this.updatePosition();
|
||||
this._updateShadow();
|
||||
|
||||
// Start the current animation on the new 3D object.
|
||||
|
102
Extensions/3D/Skybox.ts
Normal file
102
Extensions/3D/Skybox.ts
Normal file
@@ -0,0 +1,102 @@
|
||||
namespace gdjs {
|
||||
interface SkyboxFilterNetworkSyncData {}
|
||||
gdjs.PixiFiltersTools.registerFilterCreator(
|
||||
'Scene3D::Skybox',
|
||||
new (class implements gdjs.PixiFiltersTools.FilterCreator {
|
||||
makeFilter(
|
||||
target: EffectsTarget,
|
||||
effectData: EffectData
|
||||
): gdjs.PixiFiltersTools.Filter {
|
||||
if (typeof THREE === 'undefined') {
|
||||
return new gdjs.PixiFiltersTools.EmptyFilter();
|
||||
}
|
||||
return new (class implements gdjs.PixiFiltersTools.Filter {
|
||||
_cubeTexture: THREE.CubeTexture;
|
||||
_oldBackground:
|
||||
| THREE.CubeTexture
|
||||
| THREE.Texture
|
||||
| THREE.Color
|
||||
| null = null;
|
||||
_isEnabled: boolean = false;
|
||||
|
||||
constructor() {
|
||||
this._cubeTexture = target
|
||||
.getRuntimeScene()
|
||||
.getGame()
|
||||
.getImageManager()
|
||||
.getThreeCubeTexture(
|
||||
effectData.stringParameters.rightFaceResourceName,
|
||||
effectData.stringParameters.leftFaceResourceName,
|
||||
effectData.stringParameters.topFaceResourceName,
|
||||
effectData.stringParameters.bottomFaceResourceName,
|
||||
effectData.stringParameters.frontFaceResourceName,
|
||||
effectData.stringParameters.backFaceResourceName
|
||||
);
|
||||
}
|
||||
|
||||
isEnabled(target: EffectsTarget): boolean {
|
||||
return this._isEnabled;
|
||||
}
|
||||
setEnabled(target: EffectsTarget, enabled: boolean): boolean {
|
||||
if (this._isEnabled === enabled) {
|
||||
return true;
|
||||
}
|
||||
if (enabled) {
|
||||
return this.applyEffect(target);
|
||||
} else {
|
||||
return this.removeEffect(target);
|
||||
}
|
||||
}
|
||||
applyEffect(target: EffectsTarget): boolean {
|
||||
const scene = target.get3DRendererObject() as
|
||||
| THREE.Scene
|
||||
| null
|
||||
| undefined;
|
||||
if (!scene) {
|
||||
return false;
|
||||
}
|
||||
// TODO Add a background stack in LayerPixiRenderer to allow
|
||||
// filters to stack them.
|
||||
this._oldBackground = scene.background;
|
||||
scene.background = this._cubeTexture;
|
||||
if (!scene.environment) {
|
||||
scene.environment = this._cubeTexture;
|
||||
}
|
||||
this._isEnabled = true;
|
||||
return true;
|
||||
}
|
||||
removeEffect(target: EffectsTarget): boolean {
|
||||
const scene = target.get3DRendererObject() as
|
||||
| THREE.Scene
|
||||
| null
|
||||
| undefined;
|
||||
if (!scene) {
|
||||
return false;
|
||||
}
|
||||
scene.background = this._oldBackground;
|
||||
scene.environment = null;
|
||||
this._isEnabled = false;
|
||||
return true;
|
||||
}
|
||||
updatePreRender(target: gdjs.EffectsTarget): any {}
|
||||
updateDoubleParameter(parameterName: string, value: number): void {}
|
||||
getDoubleParameter(parameterName: string): number {
|
||||
return 0;
|
||||
}
|
||||
updateStringParameter(parameterName: string, value: string): void {}
|
||||
updateColorParameter(parameterName: string, value: number): void {}
|
||||
getColorParameter(parameterName: string): number {
|
||||
return 0;
|
||||
}
|
||||
updateBooleanParameter(parameterName: string, value: boolean): void {}
|
||||
getNetworkSyncData(): SkyboxFilterNetworkSyncData {
|
||||
return {};
|
||||
}
|
||||
updateFromNetworkSyncData(
|
||||
syncData: SkyboxFilterNetworkSyncData
|
||||
): void {}
|
||||
})();
|
||||
}
|
||||
})()
|
||||
);
|
||||
}
|
@@ -145,9 +145,11 @@ namespace gdjs {
|
||||
return true;
|
||||
}
|
||||
|
||||
override getNetworkSyncData(): BBTextObjectNetworkSyncData {
|
||||
override getNetworkSyncData(
|
||||
syncOptions: GetNetworkSyncDataOptions
|
||||
): BBTextObjectNetworkSyncData {
|
||||
return {
|
||||
...super.getNetworkSyncData(),
|
||||
...super.getNetworkSyncData(syncOptions),
|
||||
text: this._text,
|
||||
o: this._opacity,
|
||||
c: this._color,
|
||||
@@ -162,9 +164,10 @@ namespace gdjs {
|
||||
}
|
||||
|
||||
override updateFromNetworkSyncData(
|
||||
networkSyncData: BBTextObjectNetworkSyncData
|
||||
networkSyncData: BBTextObjectNetworkSyncData,
|
||||
options: UpdateFromNetworkSyncDataOptions
|
||||
): void {
|
||||
super.updateFromNetworkSyncData(networkSyncData);
|
||||
super.updateFromNetworkSyncData(networkSyncData, options);
|
||||
if (this._text !== undefined) {
|
||||
this.setBBText(networkSyncData.text);
|
||||
}
|
||||
|
@@ -155,9 +155,11 @@ namespace gdjs {
|
||||
return true;
|
||||
}
|
||||
|
||||
override getNetworkSyncData(): BitmapTextObjectNetworkSyncData {
|
||||
override getNetworkSyncData(
|
||||
syncOptions: GetNetworkSyncDataOptions
|
||||
): BitmapTextObjectNetworkSyncData {
|
||||
return {
|
||||
...super.getNetworkSyncData(),
|
||||
...super.getNetworkSyncData(syncOptions),
|
||||
text: this._text,
|
||||
opa: this._opacity,
|
||||
tint: this._tint,
|
||||
@@ -172,9 +174,10 @@ namespace gdjs {
|
||||
}
|
||||
|
||||
override updateFromNetworkSyncData(
|
||||
networkSyncData: BitmapTextObjectNetworkSyncData
|
||||
networkSyncData: BitmapTextObjectNetworkSyncData,
|
||||
options: UpdateFromNetworkSyncDataOptions
|
||||
): void {
|
||||
super.updateFromNetworkSyncData(networkSyncData);
|
||||
super.updateFromNetworkSyncData(networkSyncData, options);
|
||||
if (this._text !== undefined) {
|
||||
this.setText(networkSyncData.text);
|
||||
}
|
||||
|
@@ -21,7 +21,9 @@ module.exports = {
|
||||
.setExtensionInformation(
|
||||
'DebuggerTools',
|
||||
_('Debugger Tools'),
|
||||
_('Allow to interact with the editor debugger from the game.'),
|
||||
_(
|
||||
'Allow to interact with the editor debugger from the game (notably: enable 2D debug draw, log a message in the debugger console).'
|
||||
),
|
||||
'Arthur Pacaud (arthuro555), Aurélien Vivet (Bouh)',
|
||||
'MIT'
|
||||
)
|
||||
|
@@ -12,7 +12,8 @@ This project is released under the MIT License.
|
||||
#include "GDCore/Tools/Localization.h"
|
||||
|
||||
void DestroyOutsideBehavior::InitializeContent(gd::SerializerElement& content) {
|
||||
content.SetAttribute("extraBorder", 300);
|
||||
content.SetAttribute("extraBorder", 200);
|
||||
content.SetAttribute("unseenGraceDistance", 10000);
|
||||
}
|
||||
|
||||
#if defined(GD_IDE_ONLY)
|
||||
@@ -27,7 +28,15 @@ DestroyOutsideBehavior::GetProperties(
|
||||
.SetType("Number")
|
||||
.SetMeasurementUnit(gd::MeasurementUnit::GetPixel())
|
||||
.SetLabel(_("Deletion margin"))
|
||||
.SetDescription(_("Margin before deleting the object, in pixels"));
|
||||
.SetDescription(_("Margin before deleting the object, in pixels."));
|
||||
|
||||
properties["unseenGraceDistance"]
|
||||
.SetValue(gd::String::From(
|
||||
behaviorContent.GetDoubleAttribute("unseenGraceDistance", 0)))
|
||||
.SetType("Number")
|
||||
.SetMeasurementUnit(gd::MeasurementUnit::GetPixel())
|
||||
.SetLabel(_("Unseen object grace distance"))
|
||||
.SetDescription(_("If the object hasn't been visible yet, don't delete it until it travels this far beyond the screen (in pixels). Useful to avoid objects being deleted before they are visible when they spawn."));
|
||||
|
||||
return properties;
|
||||
}
|
||||
@@ -38,6 +47,8 @@ bool DestroyOutsideBehavior::UpdateProperty(
|
||||
const gd::String& value) {
|
||||
if (name == "extraBorder")
|
||||
behaviorContent.SetAttribute("extraBorder", value.To<double>());
|
||||
else if (name == "unseenGraceDistance")
|
||||
behaviorContent.SetAttribute("unseenGraceDistance", value.To<double>());
|
||||
else
|
||||
return false;
|
||||
|
||||
|
@@ -6,6 +6,7 @@ This project is released under the MIT License.
|
||||
*/
|
||||
|
||||
#include "DestroyOutsideBehavior.h"
|
||||
#include "GDCore/Extensions/Metadata/MultipleInstructionMetadata.h"
|
||||
#include "GDCore/Extensions/PlatformExtension.h"
|
||||
#include "GDCore/Project/BehaviorsSharedData.h"
|
||||
#include "GDCore/Tools/Localization.h"
|
||||
@@ -19,11 +20,10 @@ void DeclareDestroyOutsideBehaviorExtension(gd::PlatformExtension& extension) {
|
||||
"outside of the bounds of the 2D camera. Useful for 2D bullets or "
|
||||
"other short-lived objects. Don't use it for 3D objects in a "
|
||||
"FPS/TPS game or any game with a camera not being a top view "
|
||||
"(for 3D objects, prefer comparing "
|
||||
"the position, for example Z position to see if an object goes "
|
||||
"outside of the bound of the map). Be careful when using this "
|
||||
"behavior because if the object appears outside of the screen, it "
|
||||
"will be immediately removed."),
|
||||
"(for 3D objects, prefer comparing the position, for example Z "
|
||||
"position to see if an object goes outside of the bound of the "
|
||||
"map). If the object appears outside of the screen, it's not "
|
||||
"removed unless it goes beyond the unseen object grace distance."),
|
||||
"Florian Rival",
|
||||
"Open source (MIT License)")
|
||||
.SetCategory("Game mechanic")
|
||||
@@ -44,34 +44,39 @@ void DeclareDestroyOutsideBehaviorExtension(gd::PlatformExtension& extension) {
|
||||
std::shared_ptr<gd::BehaviorsSharedData>())
|
||||
.SetQuickCustomizationVisibility(gd::QuickCustomization::Hidden);
|
||||
|
||||
aut.AddCondition("ExtraBorder",
|
||||
_("Additional border (extra distance before deletion)"),
|
||||
_("Compare the extra distance (in pixels) the object must "
|
||||
"travel beyond the screen before it gets deleted."),
|
||||
_("the additional border"),
|
||||
_("Destroy outside configuration"),
|
||||
"CppPlatform/Extensions/destroyoutsideicon24.png",
|
||||
"CppPlatform/Extensions/destroyoutsideicon16.png")
|
||||
aut.AddExpressionAndConditionAndAction(
|
||||
"number",
|
||||
"ExtraBorder",
|
||||
_("Additional border (extra distance before deletion)"),
|
||||
_("the extra distance (in pixels) the object must "
|
||||
"travel beyond the screen before it gets deleted"),
|
||||
_("the additional border"),
|
||||
_("Destroy outside configuration"),
|
||||
"CppPlatform/Extensions/destroyoutsideicon24.png")
|
||||
.AddParameter("object", _("Object"))
|
||||
.AddParameter("behavior", _("Behavior"), "DestroyOutside")
|
||||
.UseStandardRelationalOperatorParameters(
|
||||
"number", gd::ParameterOptions::MakeNewOptions())
|
||||
.MarkAsAdvanced()
|
||||
.SetFunctionName("GetExtraBorder");
|
||||
.UseStandardParameters("number", gd::ParameterOptions::MakeNewOptions())
|
||||
.MarkAsAdvanced();
|
||||
|
||||
aut.AddAction("ExtraBorder",
|
||||
_("Additional border (extra distance before deletion)"),
|
||||
_("Change the extra distance (in pixels) the object must "
|
||||
"travel beyond the screen before it gets deleted."),
|
||||
_("the additional border"),
|
||||
_("Destroy outside configuration"),
|
||||
"CppPlatform/Extensions/destroyoutsideicon24.png",
|
||||
"CppPlatform/Extensions/destroyoutsideicon16.png")
|
||||
// Deprecated:
|
||||
aut.AddDuplicatedAction("ExtraBorder", "DestroyOutside::SetExtraBorder")
|
||||
.SetHidden();
|
||||
aut.AddDuplicatedCondition("ExtraBorder", "DestroyOutside::ExtraBorder")
|
||||
.SetHidden();
|
||||
|
||||
aut.AddExpressionAndConditionAndAction(
|
||||
"number",
|
||||
"UnseenGraceDistance",
|
||||
_("Unseen object grace distance"),
|
||||
_("the grace distance (in pixels) before deleting the object if it "
|
||||
"has "
|
||||
"never been visible on the screen. Useful to avoid objects being "
|
||||
"deleted before they are visible when they spawn"),
|
||||
_("the unseen grace distance"),
|
||||
_("Destroy outside configuration"),
|
||||
"CppPlatform/Extensions/destroyoutsideicon24.png")
|
||||
.AddParameter("object", _("Object"))
|
||||
.AddParameter("behavior", _("Behavior"), "DestroyOutside")
|
||||
.UseStandardOperatorParameters("number",
|
||||
gd::ParameterOptions::MakeNewOptions())
|
||||
.MarkAsAdvanced()
|
||||
.SetFunctionName("SetExtraBorder")
|
||||
.SetGetter("GetExtraBorder");
|
||||
.UseStandardParameters("number", gd::ParameterOptions::MakeNewOptions())
|
||||
.MarkAsAdvanced();
|
||||
}
|
||||
|
@@ -5,11 +5,11 @@ Copyright (c) 2014-2016 Florian Rival (Florian.Rival@gmail.com)
|
||||
This project is released under the MIT License.
|
||||
*/
|
||||
#if defined(GD_IDE_ONLY)
|
||||
#include <iostream>
|
||||
|
||||
#include "GDCore/Extensions/PlatformExtension.h"
|
||||
#include "GDCore/Tools/Localization.h"
|
||||
|
||||
#include <iostream>
|
||||
|
||||
void DeclareDestroyOutsideBehaviorExtension(gd::PlatformExtension& extension);
|
||||
|
||||
/**
|
||||
@@ -29,19 +29,36 @@ class DestroyOutsideBehaviorJsExtension : public gd::PlatformExtension {
|
||||
"Extensions/DestroyOutsideBehavior/"
|
||||
"destroyoutsideruntimebehavior.js");
|
||||
|
||||
GetAllExpressionsForBehavior(
|
||||
"DestroyOutsideBehavior::DestroyOutside")["ExtraBorder"]
|
||||
.SetFunctionName("getExtraBorder");
|
||||
GetAllConditionsForBehavior("DestroyOutsideBehavior::DestroyOutside")
|
||||
["DestroyOutsideBehavior::DestroyOutside::ExtraBorder"]
|
||||
.SetFunctionName("getExtraBorder");
|
||||
GetAllActionsForBehavior("DestroyOutsideBehavior::DestroyOutside")
|
||||
["DestroyOutsideBehavior::DestroyOutside::SetExtraBorder"]
|
||||
.SetFunctionName("setExtraBorder")
|
||||
.SetGetter("getExtraBorder");
|
||||
|
||||
// Deprecated:
|
||||
GetAllConditionsForBehavior("DestroyOutsideBehavior::DestroyOutside")
|
||||
["DestroyOutsideBehavior::ExtraBorder"]
|
||||
.SetFunctionName("getExtraBorder")
|
||||
.SetIncludeFile(
|
||||
"Extensions/DestroyOutsideBehavior/"
|
||||
"destroyoutsideruntimebehavior.js");
|
||||
.SetFunctionName("getExtraBorder");
|
||||
GetAllActionsForBehavior("DestroyOutsideBehavior::DestroyOutside")
|
||||
["DestroyOutsideBehavior::ExtraBorder"]
|
||||
.SetFunctionName("setExtraBorder")
|
||||
.SetGetter("getExtraBorder")
|
||||
.SetIncludeFile(
|
||||
"Extensions/DestroyOutsideBehavior/"
|
||||
"destroyoutsideruntimebehavior.js");
|
||||
.SetGetter("getExtraBorder");
|
||||
|
||||
GetAllExpressionsForBehavior(
|
||||
"DestroyOutsideBehavior::DestroyOutside")["UnseenGraceDistance"]
|
||||
.SetFunctionName("getUnseenGraceDistance");
|
||||
GetAllConditionsForBehavior("DestroyOutsideBehavior::DestroyOutside")
|
||||
["DestroyOutsideBehavior::DestroyOutside::UnseenGraceDistance"]
|
||||
.SetFunctionName("getUnseenGraceDistance");
|
||||
GetAllActionsForBehavior("DestroyOutsideBehavior::DestroyOutside")
|
||||
["DestroyOutsideBehavior::DestroyOutside::SetUnseenGraceDistance"]
|
||||
.SetFunctionName("setUnseenGraceDistance")
|
||||
.SetGetter("getUnseenGraceDistance");
|
||||
|
||||
GD_COMPLETE_EXTENSION_COMPILATION_INFORMATION();
|
||||
};
|
||||
|
@@ -8,7 +8,9 @@ namespace gdjs {
|
||||
* The DestroyOutsideRuntimeBehavior represents a behavior that destroys the object when it leaves the screen.
|
||||
*/
|
||||
export class DestroyOutsideRuntimeBehavior extends gdjs.RuntimeBehavior {
|
||||
_extraBorder: any;
|
||||
_extraBorder: float;
|
||||
_unseenGraceDistance: float;
|
||||
_hasBeenOnScreen: boolean;
|
||||
|
||||
constructor(
|
||||
instanceContainer: gdjs.RuntimeInstanceContainer,
|
||||
@@ -17,12 +19,20 @@ namespace gdjs {
|
||||
) {
|
||||
super(instanceContainer, behaviorData, owner);
|
||||
this._extraBorder = behaviorData.extraBorder || 0;
|
||||
this._unseenGraceDistance = behaviorData.unseenGraceDistance || 0;
|
||||
this._hasBeenOnScreen = false;
|
||||
}
|
||||
|
||||
updateFromBehaviorData(oldBehaviorData, newBehaviorData): boolean {
|
||||
if (oldBehaviorData.extraBorder !== newBehaviorData.extraBorder) {
|
||||
this._extraBorder = newBehaviorData.extraBorder;
|
||||
}
|
||||
if (
|
||||
oldBehaviorData.unseenGraceDistance !==
|
||||
newBehaviorData.unseenGraceDistance
|
||||
) {
|
||||
this._unseenGraceDistance = newBehaviorData.unseenGraceDistance;
|
||||
}
|
||||
return true;
|
||||
}
|
||||
|
||||
@@ -35,23 +45,47 @@ namespace gdjs {
|
||||
const ocy = this.owner.getDrawableY() + this.owner.getCenterY();
|
||||
const layer = instanceContainer.getLayer(this.owner.getLayer());
|
||||
const boundingCircleRadius = Math.sqrt(ow * ow + oh * oh) / 2.0;
|
||||
|
||||
const cameraLeft = layer.getCameraX() - layer.getCameraWidth() / 2;
|
||||
const cameraRight = layer.getCameraX() + layer.getCameraWidth() / 2;
|
||||
const cameraTop = layer.getCameraY() - layer.getCameraHeight() / 2;
|
||||
const cameraBottom = layer.getCameraY() + layer.getCameraHeight() / 2;
|
||||
|
||||
if (
|
||||
ocx + boundingCircleRadius + this._extraBorder <
|
||||
layer.getCameraX() - layer.getCameraWidth() / 2 ||
|
||||
ocx - boundingCircleRadius - this._extraBorder >
|
||||
layer.getCameraX() + layer.getCameraWidth() / 2 ||
|
||||
ocy + boundingCircleRadius + this._extraBorder <
|
||||
layer.getCameraY() - layer.getCameraHeight() / 2 ||
|
||||
ocy - boundingCircleRadius - this._extraBorder >
|
||||
layer.getCameraY() + layer.getCameraHeight() / 2
|
||||
ocx + boundingCircleRadius + this._extraBorder < cameraLeft ||
|
||||
ocx - boundingCircleRadius - this._extraBorder > cameraRight ||
|
||||
ocy + boundingCircleRadius + this._extraBorder < cameraTop ||
|
||||
ocy - boundingCircleRadius - this._extraBorder > cameraBottom
|
||||
) {
|
||||
//We are outside the camera area.
|
||||
this.owner.deleteFromScene();
|
||||
if (this._hasBeenOnScreen) {
|
||||
// Object is outside the camera area and object was previously seen inside it:
|
||||
// delete it now.
|
||||
this.owner.deleteFromScene();
|
||||
} else if (
|
||||
ocx + boundingCircleRadius + this._unseenGraceDistance < cameraLeft ||
|
||||
ocx - boundingCircleRadius - this._unseenGraceDistance >
|
||||
cameraRight ||
|
||||
ocy + boundingCircleRadius + this._unseenGraceDistance < cameraTop ||
|
||||
ocy - boundingCircleRadius - this._unseenGraceDistance > cameraBottom
|
||||
) {
|
||||
// Object is outside the camera area and also outside the grace distance:
|
||||
// force deletion.
|
||||
this.owner.deleteFromScene();
|
||||
} else {
|
||||
// Object is outside the camera area but inside the grace distance
|
||||
// and was never seen inside the camera area: don't delete it yet.
|
||||
}
|
||||
} else {
|
||||
this._hasBeenOnScreen = true;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Set an additional border to the camera viewport as a buffer before the object gets destroyed.
|
||||
* Set the additional border outside the camera area.
|
||||
*
|
||||
* If the object goes beyond the camera area and this border, it will be deleted (unless it was
|
||||
* never seen inside the camera area and this border before, in which case it will be deleted
|
||||
* according to the grace distance).
|
||||
* @param val Border in pixels.
|
||||
*/
|
||||
setExtraBorder(val: number): void {
|
||||
@@ -59,12 +93,36 @@ namespace gdjs {
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the additional border of the camera viewport buffer which triggers the destruction of an object.
|
||||
* Get the additional border outside the camera area.
|
||||
* @return The additional border around the camera viewport in pixels
|
||||
*/
|
||||
getExtraBorder(): number {
|
||||
return this._extraBorder;
|
||||
}
|
||||
|
||||
/**
|
||||
* Change the grace distance before an object is deleted if it's outside the camera area
|
||||
* and was never seen inside the camera area. Typically useful to avoid objects being deleted
|
||||
* before they are visible when they spawn.
|
||||
*/
|
||||
setUnseenGraceDistance(val: number): void {
|
||||
this._unseenGraceDistance = val;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the grace distance before an object is deleted if it's outside the camera area
|
||||
* and was never seen inside the camera area.
|
||||
*/
|
||||
getUnseenGraceDistance(): number {
|
||||
return this._unseenGraceDistance;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if this object has been visible on screen (precisely: inside the camera area *including* the extra border).
|
||||
*/
|
||||
hasBeenOnScreen(): boolean {
|
||||
return this._hasBeenOnScreen;
|
||||
}
|
||||
}
|
||||
gdjs.registerBehavior(
|
||||
'DestroyOutsideBehavior::DestroyOutside',
|
||||
|
@@ -8,6 +8,83 @@ namespace gdjs {
|
||||
let _hasPlayerJustClosedLeaderboardView = false;
|
||||
let _preferSendConnectedPlayerScore = true;
|
||||
|
||||
// Rolling-window rate limiting state (successful entries only):
|
||||
// - Global: at most 12 successful entries across all leaderboards in the past minute
|
||||
// - Per-leaderboard: at most 6 successful entries on the same leaderboard in the past minute
|
||||
const ROLLING_WINDOW_MS = 60 * 1000;
|
||||
const GLOBAL_SUCCESS_LIMIT_PER_MINUTE = 12;
|
||||
const PER_LEADERBOARD_SUCCESS_LIMIT_PER_MINUTE = 6;
|
||||
|
||||
// Store timestamps of successful entries to implement the rolling window.
|
||||
let _successfulEntriesTimestampsGlobal: number[] = [];
|
||||
let _successfulEntriesTimestampsByLeaderboard: {
|
||||
[leaderboardId: string]: number[];
|
||||
} = {};
|
||||
|
||||
// Reservations to avoid concurrency overshoot (successes + reservations never exceed limits).
|
||||
let _reservedSendsGlobal: number = 0;
|
||||
let _reservedSendsByLeaderboard: { [leaderboardId: string]: number } = {};
|
||||
|
||||
const _pruneOldSuccessfulEntries = () => {
|
||||
const threshold = Date.now() - ROLLING_WINDOW_MS;
|
||||
// Global pruning
|
||||
_successfulEntriesTimestampsGlobal = _successfulEntriesTimestampsGlobal.filter(
|
||||
(ts) => ts >= threshold
|
||||
);
|
||||
// Per-leaderboard pruning
|
||||
Object.keys(_successfulEntriesTimestampsByLeaderboard).forEach(
|
||||
(leaderboardId) => {
|
||||
const timestamps = _successfulEntriesTimestampsByLeaderboard[
|
||||
leaderboardId
|
||||
];
|
||||
const pruned = timestamps.filter((ts) => ts >= threshold);
|
||||
_successfulEntriesTimestampsByLeaderboard[leaderboardId] = pruned;
|
||||
}
|
||||
);
|
||||
};
|
||||
|
||||
const _attemptReserveQuota = (leaderboardId: string): boolean => {
|
||||
_pruneOldSuccessfulEntries();
|
||||
const globalCount = _successfulEntriesTimestampsGlobal.length;
|
||||
const reservedGlobal = _reservedSendsGlobal;
|
||||
|
||||
const perLeaderboardTimestamps =
|
||||
_successfulEntriesTimestampsByLeaderboard[leaderboardId] || [];
|
||||
const perLeaderboardCount = perLeaderboardTimestamps.length;
|
||||
const reservedForLeaderboard =
|
||||
_reservedSendsByLeaderboard[leaderboardId] || 0;
|
||||
|
||||
const wouldExceedGlobal =
|
||||
globalCount + reservedGlobal >= GLOBAL_SUCCESS_LIMIT_PER_MINUTE;
|
||||
const wouldExceedPerLeaderboard =
|
||||
perLeaderboardCount + reservedForLeaderboard >=
|
||||
PER_LEADERBOARD_SUCCESS_LIMIT_PER_MINUTE;
|
||||
|
||||
if (wouldExceedGlobal || wouldExceedPerLeaderboard) return false;
|
||||
|
||||
_reservedSendsGlobal += 1;
|
||||
_reservedSendsByLeaderboard[leaderboardId] =
|
||||
( _reservedSendsByLeaderboard[leaderboardId] || 0) + 1;
|
||||
return true;
|
||||
};
|
||||
|
||||
const _releaseReservedQuota = (leaderboardId: string): void => {
|
||||
if (_reservedSendsGlobal > 0) _reservedSendsGlobal -= 1;
|
||||
if ((_reservedSendsByLeaderboard[leaderboardId] || 0) > 0) {
|
||||
_reservedSendsByLeaderboard[leaderboardId] -= 1;
|
||||
}
|
||||
};
|
||||
|
||||
const _recordSuccessfulEntry = (leaderboardId: string): void => {
|
||||
const now = Date.now();
|
||||
_successfulEntriesTimestampsGlobal.push(now);
|
||||
const perLeaderboard =
|
||||
_successfulEntriesTimestampsByLeaderboard[leaderboardId] || [];
|
||||
perLeaderboard.push(now);
|
||||
_successfulEntriesTimestampsByLeaderboard[leaderboardId] = perLeaderboard;
|
||||
_pruneOldSuccessfulEntries();
|
||||
};
|
||||
|
||||
gdjs.registerRuntimeScenePostEventsCallback(() => {
|
||||
// Set it back to false for the next frame.
|
||||
_hasPlayerJustClosedLeaderboardView = false;
|
||||
@@ -35,6 +112,15 @@ namespace gdjs {
|
||||
|
||||
/**
|
||||
* Hold the state of the save of a score for a leaderboard.
|
||||
*
|
||||
* Existing protections:
|
||||
* - 500ms per-leaderboard throttle between save starts (error code: TOO_FAST).
|
||||
* - Ignore same player+score as previous successful save (error code: SAME_AS_PREVIOUS).
|
||||
* - Ignore duplicate in-flight save for same player/score.
|
||||
*
|
||||
* New rolling-window limits (successful entries only):
|
||||
* - Global: at most 12 successful entries across all leaderboards in the past minute.
|
||||
* - Per-leaderboard: at most 6 successful entries on the same leaderboard in the past minute.
|
||||
*/
|
||||
class ScoreSavingState {
|
||||
lastScoreSavingStartedAt: number | null = null;
|
||||
@@ -115,10 +201,12 @@ namespace gdjs {
|
||||
}
|
||||
|
||||
startSaving({
|
||||
leaderboardId,
|
||||
playerName,
|
||||
playerId,
|
||||
score,
|
||||
}: {
|
||||
leaderboardId: string;
|
||||
playerName?: string;
|
||||
playerId?: string;
|
||||
score: number;
|
||||
@@ -154,6 +242,18 @@ namespace gdjs {
|
||||
throw new Error('Ignoring this saving request.');
|
||||
}
|
||||
|
||||
// New rolling-window limits (in addition to the existing 500ms per-leaderboard throttle above):
|
||||
// - Global limit: at most 12 successful entries across all leaderboards in the past minute.
|
||||
// - Per-leaderboard limit: at most 6 successful entries on the same leaderboard in the past minute.
|
||||
// These are enforced by reserving a slot before sending and releasing it after completion.
|
||||
if (!_attemptReserveQuota(leaderboardId)) {
|
||||
logger.warn(
|
||||
'Too many leaderboard entries were sent in the last minute. Ignoring this one.'
|
||||
);
|
||||
this._setError('TOO_MANY_ENTRIES_IN_A_MINUTE');
|
||||
throw new Error('Ignoring this saving request.');
|
||||
}
|
||||
|
||||
let resolveSavingPromise: () => void;
|
||||
const savingPromise = new Promise<void>((resolve) => {
|
||||
resolveSavingPromise = resolve;
|
||||
@@ -174,6 +274,11 @@ namespace gdjs {
|
||||
'Score saving result received, but another save was launched in the meantime - ignoring the result of this one.'
|
||||
);
|
||||
|
||||
// Still record the successful entry for rate limiting purposes,
|
||||
// then release the reserved quota taken at start.
|
||||
_recordSuccessfulEntry(leaderboardId);
|
||||
_releaseReservedQuota(leaderboardId);
|
||||
|
||||
// Still finish the promise that can be waited upon:
|
||||
resolveSavingPromise();
|
||||
return;
|
||||
@@ -186,6 +291,10 @@ namespace gdjs {
|
||||
this.lastSavedLeaderboardEntry = leaderboardEntry;
|
||||
this.hasScoreBeenSaved = true;
|
||||
|
||||
// Record the success and release the reservation.
|
||||
_recordSuccessfulEntry(leaderboardId);
|
||||
_releaseReservedQuota(leaderboardId);
|
||||
|
||||
resolveSavingPromise();
|
||||
},
|
||||
closeSavingWithError: (errorCode) => {
|
||||
@@ -194,12 +303,22 @@ namespace gdjs {
|
||||
'Score saving result received, but another save was launched in the meantime - ignoring the result of this one.'
|
||||
);
|
||||
|
||||
// Release the reserved quota taken at start.
|
||||
_releaseReservedQuota(leaderboardId);
|
||||
|
||||
// Still finish the promise that can be waited upon:
|
||||
resolveSavingPromise();
|
||||
return;
|
||||
}
|
||||
|
||||
this._setError(errorCode);
|
||||
// If the entry was actually saved but response couldn't be parsed,
|
||||
// still count it as a success for rate limiting.
|
||||
if (errorCode === 'SAVED_ENTRY_CANT_BE_READ') {
|
||||
_recordSuccessfulEntry(leaderboardId);
|
||||
}
|
||||
// On error, release the reservation (success recorded only if above case).
|
||||
_releaseReservedQuota(leaderboardId);
|
||||
resolveSavingPromise();
|
||||
},
|
||||
};
|
||||
@@ -396,7 +515,7 @@ namespace gdjs {
|
||||
|
||||
try {
|
||||
const { closeSaving, closeSavingWithError } =
|
||||
scoreSavingState.startSaving({ playerName, score });
|
||||
scoreSavingState.startSaving({ leaderboardId, playerName, score });
|
||||
|
||||
try {
|
||||
const leaderboardEntry = await saveScore({
|
||||
@@ -440,7 +559,7 @@ namespace gdjs {
|
||||
|
||||
try {
|
||||
const { closeSaving, closeSavingWithError } =
|
||||
scoreSavingState.startSaving({ playerId, score });
|
||||
scoreSavingState.startSaving({ leaderboardId, playerId, score });
|
||||
|
||||
try {
|
||||
const leaderboardEntryId = await saveScore({
|
||||
|
@@ -87,16 +87,21 @@ namespace gdjs {
|
||||
return true;
|
||||
}
|
||||
|
||||
getNetworkSyncData(): LightNetworkSyncData {
|
||||
getNetworkSyncData(
|
||||
syncOptions: GetNetworkSyncDataOptions
|
||||
): LightNetworkSyncData {
|
||||
return {
|
||||
...super.getNetworkSyncData(),
|
||||
...super.getNetworkSyncData(syncOptions),
|
||||
rad: this.getRadius(),
|
||||
col: this.getColor(),
|
||||
};
|
||||
}
|
||||
|
||||
updateFromNetworkSyncData(networkSyncData: LightNetworkSyncData): void {
|
||||
super.updateFromNetworkSyncData(networkSyncData);
|
||||
updateFromNetworkSyncData(
|
||||
networkSyncData: LightNetworkSyncData,
|
||||
options: UpdateFromNetworkSyncDataOptions
|
||||
): void {
|
||||
super.updateFromNetworkSyncData(networkSyncData, options);
|
||||
|
||||
if (networkSyncData.rad !== undefined) {
|
||||
this.setRadius(networkSyncData.rad);
|
||||
|
@@ -729,7 +729,9 @@ namespace gdjs {
|
||||
behavior.playerNumber = ownerPlayerNumber;
|
||||
}
|
||||
|
||||
instance.updateFromNetworkSyncData(messageData);
|
||||
instance.updateFromNetworkSyncData(messageData, {
|
||||
clearInputs: false,
|
||||
});
|
||||
|
||||
setLastClockReceivedForInstanceOnScene({
|
||||
sceneNetworkId,
|
||||
@@ -1737,7 +1739,7 @@ namespace gdjs {
|
||||
return;
|
||||
}
|
||||
|
||||
runtimeScene.updateFromNetworkSyncData(messageData);
|
||||
runtimeScene.updateFromNetworkSyncData(messageData, {});
|
||||
} else {
|
||||
// If the game is not ready to receive game update messages, we need to save the data for later use.
|
||||
// This can happen when joining a game that is already running.
|
||||
@@ -1890,7 +1892,7 @@ namespace gdjs {
|
||||
const messageData = message.getData();
|
||||
const messageSender = message.getSender();
|
||||
if (gdjs.multiplayer.isReadyToSendOrReceiveGameUpdateMessages()) {
|
||||
runtimeScene.getGame().updateFromNetworkSyncData(messageData);
|
||||
runtimeScene.getGame().updateFromNetworkSyncData(messageData, {});
|
||||
} else {
|
||||
// If the game is not ready to receive game update messages, we need to save the data for later use.
|
||||
// This can happen when joining a game that is already running.
|
||||
@@ -1918,7 +1920,7 @@ namespace gdjs {
|
||||
// Reapply the game saved updates.
|
||||
lastReceivedGameSyncDataUpdates.getUpdates().forEach((messageData) => {
|
||||
debugLogger.info(`Reapplying saved update of game.`);
|
||||
runtimeScene.getGame().updateFromNetworkSyncData(messageData);
|
||||
runtimeScene.getGame().updateFromNetworkSyncData(messageData, {});
|
||||
});
|
||||
// Game updates are always applied properly, so we can clear them.
|
||||
lastReceivedGameSyncDataUpdates.clear();
|
||||
@@ -1937,7 +1939,7 @@ namespace gdjs {
|
||||
|
||||
debugLogger.info(`Reapplying saved update of scene ${sceneNetworkId}.`);
|
||||
|
||||
runtimeScene.updateFromNetworkSyncData(messageData);
|
||||
runtimeScene.updateFromNetworkSyncData(messageData, {});
|
||||
// We only remove the message if it was successfully applied, so it can be reapplied later,
|
||||
// in case we were not on the right scene.
|
||||
lastReceivedSceneSyncDataUpdates.remove(messageData);
|
||||
|
@@ -278,7 +278,7 @@ namespace gdjs {
|
||||
|
||||
const instanceNetworkId = this._getOrCreateInstanceNetworkId();
|
||||
const objectName = this.owner.getName();
|
||||
const objectNetworkSyncData = this.owner.getNetworkSyncData();
|
||||
const objectNetworkSyncData = this.owner.getNetworkSyncData({});
|
||||
|
||||
// this._logToConsoleWithThrottle(
|
||||
// `Synchronizing object ${this.owner.getName()} (instance ${
|
||||
@@ -448,7 +448,7 @@ namespace gdjs {
|
||||
objectOwner: this.playerNumber,
|
||||
objectName,
|
||||
instanceNetworkId,
|
||||
objectNetworkSyncData: this.owner.getNetworkSyncData(),
|
||||
objectNetworkSyncData: this.owner.getNetworkSyncData({}),
|
||||
sceneNetworkId,
|
||||
});
|
||||
this._sendDataToPeersWithIncreasedClock(
|
||||
@@ -598,7 +598,7 @@ namespace gdjs {
|
||||
debugLogger.info(
|
||||
'Sending update message to move the object immediately.'
|
||||
);
|
||||
const objectNetworkSyncData = this.owner.getNetworkSyncData();
|
||||
const objectNetworkSyncData = this.owner.getNetworkSyncData({});
|
||||
const {
|
||||
messageName: updateMessageName,
|
||||
messageData: updateMessageData,
|
||||
|
@@ -119,18 +119,21 @@ namespace gdjs {
|
||||
return true;
|
||||
}
|
||||
|
||||
getNetworkSyncData(): PanelSpriteNetworkSyncData {
|
||||
getNetworkSyncData(
|
||||
syncOptions: GetNetworkSyncDataOptions
|
||||
): PanelSpriteNetworkSyncData {
|
||||
return {
|
||||
...super.getNetworkSyncData(),
|
||||
...super.getNetworkSyncData(syncOptions),
|
||||
op: this.getOpacity(),
|
||||
color: this.getColor(),
|
||||
};
|
||||
}
|
||||
|
||||
updateFromNetworkSyncData(
|
||||
networkSyncData: PanelSpriteNetworkSyncData
|
||||
networkSyncData: PanelSpriteNetworkSyncData,
|
||||
options: UpdateFromNetworkSyncDataOptions
|
||||
): void {
|
||||
super.updateFromNetworkSyncData(networkSyncData);
|
||||
super.updateFromNetworkSyncData(networkSyncData, options);
|
||||
|
||||
// Texture is not synchronized, see if this is asked or not.
|
||||
|
||||
|
@@ -370,9 +370,11 @@ namespace gdjs {
|
||||
return true;
|
||||
}
|
||||
|
||||
getNetworkSyncData(): ParticleEmitterObjectNetworkSyncData {
|
||||
getNetworkSyncData(
|
||||
syncOptions: GetNetworkSyncDataOptions
|
||||
): ParticleEmitterObjectNetworkSyncData {
|
||||
return {
|
||||
...super.getNetworkSyncData(),
|
||||
...super.getNetworkSyncData(syncOptions),
|
||||
prms: this.particleRotationMinSpeed,
|
||||
prmx: this.particleRotationMaxSpeed,
|
||||
mpc: this.maxParticlesCount,
|
||||
@@ -399,9 +401,10 @@ namespace gdjs {
|
||||
}
|
||||
|
||||
updateFromNetworkSyncData(
|
||||
syncData: ParticleEmitterObjectNetworkSyncData
|
||||
syncData: ParticleEmitterObjectNetworkSyncData,
|
||||
options: UpdateFromNetworkSyncDataOptions
|
||||
): void {
|
||||
super.updateFromNetworkSyncData(syncData);
|
||||
super.updateFromNetworkSyncData(syncData, options);
|
||||
if (syncData.x !== undefined) {
|
||||
this.setX(syncData.x);
|
||||
}
|
||||
|
@@ -6,7 +6,7 @@ namespace gdjs {
|
||||
const logger = new gdjs.Logger('Pathfinding behavior');
|
||||
|
||||
interface PathfindingNetworkSyncDataType {
|
||||
// Syncing the path should be enough to have a good prediction.
|
||||
// Syncing the path and its position on it should be enough to have a good prediction.
|
||||
path: FloatPoint[];
|
||||
pf: boolean;
|
||||
sp: number;
|
||||
@@ -15,6 +15,7 @@ namespace gdjs {
|
||||
tss: number;
|
||||
re: boolean;
|
||||
ma: number;
|
||||
dos: number;
|
||||
}
|
||||
|
||||
export interface PathfindingNetworkSyncData extends BehaviorNetworkSyncData {
|
||||
@@ -133,9 +134,11 @@ namespace gdjs {
|
||||
return true;
|
||||
}
|
||||
|
||||
getNetworkSyncData(): PathfindingNetworkSyncData {
|
||||
getNetworkSyncData(
|
||||
options: GetNetworkSyncDataOptions
|
||||
): PathfindingNetworkSyncData {
|
||||
return {
|
||||
...super.getNetworkSyncData(),
|
||||
...super.getNetworkSyncData(options),
|
||||
props: {
|
||||
path: this._path,
|
||||
pf: this._pathFound,
|
||||
@@ -145,14 +148,16 @@ namespace gdjs {
|
||||
tss: this._totalSegmentDistance,
|
||||
re: this._reachedEnd,
|
||||
ma: this._movementAngle,
|
||||
dos: this._distanceOnSegment,
|
||||
},
|
||||
};
|
||||
}
|
||||
|
||||
updateFromNetworkSyncData(
|
||||
networkSyncData: PathfindingNetworkSyncData
|
||||
networkSyncData: PathfindingNetworkSyncData,
|
||||
options: UpdateFromNetworkSyncDataOptions
|
||||
): void {
|
||||
super.updateFromNetworkSyncData(networkSyncData);
|
||||
super.updateFromNetworkSyncData(networkSyncData, options);
|
||||
const behaviorSpecificProps = networkSyncData.props;
|
||||
if (behaviorSpecificProps.path !== undefined) {
|
||||
this._path = behaviorSpecificProps.path;
|
||||
@@ -181,6 +186,9 @@ namespace gdjs {
|
||||
if (behaviorSpecificProps.ma !== undefined) {
|
||||
this._movementAngle = behaviorSpecificProps.ma;
|
||||
}
|
||||
if (behaviorSpecificProps.dos !== undefined) {
|
||||
this._distanceOnSegment = behaviorSpecificProps.dos;
|
||||
}
|
||||
}
|
||||
|
||||
setCellWidth(width: float): void {
|
||||
|
@@ -499,7 +499,9 @@ namespace gdjs {
|
||||
return true;
|
||||
}
|
||||
|
||||
getNetworkSyncData(): Physics2NetworkSyncData {
|
||||
getNetworkSyncData(
|
||||
options: GetNetworkSyncDataOptions
|
||||
): Physics2NetworkSyncData {
|
||||
const bodyProps = this._body
|
||||
? {
|
||||
tpx: this._body.GetTransform().get_p().get_x(),
|
||||
@@ -520,7 +522,7 @@ namespace gdjs {
|
||||
aw: undefined,
|
||||
};
|
||||
return {
|
||||
...super.getNetworkSyncData(),
|
||||
...super.getNetworkSyncData(options),
|
||||
props: {
|
||||
...bodyProps,
|
||||
layers: this.layers,
|
||||
@@ -529,45 +531,13 @@ namespace gdjs {
|
||||
};
|
||||
}
|
||||
|
||||
updateFromNetworkSyncData(networkSyncData: Physics2NetworkSyncData) {
|
||||
super.updateFromNetworkSyncData(networkSyncData);
|
||||
updateFromNetworkSyncData(
|
||||
networkSyncData: Physics2NetworkSyncData,
|
||||
options: UpdateFromNetworkSyncDataOptions
|
||||
) {
|
||||
super.updateFromNetworkSyncData(networkSyncData, options);
|
||||
|
||||
const behaviorSpecificProps = networkSyncData.props;
|
||||
if (
|
||||
behaviorSpecificProps.tpx !== undefined &&
|
||||
behaviorSpecificProps.tpy !== undefined &&
|
||||
behaviorSpecificProps.tqa !== undefined
|
||||
) {
|
||||
if (this._body) {
|
||||
this._body.SetTransform(
|
||||
this.b2Vec2(behaviorSpecificProps.tpx, behaviorSpecificProps.tpy),
|
||||
behaviorSpecificProps.tqa
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
if (
|
||||
behaviorSpecificProps.lvx !== undefined &&
|
||||
behaviorSpecificProps.lvy !== undefined
|
||||
) {
|
||||
if (this._body) {
|
||||
this._body.SetLinearVelocity(
|
||||
this.b2Vec2(behaviorSpecificProps.lvx, behaviorSpecificProps.lvy)
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
if (behaviorSpecificProps.av !== undefined) {
|
||||
if (this._body) {
|
||||
this._body.SetAngularVelocity(behaviorSpecificProps.av);
|
||||
}
|
||||
}
|
||||
|
||||
if (behaviorSpecificProps.aw !== undefined) {
|
||||
if (this._body) {
|
||||
this._body.SetAwake(behaviorSpecificProps.aw);
|
||||
}
|
||||
}
|
||||
|
||||
if (behaviorSpecificProps.layers !== undefined) {
|
||||
this.layers = behaviorSpecificProps.layers;
|
||||
@@ -576,6 +546,38 @@ namespace gdjs {
|
||||
if (behaviorSpecificProps.masks !== undefined) {
|
||||
this.masks = behaviorSpecificProps.masks;
|
||||
}
|
||||
|
||||
this.updateBodyFromObject();
|
||||
|
||||
if (!this._body) return;
|
||||
|
||||
if (
|
||||
behaviorSpecificProps.tpx !== undefined &&
|
||||
behaviorSpecificProps.tpy !== undefined &&
|
||||
behaviorSpecificProps.tqa !== undefined
|
||||
) {
|
||||
this._body.SetTransform(
|
||||
this.b2Vec2(behaviorSpecificProps.tpx, behaviorSpecificProps.tpy),
|
||||
behaviorSpecificProps.tqa
|
||||
);
|
||||
}
|
||||
|
||||
if (
|
||||
behaviorSpecificProps.lvx !== undefined &&
|
||||
behaviorSpecificProps.lvy !== undefined
|
||||
) {
|
||||
this._body.SetLinearVelocity(
|
||||
this.b2Vec2(behaviorSpecificProps.lvx, behaviorSpecificProps.lvy)
|
||||
);
|
||||
}
|
||||
|
||||
if (behaviorSpecificProps.av !== undefined) {
|
||||
this._body.SetAngularVelocity(behaviorSpecificProps.av);
|
||||
}
|
||||
|
||||
if (behaviorSpecificProps.aw !== undefined) {
|
||||
this._body.SetAwake(behaviorSpecificProps.aw);
|
||||
}
|
||||
}
|
||||
|
||||
onDeActivate() {
|
||||
|
@@ -495,7 +495,9 @@ namespace gdjs {
|
||||
return true;
|
||||
}
|
||||
|
||||
override getNetworkSyncData(): Physics3DNetworkSyncData {
|
||||
override getNetworkSyncData(
|
||||
options: GetNetworkSyncDataOptions
|
||||
): Physics3DNetworkSyncData {
|
||||
let bodyProps;
|
||||
if (this._body) {
|
||||
const position = this._body.GetPosition();
|
||||
@@ -537,7 +539,7 @@ namespace gdjs {
|
||||
};
|
||||
}
|
||||
return {
|
||||
...super.getNetworkSyncData(),
|
||||
...super.getNetworkSyncData(options),
|
||||
props: {
|
||||
...bodyProps,
|
||||
layers: this.layers,
|
||||
@@ -547,27 +549,40 @@ namespace gdjs {
|
||||
}
|
||||
|
||||
override updateFromNetworkSyncData(
|
||||
networkSyncData: Physics3DNetworkSyncData
|
||||
networkSyncData: Physics3DNetworkSyncData,
|
||||
options: UpdateFromNetworkSyncDataOptions
|
||||
) {
|
||||
super.updateFromNetworkSyncData(networkSyncData);
|
||||
super.updateFromNetworkSyncData(networkSyncData, options);
|
||||
|
||||
const behaviorSpecificProps = networkSyncData.props;
|
||||
|
||||
if (behaviorSpecificProps.layers !== undefined) {
|
||||
this.layers = behaviorSpecificProps.layers;
|
||||
}
|
||||
if (behaviorSpecificProps.masks !== undefined) {
|
||||
this.masks = behaviorSpecificProps.masks;
|
||||
}
|
||||
|
||||
this._needToRecreateShape = true;
|
||||
this._needToRecreateBody = true;
|
||||
this.updateBodyFromObject();
|
||||
|
||||
if (!this._body) return;
|
||||
|
||||
if (
|
||||
behaviorSpecificProps.px !== undefined &&
|
||||
behaviorSpecificProps.py !== undefined &&
|
||||
behaviorSpecificProps.pz !== undefined
|
||||
) {
|
||||
if (this._body) {
|
||||
this._sharedData.bodyInterface.SetPosition(
|
||||
this._body.GetID(),
|
||||
this.getRVec3(
|
||||
behaviorSpecificProps.px,
|
||||
behaviorSpecificProps.py,
|
||||
behaviorSpecificProps.pz
|
||||
),
|
||||
Jolt.EActivation_DontActivate
|
||||
);
|
||||
}
|
||||
this._sharedData.bodyInterface.SetPosition(
|
||||
this._body.GetID(),
|
||||
this.getRVec3(
|
||||
behaviorSpecificProps.px,
|
||||
behaviorSpecificProps.py,
|
||||
behaviorSpecificProps.pz
|
||||
),
|
||||
Jolt.EActivation_DontActivate
|
||||
);
|
||||
}
|
||||
if (
|
||||
behaviorSpecificProps.rx !== undefined &&
|
||||
@@ -575,56 +590,44 @@ namespace gdjs {
|
||||
behaviorSpecificProps.rz !== undefined &&
|
||||
behaviorSpecificProps.rw !== undefined
|
||||
) {
|
||||
if (this._body) {
|
||||
this._sharedData.bodyInterface.SetRotation(
|
||||
this._body.GetID(),
|
||||
this.getQuat(
|
||||
behaviorSpecificProps.rx,
|
||||
behaviorSpecificProps.ry,
|
||||
behaviorSpecificProps.rz,
|
||||
behaviorSpecificProps.rw
|
||||
),
|
||||
Jolt.EActivation_DontActivate
|
||||
);
|
||||
}
|
||||
this._sharedData.bodyInterface.SetRotation(
|
||||
this._body.GetID(),
|
||||
this.getQuat(
|
||||
behaviorSpecificProps.rx,
|
||||
behaviorSpecificProps.ry,
|
||||
behaviorSpecificProps.rz,
|
||||
behaviorSpecificProps.rw
|
||||
),
|
||||
Jolt.EActivation_DontActivate
|
||||
);
|
||||
}
|
||||
if (
|
||||
behaviorSpecificProps.lvx !== undefined &&
|
||||
behaviorSpecificProps.lvy !== undefined &&
|
||||
behaviorSpecificProps.lvz !== undefined
|
||||
) {
|
||||
if (this._body) {
|
||||
this._sharedData.bodyInterface.SetLinearVelocity(
|
||||
this._body.GetID(),
|
||||
this.getVec3(
|
||||
behaviorSpecificProps.lvx,
|
||||
behaviorSpecificProps.lvy,
|
||||
behaviorSpecificProps.lvz
|
||||
)
|
||||
);
|
||||
}
|
||||
this._sharedData.bodyInterface.SetLinearVelocity(
|
||||
this._body.GetID(),
|
||||
this.getVec3(
|
||||
behaviorSpecificProps.lvx,
|
||||
behaviorSpecificProps.lvy,
|
||||
behaviorSpecificProps.lvz
|
||||
)
|
||||
);
|
||||
}
|
||||
if (
|
||||
behaviorSpecificProps.avx !== undefined &&
|
||||
behaviorSpecificProps.avy !== undefined &&
|
||||
behaviorSpecificProps.avz !== undefined
|
||||
) {
|
||||
if (this._body) {
|
||||
this._sharedData.bodyInterface.SetAngularVelocity(
|
||||
this._body.GetID(),
|
||||
this.getVec3(
|
||||
behaviorSpecificProps.avx,
|
||||
behaviorSpecificProps.avy,
|
||||
behaviorSpecificProps.avz
|
||||
)
|
||||
);
|
||||
}
|
||||
}
|
||||
if (behaviorSpecificProps.layers !== undefined) {
|
||||
this.layers = behaviorSpecificProps.layers;
|
||||
}
|
||||
if (behaviorSpecificProps.masks !== undefined) {
|
||||
this.masks = behaviorSpecificProps.masks;
|
||||
this._sharedData.bodyInterface.SetAngularVelocity(
|
||||
this._body.GetID(),
|
||||
this.getVec3(
|
||||
behaviorSpecificProps.avx,
|
||||
behaviorSpecificProps.avy,
|
||||
behaviorSpecificProps.avz
|
||||
)
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -921,31 +924,58 @@ namespace gdjs {
|
||||
this.updateBodyFromObject();
|
||||
}
|
||||
|
||||
recreateBody() {
|
||||
if (!this._body) {
|
||||
this._createBody();
|
||||
return;
|
||||
}
|
||||
|
||||
recreateBody(previousBodyData?: {
|
||||
linearVelocityX: float;
|
||||
linearVelocityY: float;
|
||||
linearVelocityZ: float;
|
||||
angularVelocityX: float;
|
||||
angularVelocityY: float;
|
||||
angularVelocityZ: float;
|
||||
}) {
|
||||
const bodyInterface = this._sharedData.bodyInterface;
|
||||
const linearVelocity = this._body.GetLinearVelocity();
|
||||
const linearVelocityX = linearVelocity.GetX();
|
||||
const linearVelocityY = linearVelocity.GetY();
|
||||
const linearVelocityZ = linearVelocity.GetZ();
|
||||
const angularVelocity = this._body.GetAngularVelocity();
|
||||
const angularVelocityX = angularVelocity.GetX();
|
||||
const angularVelocityY = angularVelocity.GetY();
|
||||
const angularVelocityZ = angularVelocity.GetZ();
|
||||
const linearVelocityX = previousBodyData
|
||||
? previousBodyData.linearVelocityX
|
||||
: this._body
|
||||
? this._body.GetLinearVelocity().GetX()
|
||||
: 0;
|
||||
const linearVelocityY = previousBodyData
|
||||
? previousBodyData.linearVelocityY
|
||||
: this._body
|
||||
? this._body.GetLinearVelocity().GetY()
|
||||
: 0;
|
||||
const linearVelocityZ = previousBodyData
|
||||
? previousBodyData.linearVelocityZ
|
||||
: this._body
|
||||
? this._body.GetLinearVelocity().GetZ()
|
||||
: 0;
|
||||
const angularVelocityX = previousBodyData
|
||||
? previousBodyData.angularVelocityX
|
||||
: this._body
|
||||
? this._body.GetAngularVelocity().GetX()
|
||||
: 0;
|
||||
const angularVelocityY = previousBodyData
|
||||
? previousBodyData.angularVelocityY
|
||||
: this._body
|
||||
? this._body.GetAngularVelocity().GetY()
|
||||
: 0;
|
||||
const angularVelocityZ = previousBodyData
|
||||
? previousBodyData.angularVelocityZ
|
||||
: this._body
|
||||
? this._body.GetAngularVelocity().GetZ()
|
||||
: 0;
|
||||
|
||||
this.bodyUpdater.destroyBody();
|
||||
this._contactsEndedThisFrame.length = 0;
|
||||
this._contactsStartedThisFrame.length = 0;
|
||||
this._currentContacts.length = 0;
|
||||
if (this._body) {
|
||||
this.bodyUpdater.destroyBody();
|
||||
this._contactsEndedThisFrame.length = 0;
|
||||
this._contactsStartedThisFrame.length = 0;
|
||||
this._currentContacts.length = 0;
|
||||
}
|
||||
|
||||
this._createBody();
|
||||
if (!this._body) {
|
||||
return;
|
||||
}
|
||||
|
||||
const bodyID = this._body.GetID();
|
||||
bodyInterface.SetLinearVelocity(
|
||||
bodyID,
|
||||
|
@@ -12,6 +12,7 @@ namespace gdjs {
|
||||
etm: float;
|
||||
esm: float;
|
||||
ei: float;
|
||||
es: float;
|
||||
}
|
||||
|
||||
export interface PhysicsCar3DNetworkSyncData extends BehaviorNetworkSyncData {
|
||||
@@ -96,7 +97,7 @@ namespace gdjs {
|
||||
// This is useful when the object is synchronized by an external source
|
||||
// like in a multiplayer game, and we want to be able to predict the
|
||||
// movement of the object, even if the inputs are not updated every frame.
|
||||
private _dontClearInputsBetweenFrames: boolean = false;
|
||||
private _clearInputsBetweenFrames: boolean = true;
|
||||
|
||||
constructor(
|
||||
instanceContainer: gdjs.RuntimeInstanceContainer,
|
||||
@@ -168,12 +169,37 @@ namespace gdjs {
|
||||
this._isHookedToPhysicsStep = true;
|
||||
}
|
||||
|
||||
// Destroy the body before switching the bodyUpdater,
|
||||
// to ensure the body of the previous bodyUpdater is not left alive.
|
||||
// (would be a memory leak and would create a phantom body in the physics world)
|
||||
// But transfer the linear and angular velocity to the new body,
|
||||
// so the body doesn't stop when it is recreated.
|
||||
let previousBodyData = {
|
||||
linearVelocityX: 0,
|
||||
linearVelocityY: 0,
|
||||
linearVelocityZ: 0,
|
||||
angularVelocityX: 0,
|
||||
angularVelocityY: 0,
|
||||
angularVelocityZ: 0,
|
||||
};
|
||||
if (behavior._body) {
|
||||
const linearVelocity = behavior._body.GetLinearVelocity();
|
||||
previousBodyData.linearVelocityX = linearVelocity.GetX();
|
||||
previousBodyData.linearVelocityY = linearVelocity.GetY();
|
||||
previousBodyData.linearVelocityZ = linearVelocity.GetZ();
|
||||
const angularVelocity = behavior._body.GetAngularVelocity();
|
||||
previousBodyData.angularVelocityX = angularVelocity.GetX();
|
||||
previousBodyData.angularVelocityY = angularVelocity.GetY();
|
||||
previousBodyData.angularVelocityZ = angularVelocity.GetZ();
|
||||
behavior.bodyUpdater.destroyBody();
|
||||
}
|
||||
|
||||
behavior.bodyUpdater =
|
||||
new gdjs.PhysicsCar3DRuntimeBehavior.VehicleBodyUpdater(
|
||||
this,
|
||||
behavior.bodyUpdater
|
||||
);
|
||||
behavior.recreateBody();
|
||||
behavior.recreateBody(previousBodyData);
|
||||
|
||||
return this._physics3D;
|
||||
}
|
||||
@@ -273,13 +299,15 @@ namespace gdjs {
|
||||
return true;
|
||||
}
|
||||
|
||||
override getNetworkSyncData(): PhysicsCar3DNetworkSyncData {
|
||||
override getNetworkSyncData(
|
||||
syncOptions: GetNetworkSyncDataOptions
|
||||
): PhysicsCar3DNetworkSyncData {
|
||||
// This method is called, so we are synchronizing this object.
|
||||
// Let's clear the inputs between frames as we control it.
|
||||
this._dontClearInputsBetweenFrames = false;
|
||||
this._clearInputsBetweenFrames = true;
|
||||
|
||||
return {
|
||||
...super.getNetworkSyncData(),
|
||||
...super.getNetworkSyncData(syncOptions),
|
||||
props: {
|
||||
lek: this._wasLeftKeyPressed,
|
||||
rik: this._wasRightKeyPressed,
|
||||
@@ -291,14 +319,16 @@ namespace gdjs {
|
||||
etm: this._engineTorqueMax,
|
||||
esm: this._engineSpeedMax,
|
||||
ei: this._engineInertia,
|
||||
es: this.getEngineSpeed(),
|
||||
},
|
||||
};
|
||||
}
|
||||
|
||||
override updateFromNetworkSyncData(
|
||||
networkSyncData: PhysicsCar3DNetworkSyncData
|
||||
networkSyncData: PhysicsCar3DNetworkSyncData,
|
||||
options: UpdateFromNetworkSyncDataOptions
|
||||
) {
|
||||
super.updateFromNetworkSyncData(networkSyncData);
|
||||
super.updateFromNetworkSyncData(networkSyncData, options);
|
||||
|
||||
const behaviorSpecificProps = networkSyncData.props;
|
||||
this._hasPressedForwardKey = behaviorSpecificProps.upk;
|
||||
@@ -311,9 +341,15 @@ namespace gdjs {
|
||||
this._engineTorqueMax = behaviorSpecificProps.etm;
|
||||
this._engineSpeedMax = behaviorSpecificProps.esm;
|
||||
this._engineInertia = behaviorSpecificProps.ei;
|
||||
if (this._vehicleController) {
|
||||
this._vehicleController
|
||||
.GetEngine()
|
||||
.SetCurrentRPM(behaviorSpecificProps.es);
|
||||
}
|
||||
|
||||
// When the object is synchronized from the network, the inputs must not be cleared.
|
||||
this._dontClearInputsBetweenFrames = true;
|
||||
// When the object is synchronized from the network, the inputs must not be cleared,
|
||||
// except if asked specifically.
|
||||
this._clearInputsBetweenFrames = !!options.clearInputs;
|
||||
}
|
||||
|
||||
_getPhysicsPosition(result: Jolt.RVec3): Jolt.RVec3 {
|
||||
@@ -490,7 +526,7 @@ namespace gdjs {
|
||||
this._previousAcceleratorStickForce = this._acceleratorStickForce;
|
||||
this._previousSteeringStickForce = this._steeringStickForce;
|
||||
|
||||
if (!this._dontClearInputsBetweenFrames) {
|
||||
if (this._clearInputsBetweenFrames) {
|
||||
this._hasPressedForwardKey = false;
|
||||
this._hasPressedBackwardKey = false;
|
||||
this._hasPressedRightKey = false;
|
||||
|
@@ -2,11 +2,24 @@
|
||||
|
||||
namespace gdjs {
|
||||
interface PhysicsCharacter3DNetworkSyncDataType {
|
||||
sma: float;
|
||||
shm: float;
|
||||
grav: float;
|
||||
mfs: float;
|
||||
facc: float;
|
||||
fdec: float;
|
||||
fsm: float;
|
||||
sacc: float;
|
||||
sdec: float;
|
||||
ssm: float;
|
||||
jumpspeed: float;
|
||||
jumpsustime: float;
|
||||
sbpa: boolean;
|
||||
fwa: float;
|
||||
fws: float;
|
||||
sws: float;
|
||||
fs: float;
|
||||
js: float;
|
||||
cfs: float;
|
||||
cjs: float;
|
||||
cj: boolean;
|
||||
lek: boolean;
|
||||
rik: boolean;
|
||||
@@ -102,7 +115,7 @@ namespace gdjs {
|
||||
// This is useful when the object is synchronized by an external source
|
||||
// like in a multiplayer game, and we want to be able to predict the
|
||||
// movement of the object, even if the inputs are not updated every frame.
|
||||
private _dontClearInputsBetweenFrames: boolean = false;
|
||||
private _clearInputsBetweenFrames: boolean = true;
|
||||
|
||||
/**
|
||||
* A very small value compare to 1 pixel, yet very huge compare to rounding errors.
|
||||
@@ -207,10 +220,35 @@ namespace gdjs {
|
||||
this._isHookedToPhysicsStep = true;
|
||||
}
|
||||
|
||||
// Destroy the body before switching the bodyUpdater,
|
||||
// to ensure the body of the previous bodyUpdater is not left alive.
|
||||
// (would be a memory leak and would create a phantom body in the physics world)
|
||||
// But transfer the linear and angular velocity to the new body,
|
||||
// so the body doesn't stop when it is recreated.
|
||||
let previousBodyData = {
|
||||
linearVelocityX: 0,
|
||||
linearVelocityY: 0,
|
||||
linearVelocityZ: 0,
|
||||
angularVelocityX: 0,
|
||||
angularVelocityY: 0,
|
||||
angularVelocityZ: 0,
|
||||
};
|
||||
if (behavior._body) {
|
||||
const linearVelocity = behavior._body.GetLinearVelocity();
|
||||
previousBodyData.linearVelocityX = linearVelocity.GetX();
|
||||
previousBodyData.linearVelocityY = linearVelocity.GetY();
|
||||
previousBodyData.linearVelocityZ = linearVelocity.GetZ();
|
||||
const angularVelocity = behavior._body.GetAngularVelocity();
|
||||
previousBodyData.angularVelocityX = angularVelocity.GetX();
|
||||
previousBodyData.angularVelocityY = angularVelocity.GetY();
|
||||
previousBodyData.angularVelocityZ = angularVelocity.GetZ();
|
||||
behavior.bodyUpdater.destroyBody();
|
||||
}
|
||||
|
||||
behavior.bodyUpdater =
|
||||
new gdjs.PhysicsCharacter3DRuntimeBehavior.CharacterBodyUpdater(this);
|
||||
behavior.collisionChecker = this.collisionChecker;
|
||||
behavior.recreateBody();
|
||||
behavior.recreateBody(previousBodyData);
|
||||
|
||||
// Always begin in the direction of the object.
|
||||
this._forwardAngle = this.owner.getAngle();
|
||||
@@ -277,19 +315,34 @@ namespace gdjs {
|
||||
return true;
|
||||
}
|
||||
|
||||
override getNetworkSyncData(): PhysicsCharacter3DNetworkSyncData {
|
||||
override getNetworkSyncData(
|
||||
options: GetNetworkSyncDataOptions
|
||||
): PhysicsCharacter3DNetworkSyncData {
|
||||
// This method is called, so we are synchronizing this object.
|
||||
// Let's clear the inputs between frames as we control it.
|
||||
this._dontClearInputsBetweenFrames = false;
|
||||
this._clearInputsBetweenFrames = true;
|
||||
|
||||
return {
|
||||
...super.getNetworkSyncData(),
|
||||
...super.getNetworkSyncData(options),
|
||||
props: {
|
||||
sma: this._slopeMaxAngle,
|
||||
shm: this._stairHeightMax,
|
||||
grav: this._gravity,
|
||||
mfs: this._maxFallingSpeed,
|
||||
facc: this._forwardAcceleration,
|
||||
fdec: this._forwardDeceleration,
|
||||
fsm: this._forwardSpeedMax,
|
||||
sacc: this._sidewaysAcceleration,
|
||||
sdec: this._sidewaysDeceleration,
|
||||
ssm: this._sidewaysSpeedMax,
|
||||
jumpspeed: this._jumpSpeed,
|
||||
jumpsustime: this._jumpSustainTime,
|
||||
fwa: this._forwardAngle,
|
||||
sbpa: this._shouldBindObjectAndForwardAngle,
|
||||
fws: this._currentForwardSpeed,
|
||||
sws: this._currentSidewaysSpeed,
|
||||
fs: this._currentFallSpeed,
|
||||
js: this._currentJumpSpeed,
|
||||
cfs: this._currentFallSpeed,
|
||||
cjs: this._currentJumpSpeed,
|
||||
cj: this._canJump,
|
||||
lek: this._wasLeftKeyPressed,
|
||||
rik: this._wasRightKeyPressed,
|
||||
@@ -306,16 +359,30 @@ namespace gdjs {
|
||||
}
|
||||
|
||||
override updateFromNetworkSyncData(
|
||||
networkSyncData: PhysicsCharacter3DNetworkSyncData
|
||||
networkSyncData: PhysicsCharacter3DNetworkSyncData,
|
||||
options: UpdateFromNetworkSyncDataOptions
|
||||
) {
|
||||
super.updateFromNetworkSyncData(networkSyncData);
|
||||
super.updateFromNetworkSyncData(networkSyncData, options);
|
||||
|
||||
const behaviorSpecificProps = networkSyncData.props;
|
||||
this._slopeMaxAngle = behaviorSpecificProps.sma;
|
||||
this._stairHeightMax = behaviorSpecificProps.shm;
|
||||
this._gravity = behaviorSpecificProps.grav;
|
||||
this._maxFallingSpeed = behaviorSpecificProps.mfs;
|
||||
this._forwardAcceleration = behaviorSpecificProps.facc;
|
||||
this._forwardDeceleration = behaviorSpecificProps.fdec;
|
||||
this._forwardSpeedMax = behaviorSpecificProps.fsm;
|
||||
this._sidewaysAcceleration = behaviorSpecificProps.sacc;
|
||||
this._sidewaysDeceleration = behaviorSpecificProps.sdec;
|
||||
this._sidewaysSpeedMax = behaviorSpecificProps.ssm;
|
||||
this._jumpSpeed = behaviorSpecificProps.jumpspeed;
|
||||
this._jumpSustainTime = behaviorSpecificProps.jumpsustime;
|
||||
this._forwardAngle = behaviorSpecificProps.fwa;
|
||||
this._shouldBindObjectAndForwardAngle = behaviorSpecificProps.sbpa;
|
||||
this._currentForwardSpeed = behaviorSpecificProps.fws;
|
||||
this._currentSidewaysSpeed = behaviorSpecificProps.sws;
|
||||
this._currentFallSpeed = behaviorSpecificProps.fs;
|
||||
this._currentJumpSpeed = behaviorSpecificProps.js;
|
||||
this._currentFallSpeed = behaviorSpecificProps.cfs;
|
||||
this._currentJumpSpeed = behaviorSpecificProps.cjs;
|
||||
this._canJump = behaviorSpecificProps.cj;
|
||||
this._hasPressedForwardKey = behaviorSpecificProps.upk;
|
||||
this._hasPressedBackwardKey = behaviorSpecificProps.dok;
|
||||
@@ -328,8 +395,8 @@ namespace gdjs {
|
||||
this._timeSinceCurrentJumpStart = behaviorSpecificProps.tscjs;
|
||||
this._jumpKeyHeldSinceJumpStart = behaviorSpecificProps.jkhsjs;
|
||||
|
||||
// When the object is synchronized from the network, the inputs must not be cleared.
|
||||
this._dontClearInputsBetweenFrames = true;
|
||||
// Clear user inputs between frames only if requested.
|
||||
this._clearInputsBetweenFrames = !!options.clearInputs;
|
||||
}
|
||||
|
||||
_getPhysicsPosition(result: Jolt.RVec3): Jolt.RVec3 {
|
||||
@@ -650,7 +717,7 @@ namespace gdjs {
|
||||
this._wasJumpKeyPressed = this._hasPressedJumpKey;
|
||||
this._wasStickUsed = this._hasUsedStick;
|
||||
|
||||
if (!this._dontClearInputsBetweenFrames) {
|
||||
if (this._clearInputsBetweenFrames) {
|
||||
this._hasPressedForwardKey = false;
|
||||
this._hasPressedBackwardKey = false;
|
||||
this._hasPressedRightKey = false;
|
||||
|
@@ -147,7 +147,7 @@ namespace gdjs {
|
||||
// This is useful when the object is synchronized by an external source
|
||||
// like in a multiplayer game, and we want to be able to predict the
|
||||
// movement of the object, even if the inputs are not updated every frame.
|
||||
_dontClearInputsBetweenFrames: boolean = false;
|
||||
private _clearInputsBetweenFrames: boolean = true;
|
||||
// This is useful when the object is synchronized over the network,
|
||||
// object is controlled by the network and we want to ensure the current player
|
||||
// cannot control it.
|
||||
@@ -227,14 +227,16 @@ namespace gdjs {
|
||||
this._state = this._falling;
|
||||
}
|
||||
|
||||
getNetworkSyncData(): PlatformerObjectNetworkSyncData {
|
||||
getNetworkSyncData(
|
||||
syncOptions: GetNetworkSyncDataOptions
|
||||
): PlatformerObjectNetworkSyncData {
|
||||
// This method is called, so we are synchronizing this object.
|
||||
// Let's clear the inputs between frames as we control it.
|
||||
this._dontClearInputsBetweenFrames = false;
|
||||
this._clearInputsBetweenFrames = true;
|
||||
this._ignoreDefaultControlsAsSyncedByNetwork = false;
|
||||
|
||||
return {
|
||||
...super.getNetworkSyncData(),
|
||||
...super.getNetworkSyncData(syncOptions),
|
||||
props: {
|
||||
cs: this._currentSpeed,
|
||||
|
||||
@@ -263,11 +265,52 @@ namespace gdjs {
|
||||
}
|
||||
|
||||
updateFromNetworkSyncData(
|
||||
networkSyncData: PlatformerObjectNetworkSyncData
|
||||
networkSyncData: PlatformerObjectNetworkSyncData,
|
||||
options: UpdateFromNetworkSyncDataOptions
|
||||
) {
|
||||
super.updateFromNetworkSyncData(networkSyncData);
|
||||
super.updateFromNetworkSyncData(networkSyncData, options);
|
||||
|
||||
const behaviorSpecificProps = networkSyncData.props;
|
||||
|
||||
switch (behaviorSpecificProps.sn) {
|
||||
case 'Falling':
|
||||
if (behaviorSpecificProps.sn !== this._state.toString()) {
|
||||
this._setFalling();
|
||||
}
|
||||
this._falling.updateFromNetworkSyncData(behaviorSpecificProps.ssd);
|
||||
break;
|
||||
case 'OnFloor':
|
||||
// Let it handle automatically as we don't know which platform to land on.
|
||||
// @ts-ignore - we assume it's OnFloorStateNetworkSyncData
|
||||
this._onFloor.updateFromNetworkSyncData(behaviorSpecificProps.ssd);
|
||||
break;
|
||||
case 'Jumping':
|
||||
if (behaviorSpecificProps.sn !== this._state.toString()) {
|
||||
this._setJumping();
|
||||
}
|
||||
// @ts-ignore - we assume it's JumpingStateNetworkSyncData
|
||||
this._jumping.updateFromNetworkSyncData(behaviorSpecificProps.ssd);
|
||||
break;
|
||||
case 'GrabbingPlatform':
|
||||
// Let it handle automatically as we don't know which platform to grab.
|
||||
this._grabbingPlatform.updateFromNetworkSyncData(
|
||||
// @ts-ignore - we assume it's GrabbingPlatformStateNetworkSyncData
|
||||
behaviorSpecificProps.ssd
|
||||
);
|
||||
break;
|
||||
case 'OnLadder':
|
||||
if (behaviorSpecificProps.sn !== this._state.toString()) {
|
||||
this._setOnLadder();
|
||||
}
|
||||
this._onLadder.updateFromNetworkSyncData(behaviorSpecificProps.ssd);
|
||||
break;
|
||||
default:
|
||||
console.error(
|
||||
'Unknown state name: ' + behaviorSpecificProps.sn + '.'
|
||||
);
|
||||
break;
|
||||
}
|
||||
|
||||
if (behaviorSpecificProps.cs !== this._currentSpeed) {
|
||||
this._currentSpeed = behaviorSpecificProps.cs;
|
||||
}
|
||||
@@ -317,39 +360,10 @@ namespace gdjs {
|
||||
this._jumpKeyHeldSinceJumpStart = behaviorSpecificProps.jkhsjs;
|
||||
}
|
||||
|
||||
if (behaviorSpecificProps.sn !== this._state.toString()) {
|
||||
switch (behaviorSpecificProps.sn) {
|
||||
case 'Falling':
|
||||
this._setFalling();
|
||||
break;
|
||||
case 'OnFloor':
|
||||
// Let it handle automatically as we don't know which platform to land on.
|
||||
break;
|
||||
case 'Jumping':
|
||||
this._setJumping();
|
||||
break;
|
||||
case 'GrabbingPlatform':
|
||||
// Let it handle automatically as we don't know which platform to grab.
|
||||
break;
|
||||
case 'OnLadder':
|
||||
this._setOnLadder();
|
||||
break;
|
||||
default:
|
||||
console.error(
|
||||
'Unknown state name: ' + behaviorSpecificProps.sn + '.'
|
||||
);
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
if (behaviorSpecificProps.sn === this._state.toString()) {
|
||||
this._state.updateFromNetworkSyncData(behaviorSpecificProps.ssd);
|
||||
}
|
||||
|
||||
// When the object is synchronized from the network, the inputs must not be cleared.
|
||||
this._dontClearInputsBetweenFrames = true;
|
||||
// Clear user inputs between frames only if requested.
|
||||
this._clearInputsBetweenFrames = !!options.clearInputs;
|
||||
// And we are not using the default controls.
|
||||
this._ignoreDefaultControlsAsSyncedByNetwork = true;
|
||||
this._ignoreDefaultControlsAsSyncedByNetwork = !options.keepControl;
|
||||
}
|
||||
|
||||
updateFromBehaviorData(oldBehaviorData, newBehaviorData): boolean {
|
||||
@@ -545,8 +559,9 @@ namespace gdjs {
|
||||
this._wasJumpKeyPressed = this._jumpKey;
|
||||
this._wasReleasePlatformKeyPressed = this._releasePlatformKey;
|
||||
this._wasReleaseLadderKeyPressed = this._releaseLadderKey;
|
||||
|
||||
//4) Do not forget to reset pressed keys
|
||||
if (!this._dontClearInputsBetweenFrames) {
|
||||
if (this._clearInputsBetweenFrames) {
|
||||
// Reset the keys only if the inputs are not supposed to survive between frames.
|
||||
// (Most of the time, except if this object is synchronized by an external source)
|
||||
this._leftKey = false;
|
||||
|
@@ -157,6 +157,57 @@ namespace gdjs {
|
||||
return true;
|
||||
}
|
||||
|
||||
trackChangesAndUpdateManagerIfNeeded() {
|
||||
if (!this.activated() && this._registeredInManager) {
|
||||
this._manager.removePlatform(this);
|
||||
this._registeredInManager = false;
|
||||
} else {
|
||||
if (this.activated() && !this._registeredInManager) {
|
||||
this._manager.addPlatform(this);
|
||||
this._registeredInManager = true;
|
||||
}
|
||||
}
|
||||
|
||||
if (
|
||||
this._oldX !== this.owner.getX() ||
|
||||
this._oldY !== this.owner.getY() ||
|
||||
this._oldWidth !== this.owner.getWidth() ||
|
||||
this._oldHeight !== this.owner.getHeight() ||
|
||||
this._oldAngle !== this.owner.getAngle()
|
||||
) {
|
||||
if (this._registeredInManager) {
|
||||
this._manager.removePlatform(this);
|
||||
this._manager.addPlatform(this);
|
||||
}
|
||||
this._oldX = this.owner.getX();
|
||||
this._oldY = this.owner.getY();
|
||||
this._oldWidth = this.owner.getWidth();
|
||||
this._oldHeight = this.owner.getHeight();
|
||||
this._oldAngle = this.owner.getAngle();
|
||||
}
|
||||
}
|
||||
|
||||
getNetworkSyncData(
|
||||
syncOptions: GetNetworkSyncDataOptions
|
||||
): BehaviorNetworkSyncData {
|
||||
return super.getNetworkSyncData(syncOptions);
|
||||
}
|
||||
|
||||
updateFromNetworkSyncData(
|
||||
networkSyncData: BehaviorNetworkSyncData,
|
||||
options: UpdateFromNetworkSyncDataOptions
|
||||
): void {
|
||||
super.updateFromNetworkSyncData(networkSyncData, options);
|
||||
|
||||
this.trackChangesAndUpdateManagerIfNeeded();
|
||||
}
|
||||
|
||||
onCreated(): void {
|
||||
// Register it right away if activated,
|
||||
// so it can be used by platformer objects in that same frame.
|
||||
this.trackChangesAndUpdateManagerIfNeeded();
|
||||
}
|
||||
|
||||
onDestroy() {
|
||||
if (this._manager && this._registeredInManager) {
|
||||
this._manager.removePlatform(this);
|
||||
@@ -175,34 +226,7 @@ namespace gdjs {
|
||||
}*/
|
||||
|
||||
//Make sure the platform is or is not in the platforms manager.
|
||||
if (!this.activated() && this._registeredInManager) {
|
||||
this._manager.removePlatform(this);
|
||||
this._registeredInManager = false;
|
||||
} else {
|
||||
if (this.activated() && !this._registeredInManager) {
|
||||
this._manager.addPlatform(this);
|
||||
this._registeredInManager = true;
|
||||
}
|
||||
}
|
||||
|
||||
//Track changes in size or position
|
||||
if (
|
||||
this._oldX !== this.owner.getX() ||
|
||||
this._oldY !== this.owner.getY() ||
|
||||
this._oldWidth !== this.owner.getWidth() ||
|
||||
this._oldHeight !== this.owner.getHeight() ||
|
||||
this._oldAngle !== this.owner.getAngle()
|
||||
) {
|
||||
if (this._registeredInManager) {
|
||||
this._manager.removePlatform(this);
|
||||
this._manager.addPlatform(this);
|
||||
}
|
||||
this._oldX = this.owner.getX();
|
||||
this._oldY = this.owner.getY();
|
||||
this._oldWidth = this.owner.getWidth();
|
||||
this._oldHeight = this.owner.getHeight();
|
||||
this._oldAngle = this.owner.getAngle();
|
||||
}
|
||||
this.trackChangesAndUpdateManagerIfNeeded();
|
||||
}
|
||||
|
||||
doStepPostEvents(instanceContainer: gdjs.RuntimeInstanceContainer) {}
|
||||
|
@@ -37,6 +37,24 @@ namespace gdjs {
|
||||
|
||||
export type ShapePainterObjectData = ObjectData & ShapePainterObjectDataType;
|
||||
|
||||
type ShapePainterNetworkSyncDataType = {
|
||||
cbf: boolean; // clearBetweenFrames
|
||||
aa: Antialiasing; // antialiasing
|
||||
ac: boolean; // absoluteCoordinates
|
||||
fc: integer; // fillColor
|
||||
oc: integer; // outlineColor
|
||||
os: float; // outlineSize
|
||||
fo: float; // fillOpacity
|
||||
oo: float; // outlineOpacity
|
||||
scaleX: number;
|
||||
scaleY: number;
|
||||
ifx: boolean; // isFlippedX
|
||||
ify: boolean; // isFlippedY
|
||||
};
|
||||
|
||||
export type ShapePainterNetworkSyncData = ObjectNetworkSyncData &
|
||||
ShapePainterNetworkSyncDataType;
|
||||
|
||||
/**
|
||||
* The ShapePainterRuntimeObject allows to draw graphics shapes on screen.
|
||||
*/
|
||||
@@ -191,6 +209,70 @@ namespace gdjs {
|
||||
return true;
|
||||
}
|
||||
|
||||
getNetworkSyncData(
|
||||
syncOptions: GetNetworkSyncDataOptions
|
||||
): ShapePainterNetworkSyncData {
|
||||
return {
|
||||
...super.getNetworkSyncData(syncOptions),
|
||||
cbf: this._clearBetweenFrames,
|
||||
aa: this._antialiasing,
|
||||
ac: this._useAbsoluteCoordinates,
|
||||
fc: this._fillColor,
|
||||
oc: this._outlineColor,
|
||||
os: this._outlineSize,
|
||||
fo: this._fillOpacity,
|
||||
oo: this._outlineOpacity,
|
||||
scaleX: this.getScaleX(),
|
||||
scaleY: this.getScaleY(),
|
||||
ifx: this._flippedX,
|
||||
ify: this._flippedY,
|
||||
};
|
||||
}
|
||||
|
||||
updateFromNetworkSyncData(
|
||||
networkSyncData: ShapePainterNetworkSyncData,
|
||||
options: UpdateFromNetworkSyncDataOptions
|
||||
): void {
|
||||
super.updateFromNetworkSyncData(networkSyncData, options);
|
||||
|
||||
if (networkSyncData.cbf !== undefined) {
|
||||
this._clearBetweenFrames = networkSyncData.cbf;
|
||||
}
|
||||
if (networkSyncData.aa !== undefined) {
|
||||
this.setAntialiasing(networkSyncData.aa);
|
||||
}
|
||||
if (networkSyncData.ac !== undefined) {
|
||||
this.setCoordinatesRelative(!networkSyncData.ac);
|
||||
}
|
||||
if (networkSyncData.fc !== undefined) {
|
||||
this._fillColor = networkSyncData.fc;
|
||||
}
|
||||
if (networkSyncData.oc !== undefined) {
|
||||
this._outlineColor = networkSyncData.oc;
|
||||
}
|
||||
if (networkSyncData.os !== undefined) {
|
||||
this.setOutlineSize(networkSyncData.os);
|
||||
}
|
||||
if (networkSyncData.fo !== undefined) {
|
||||
this.setFillOpacity(networkSyncData.fo);
|
||||
}
|
||||
if (networkSyncData.oo !== undefined) {
|
||||
this.setOutlineOpacity(networkSyncData.oo);
|
||||
}
|
||||
if (networkSyncData.scaleX !== undefined) {
|
||||
this.setScaleX(networkSyncData.scaleX);
|
||||
}
|
||||
if (networkSyncData.scaleY !== undefined) {
|
||||
this.setScaleY(networkSyncData.scaleY);
|
||||
}
|
||||
if (networkSyncData.ifx !== undefined) {
|
||||
this.flipX(networkSyncData.ifx);
|
||||
}
|
||||
if (networkSyncData.ify !== undefined) {
|
||||
this.flipY(networkSyncData.ify);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Initialize the extra parameters that could be set for an instance.
|
||||
* @param initialInstanceData The extra parameters
|
||||
|
488
Extensions/SaveState/JsExtension.js
Normal file
488
Extensions/SaveState/JsExtension.js
Normal file
@@ -0,0 +1,488 @@
|
||||
//@ts-check
|
||||
/// <reference path="../JsExtensionTypes.d.ts" />
|
||||
/**
|
||||
* This is a declaration of an extension for GDevelop 5.
|
||||
*
|
||||
* ℹ️ Changes in this file are watched and automatically imported if the editor
|
||||
* is running. You can also manually run `node import-GDJS-Runtime.js` (in newIDE/app/scripts).
|
||||
*
|
||||
* The file must be named "JsExtension.js", otherwise GDevelop won't load it.
|
||||
* ⚠️ If you make a change and the extension is not loaded, open the developer console
|
||||
* and search for any errors.
|
||||
*
|
||||
* More information on https://github.com/4ian/GDevelop/blob/master/newIDE/README-extensions.md
|
||||
*/
|
||||
|
||||
/** @type {ExtensionModule} */
|
||||
module.exports = {
|
||||
createExtension: function (_, gd) {
|
||||
const extension = new gd.PlatformExtension();
|
||||
extension
|
||||
.setExtensionInformation(
|
||||
'SaveState',
|
||||
_('Save State (experimental)'),
|
||||
_(
|
||||
'Allows to save and load the full state of a game, usually on the device storage. A Save State, by default, contains the full state of the game (objects, variables, sounds, music, effects etc.). Using the "Save Configuration" behavior, you can customize which objects should not be saved in a Save State. You can also use the "Change the save configuration of a variable" action to change the save configuration of a variable. Finally, both objects, variables and scene/game data can be given a profile name: in this case, when saving or loading with one or more profile names specified, only the object/variables/data belonging to one of the specified profiles will be saved or loaded.'
|
||||
),
|
||||
'Neyl Mahfouf',
|
||||
'Open source (MIT License)'
|
||||
)
|
||||
.setExtensionHelpPath('/all-features/save-state')
|
||||
.setCategory('Game mechanic')
|
||||
.addInstructionOrExpressionGroupMetadata(_('Save State (experimental)'))
|
||||
.setIcon('res/actions/saveDown.svg');
|
||||
|
||||
extension
|
||||
.addAction(
|
||||
'CreateGameSaveStateInVariable',
|
||||
_('Save game to a variable'),
|
||||
_(
|
||||
'Create a Save State and save it to a variable. This is for advanced usage, prefer to use "Save game to device storage" in most cases.'
|
||||
),
|
||||
_('Save game in variable _PARAM1_ (profile(s): _PARAM2_)'),
|
||||
_('Save'),
|
||||
'res/actions/saveDown.svg',
|
||||
'res/actions/saveDown.svg'
|
||||
)
|
||||
.addCodeOnlyParameter('currentScene', '')
|
||||
.addParameter('variable', _('Variable to store the save to'), '', false)
|
||||
.addParameter('string', _('Profile(s) to save'), '', true)
|
||||
.setDefaultValue('"default"')
|
||||
.setParameterLongDescription(
|
||||
_(
|
||||
'Comma-separated list of profile names that must be saved. Only objects tagged with at least one of these profiles will be saved. If no profile names are specified, all objects will be saved (unless they have a "Save Configuration" behavior set to "Do not save").'
|
||||
)
|
||||
)
|
||||
.getCodeExtraInformation()
|
||||
.setIncludeFile('Extensions/SaveState/SaveStateTools.js')
|
||||
.addIncludeFile(
|
||||
'Extensions/SaveState/SaveConfigurationRuntimeBehavior.js'
|
||||
)
|
||||
.setFunctionName('gdjs.saveState.createGameSaveStateInVariable');
|
||||
|
||||
extension
|
||||
.addAction(
|
||||
'CreateGameSaveStateInStorage',
|
||||
_('Save game to device storage'),
|
||||
_('Create a Save State and save it to device storage.'),
|
||||
_('Save game to device storage named _PARAM1_ (profile(s): _PARAM2_)'),
|
||||
_('Save'),
|
||||
'res/actions/saveDown.svg',
|
||||
'res/actions/saveDown.svg'
|
||||
)
|
||||
.addCodeOnlyParameter('currentScene', '')
|
||||
.addParameter('string', _('Storage key to save to'), '', false)
|
||||
.addParameter('string', _('Profile(s) to save'), '', true)
|
||||
.setDefaultValue('"default"')
|
||||
.setParameterLongDescription(
|
||||
_(
|
||||
'Comma-separated list of profile names that must be saved. Only objects tagged with at least one of these profiles will be saved. If no profile names are specified, all objects will be saved (unless they have a "Save Configuration" behavior set to "Do not save").'
|
||||
)
|
||||
)
|
||||
.setDefaultValue('no')
|
||||
.getCodeExtraInformation()
|
||||
.setIncludeFile('Extensions/SaveState/SaveStateTools.js')
|
||||
.addIncludeFile(
|
||||
'Extensions/SaveState/SaveConfigurationRuntimeBehavior.js'
|
||||
)
|
||||
.setFunctionName('gdjs.saveState.createGameSaveStateInStorage');
|
||||
|
||||
extension
|
||||
.addAction(
|
||||
'RestoreGameSaveStateFromVariable',
|
||||
_('Load game from variable'),
|
||||
_(
|
||||
'Restore the game from a Save State stored in the specified variable. This is for advanced usage, prefer to use "Load game from device storage" in most cases.'
|
||||
),
|
||||
_(
|
||||
'Load game from variable _PARAM1_ (profile(s): _PARAM2_, stop and restart all the scenes currently played: _PARAM3_)'
|
||||
),
|
||||
_('Load'),
|
||||
'res/actions/saveUp.svg',
|
||||
'res/actions/saveUp.svg'
|
||||
)
|
||||
.addCodeOnlyParameter('currentScene', '')
|
||||
.addParameter('variable', _('Variable to load the game from'), '', false)
|
||||
.addParameter('string', _('Profile(s) to load'), '', true)
|
||||
.setDefaultValue('"default"')
|
||||
.setParameterLongDescription(
|
||||
_(
|
||||
'Comma-separated list of profile names that must be loaded. Only objects tagged with at least one of these profiles will be loaded - others will be left alone. If no profile names are specified, all objects will be loaded (unless they have a "Save Configuration" behavior set to "Do not save").'
|
||||
)
|
||||
)
|
||||
.addParameter(
|
||||
'yesorno',
|
||||
_('Stop and restart all the scenes currently played?'),
|
||||
'',
|
||||
true
|
||||
)
|
||||
.setDefaultValue('no')
|
||||
.getCodeExtraInformation()
|
||||
.setIncludeFile('Extensions/SaveState/SaveStateTools.js')
|
||||
.addIncludeFile(
|
||||
'Extensions/SaveState/SaveConfigurationRuntimeBehavior.js'
|
||||
)
|
||||
.setFunctionName('gdjs.saveState.restoreGameSaveStateFromVariable');
|
||||
|
||||
extension
|
||||
.addAction(
|
||||
'RestoreGameSaveStateFromStorage',
|
||||
_('Load game from device storage'),
|
||||
_('Restore the game from a Save State stored on the device.'),
|
||||
_(
|
||||
'Load game from device storage named _PARAM1_ (profile(s): _PARAM2_, stop and restart all the scenes currently played: _PARAM3_)'
|
||||
),
|
||||
_('Load'),
|
||||
'res/actions/saveUp.svg',
|
||||
'res/actions/saveUp.svg'
|
||||
)
|
||||
.addCodeOnlyParameter('currentScene', '')
|
||||
.addParameter(
|
||||
'string',
|
||||
_('Storage name to load the game from'),
|
||||
'',
|
||||
false
|
||||
)
|
||||
.addParameter('string', _('Profile(s) to load'), '', true)
|
||||
.setDefaultValue('"default"')
|
||||
.setParameterLongDescription(
|
||||
_(
|
||||
'Comma-separated list of profile names that must be loaded. Only objects tagged with at least one of these profiles will be loaded - others will be left alone. If no profile names are specified, all objects will be loaded.'
|
||||
)
|
||||
)
|
||||
.addParameter(
|
||||
'yesorno',
|
||||
_('Stop and restart all the scenes currently played?'),
|
||||
'',
|
||||
true
|
||||
)
|
||||
.setDefaultValue('no')
|
||||
.getCodeExtraInformation()
|
||||
.setIncludeFile('Extensions/SaveState/SaveStateTools.js')
|
||||
.addIncludeFile(
|
||||
'Extensions/SaveState/SaveConfigurationRuntimeBehavior.js'
|
||||
)
|
||||
.setFunctionName('gdjs.saveState.restoreGameSaveStateFromStorage');
|
||||
|
||||
extension
|
||||
.addExpressionAndCondition(
|
||||
'number',
|
||||
'TimeSinceLastSave',
|
||||
_('Time since last save'),
|
||||
_(
|
||||
'Time since the last save, in seconds. Returns -1 if no save happened, and a positive number otherwise.'
|
||||
),
|
||||
_('Time since the last save'),
|
||||
'',
|
||||
'res/actions/saveDown.svg'
|
||||
)
|
||||
.addCodeOnlyParameter('currentScene', '')
|
||||
.useStandardParameters('number', gd.ParameterOptions.makeNewOptions())
|
||||
.setIncludeFile('Extensions/SaveState/SaveStateTools.js')
|
||||
.addIncludeFile(
|
||||
'Extensions/SaveState/SaveConfigurationRuntimeBehavior.js'
|
||||
)
|
||||
.setFunctionName('gdjs.saveState.getSecondsSinceLastSave')
|
||||
.setGetter('gdjs.saveState.getSecondsSinceLastSave');
|
||||
|
||||
extension
|
||||
.addExpressionAndCondition(
|
||||
'number',
|
||||
'TimeSinceLastLoad',
|
||||
_('Time since last load'),
|
||||
_(
|
||||
'Time since the last load, in seconds. Returns -1 if no load happened, and a positive number otherwise.'
|
||||
),
|
||||
_('Time since the last load'),
|
||||
'',
|
||||
'res/actions/saveDown.svg'
|
||||
)
|
||||
.addCodeOnlyParameter('currentScene', '')
|
||||
.useStandardParameters('number', gd.ParameterOptions.makeNewOptions())
|
||||
.setIncludeFile('Extensions/SaveState/SaveStateTools.js')
|
||||
.addIncludeFile(
|
||||
'Extensions/SaveState/SaveConfigurationRuntimeBehavior.js'
|
||||
)
|
||||
.setFunctionName('gdjs.saveState.getSecondsSinceLastLoad')
|
||||
.setGetter('gdjs.saveState.getSecondsSinceLastLoad');
|
||||
|
||||
extension
|
||||
.addCondition(
|
||||
'SaveJustSucceeded',
|
||||
_('Save just succeeded'),
|
||||
_('The last save attempt just succeeded.'),
|
||||
_('Save just succeeded'),
|
||||
_('Save'),
|
||||
'res/actions/saveDown.svg',
|
||||
'res/actions/saveDown.svg'
|
||||
)
|
||||
.addCodeOnlyParameter('currentScene', '')
|
||||
.getCodeExtraInformation()
|
||||
.setIncludeFile('Extensions/SaveState/SaveStateTools.js')
|
||||
.addIncludeFile(
|
||||
'Extensions/SaveState/SaveConfigurationRuntimeBehavior.js'
|
||||
)
|
||||
.setFunctionName('gdjs.saveState.hasSaveJustSucceeded');
|
||||
|
||||
extension
|
||||
.addCondition(
|
||||
'SaveJustFailed',
|
||||
_('Save just failed'),
|
||||
_('The last save attempt just failed.'),
|
||||
_('Save just failed'),
|
||||
_('Save'),
|
||||
'res/actions/saveDown.svg',
|
||||
'res/actions/saveDown.svg'
|
||||
)
|
||||
.addCodeOnlyParameter('currentScene', '')
|
||||
.getCodeExtraInformation()
|
||||
.setIncludeFile('Extensions/SaveState/SaveStateTools.js')
|
||||
.addIncludeFile(
|
||||
'Extensions/SaveState/SaveConfigurationRuntimeBehavior.js'
|
||||
)
|
||||
.setFunctionName('gdjs.saveState.hasSaveJustFailed');
|
||||
|
||||
extension
|
||||
.addCondition(
|
||||
'LoadJustSucceeded',
|
||||
_('Load just succeeded'),
|
||||
_('The last load attempt just succeeded.'),
|
||||
_('Load just succeeded'),
|
||||
_('Load'),
|
||||
'res/actions/saveUp.svg',
|
||||
'res/actions/saveUp.svg'
|
||||
)
|
||||
.addCodeOnlyParameter('currentScene', '')
|
||||
.getCodeExtraInformation()
|
||||
.setIncludeFile('Extensions/SaveState/SaveStateTools.js')
|
||||
.addIncludeFile(
|
||||
'Extensions/SaveState/SaveConfigurationRuntimeBehavior.js'
|
||||
)
|
||||
.setFunctionName('gdjs.saveState.hasLoadJustSucceeded');
|
||||
|
||||
extension
|
||||
.addCondition(
|
||||
'LoadJustFailed',
|
||||
_('Load just failed'),
|
||||
_('The last load attempt just failed.'),
|
||||
_('Load just failed'),
|
||||
_('Load'),
|
||||
'res/actions/saveUp.svg',
|
||||
'res/actions/saveUp.svg'
|
||||
)
|
||||
.addCodeOnlyParameter('currentScene', '')
|
||||
.getCodeExtraInformation()
|
||||
.setIncludeFile('Extensions/SaveState/SaveStateTools.js')
|
||||
.addIncludeFile(
|
||||
'Extensions/SaveState/SaveConfigurationRuntimeBehavior.js'
|
||||
)
|
||||
.setFunctionName('gdjs.saveState.hasLoadJustFailed');
|
||||
|
||||
extension
|
||||
.addAction(
|
||||
'SetVariableSaveConfiguration',
|
||||
_('Change the save configuration of a variable'),
|
||||
_(
|
||||
'Set if a scene or global variable should be saved in the default save state. Also allow to specify one or more profiles in which the variable should be saved.'
|
||||
),
|
||||
_(
|
||||
'Change save configuration of _PARAM1_: save it in the default save states: _PARAM2_ and in profiles: _PARAM3_'
|
||||
),
|
||||
_('Advanced configuration'),
|
||||
'res/actions/saveDown.svg',
|
||||
'res/actions/saveDown.svg'
|
||||
)
|
||||
.addCodeOnlyParameter('currentScene', '')
|
||||
.addParameter(
|
||||
'variable',
|
||||
_('Variable for which configuration should be changed'),
|
||||
'',
|
||||
false
|
||||
)
|
||||
.addParameter('yesorno', _('Persist in default save states'), '', false)
|
||||
.setDefaultValue('yes')
|
||||
.addParameter(
|
||||
'string',
|
||||
_('Profiles in which the variable should be saved'),
|
||||
'',
|
||||
true
|
||||
)
|
||||
.setDefaultValue('')
|
||||
.setParameterLongDescription(
|
||||
_(
|
||||
'Comma-separated list of profile names in which the variable will be saved. When a save state is created with one or more profile names specified, the variable will be saved only if it matches one of these profiles.'
|
||||
)
|
||||
)
|
||||
.getCodeExtraInformation()
|
||||
.setIncludeFile('Extensions/SaveState/SaveStateTools.js')
|
||||
.addIncludeFile(
|
||||
'Extensions/SaveState/SaveConfigurationRuntimeBehavior.js'
|
||||
)
|
||||
.setFunctionName('gdjs.saveState.setVariableSaveConfiguration');
|
||||
|
||||
extension
|
||||
.addAction(
|
||||
'SetGameDataSaveConfiguration',
|
||||
_('Change the save configuration of the global game data'),
|
||||
_(
|
||||
'Set if the global game data (audio & global variables) should be saved in the default save state. Also allow to specify one or more profiles in which the global game data should be saved.'
|
||||
),
|
||||
_(
|
||||
'Change save configuration of global game data: save them in the default save states: _PARAM1_ and in profiles: _PARAM2_'
|
||||
),
|
||||
_('Advanced configuration'),
|
||||
'res/actions/saveDown.svg',
|
||||
'res/actions/saveDown.svg'
|
||||
)
|
||||
.addCodeOnlyParameter('currentScene', '')
|
||||
.addParameter('yesorno', _('Persist in default save states'), '', false)
|
||||
.setDefaultValue('yes')
|
||||
.addParameter(
|
||||
'string',
|
||||
_('Profiles in which the global game data should be saved'),
|
||||
'',
|
||||
true
|
||||
)
|
||||
.setDefaultValue('')
|
||||
.setParameterLongDescription(
|
||||
_(
|
||||
'Comma-separated list of profile names in which the global game data will be saved. When a save state is created with one or more profile names specified, the global game data will be saved only if it matches one of these profiles.'
|
||||
)
|
||||
)
|
||||
.getCodeExtraInformation()
|
||||
.setIncludeFile('Extensions/SaveState/SaveStateTools.js')
|
||||
.addIncludeFile(
|
||||
'Extensions/SaveState/SaveConfigurationRuntimeBehavior.js'
|
||||
)
|
||||
.setFunctionName('gdjs.saveState.setGameDataSaveConfiguration');
|
||||
|
||||
extension
|
||||
.addAction(
|
||||
'SetSceneDataSaveConfiguration',
|
||||
_('Change the save configuration of a scene data'),
|
||||
_(
|
||||
'Set if the data of the specified scene (scene variables, timers, trigger once, wait actions, layers, etc.) should be saved in the default save state. Also allow to specify one or more profiles in which the scene data should be saved. Note: objects are always saved separately from the scene data (use the "Save Configuration" behavior to customize the configuration of objects).'
|
||||
),
|
||||
_(
|
||||
'Change save configuration of scene _PARAM1_: save it in the default save states: _PARAM2_ and in profiles: _PARAM3_'
|
||||
),
|
||||
_('Advanced configuration'),
|
||||
'res/actions/saveDown.svg',
|
||||
'res/actions/saveDown.svg'
|
||||
)
|
||||
.addCodeOnlyParameter('currentScene', '')
|
||||
.addParameter(
|
||||
'sceneName',
|
||||
_('Scene name for which configuration should be changed'),
|
||||
'',
|
||||
false
|
||||
)
|
||||
.addParameter('yesorno', _('Persist in default save states'), '', false)
|
||||
.setDefaultValue('yes')
|
||||
.addParameter(
|
||||
'string',
|
||||
_('Profiles in which the scene data should be saved'),
|
||||
'',
|
||||
true
|
||||
)
|
||||
.setDefaultValue('')
|
||||
.setParameterLongDescription(
|
||||
_(
|
||||
'Comma-separated list of profile names in which the scene data will be saved. When a save state is created with one or more profile names specified, the scene data will be saved only if it matches one of these profiles.'
|
||||
)
|
||||
)
|
||||
.getCodeExtraInformation()
|
||||
.setIncludeFile('Extensions/SaveState/SaveStateTools.js')
|
||||
.addIncludeFile(
|
||||
'Extensions/SaveState/SaveConfigurationRuntimeBehavior.js'
|
||||
)
|
||||
.setFunctionName('gdjs.saveState.setSceneDataSaveConfiguration');
|
||||
|
||||
// Save Configuration behavior
|
||||
const saveConfigurationBehavior = new gd.BehaviorJsImplementation();
|
||||
|
||||
saveConfigurationBehavior.updateProperty = function (
|
||||
behaviorContent,
|
||||
propertyName,
|
||||
newValue
|
||||
) {
|
||||
if (propertyName === 'defaultProfilePersistence') {
|
||||
behaviorContent
|
||||
.getChild('defaultProfilePersistence')
|
||||
.setStringValue(newValue);
|
||||
return true;
|
||||
}
|
||||
if (propertyName === 'persistedInProfiles') {
|
||||
behaviorContent
|
||||
.getChild('persistedInProfiles')
|
||||
.setStringValue(newValue);
|
||||
return true;
|
||||
}
|
||||
|
||||
return false;
|
||||
};
|
||||
|
||||
saveConfigurationBehavior.getProperties = function (behaviorContent) {
|
||||
const behaviorProperties = new gd.MapStringPropertyDescriptor();
|
||||
|
||||
behaviorProperties
|
||||
.getOrCreate('defaultProfilePersistence')
|
||||
.setValue(
|
||||
behaviorContent.getChild('defaultProfilePersistence').getStringValue()
|
||||
)
|
||||
.setType('Choice')
|
||||
.setLabel(_('Persistence mode'))
|
||||
.addChoice('Persisted', _('Include in save states (default)'))
|
||||
.addChoice('DoNotSave', _('Do not save'));
|
||||
|
||||
behaviorProperties
|
||||
.getOrCreate('persistedInProfiles')
|
||||
.setValue(
|
||||
behaviorContent.getChild('persistedInProfiles').getStringValue()
|
||||
)
|
||||
.setType('String')
|
||||
.setLabel(_('Save profile names'))
|
||||
.setDescription(
|
||||
_(
|
||||
'Comma-separated list of profile names in which the object is saved. When a save state is created with one or more profile names specified, the object will be saved only if it matches one of these profiles.'
|
||||
)
|
||||
)
|
||||
.setAdvanced(true);
|
||||
|
||||
return behaviorProperties;
|
||||
};
|
||||
|
||||
saveConfigurationBehavior.initializeContent = function (behaviorContent) {
|
||||
behaviorContent
|
||||
.addChild('defaultProfilePersistence')
|
||||
.setStringValue('Persisted');
|
||||
behaviorContent.addChild('persistedInProfiles').setStringValue('');
|
||||
};
|
||||
|
||||
const sharedData = new gd.BehaviorsSharedData();
|
||||
|
||||
extension
|
||||
.addBehavior(
|
||||
'SaveConfiguration',
|
||||
_('Save state configuration'),
|
||||
'SaveConfiguration',
|
||||
_('Allow the customize how the object is persisted in a save state.'),
|
||||
'',
|
||||
'res/actions/saveUp.svg',
|
||||
'SaveConfiguration',
|
||||
// @ts-ignore - TODO: Fix type being a BehaviorJsImplementation instead of an Behavior
|
||||
saveConfigurationBehavior,
|
||||
sharedData
|
||||
)
|
||||
.setQuickCustomizationVisibility(gd.QuickCustomization.Hidden)
|
||||
.setIncludeFile('Extensions/SaveState/SaveStateTools.js')
|
||||
.addIncludeFile(
|
||||
'Extensions/SaveState/SaveConfigurationRuntimeBehavior.js'
|
||||
);
|
||||
|
||||
return extension;
|
||||
},
|
||||
runExtensionSanityTests: function (gd, extension) {
|
||||
return [];
|
||||
},
|
||||
};
|
32
Extensions/SaveState/SaveConfigurationRuntimeBehavior.ts
Normal file
32
Extensions/SaveState/SaveConfigurationRuntimeBehavior.ts
Normal file
@@ -0,0 +1,32 @@
|
||||
namespace gdjs {
|
||||
// const logger = new gdjs.Logger('Save State');
|
||||
|
||||
export class SaveConfigurationRuntimeBehavior extends gdjs.RuntimeBehavior {
|
||||
private readonly _defaultProfilePersistence: 'Persisted' | 'DoNotSave' =
|
||||
'Persisted';
|
||||
private readonly _persistedInProfiles = '';
|
||||
|
||||
constructor(
|
||||
instanceContainer: gdjs.RuntimeInstanceContainer,
|
||||
behaviorData: any,
|
||||
owner: RuntimeObject
|
||||
) {
|
||||
super(instanceContainer, behaviorData, owner);
|
||||
this._defaultProfilePersistence =
|
||||
behaviorData.defaultProfilePersistence || 'Persisted';
|
||||
this._persistedInProfiles = behaviorData.persistedInProfiles || '';
|
||||
}
|
||||
|
||||
getDefaultProfilePersistence() {
|
||||
return this._defaultProfilePersistence;
|
||||
}
|
||||
|
||||
getPersistedInProfiles() {
|
||||
return this._persistedInProfiles;
|
||||
}
|
||||
}
|
||||
gdjs.registerBehavior(
|
||||
'SaveState::SaveConfiguration',
|
||||
gdjs.SaveConfigurationRuntimeBehavior
|
||||
);
|
||||
}
|
696
Extensions/SaveState/SaveStateTools.ts
Normal file
696
Extensions/SaveState/SaveStateTools.ts
Normal file
@@ -0,0 +1,696 @@
|
||||
namespace gdjs {
|
||||
const logger = new gdjs.Logger('Save State');
|
||||
const debugLogger = new gdjs.Logger('Save State - Debug');
|
||||
// Comment this to see message logs and ease debugging:
|
||||
gdjs.Logger.getDefaultConsoleLoggerOutput().discardGroup(
|
||||
'Save State - Debug'
|
||||
);
|
||||
|
||||
type ArbitrarySaveConfiguration = {
|
||||
defaultProfilePersistence: 'Persisted' | 'DoNotSave';
|
||||
persistedInProfiles: Set<string>;
|
||||
};
|
||||
|
||||
export type RestoreRequestOptions = {
|
||||
profileNames: string[];
|
||||
clearSceneStack: boolean;
|
||||
|
||||
fromStorageName?: string;
|
||||
fromVariable?: gdjs.Variable;
|
||||
};
|
||||
|
||||
export namespace saveState {
|
||||
export const getIndexedDbDatabaseName = () => {
|
||||
const gameId = gdjs.projectData.properties.projectUuid;
|
||||
return `gdevelop-game-${gameId}`;
|
||||
};
|
||||
export const getIndexedDbObjectStore = () => {
|
||||
return `game-saves`;
|
||||
};
|
||||
export const getIndexedDbStorageKey = (key: string) => {
|
||||
return `save-${key}`;
|
||||
};
|
||||
|
||||
const variablesSaveConfiguration: WeakMap<
|
||||
Variable,
|
||||
ArbitrarySaveConfiguration
|
||||
> = new WeakMap();
|
||||
const runtimeSceneDataSaveConfiguration: WeakMap<
|
||||
RuntimeGame,
|
||||
Record<string, ArbitrarySaveConfiguration>
|
||||
> = new WeakMap();
|
||||
const runtimeGameDataSaveConfiguration: WeakMap<
|
||||
RuntimeGame,
|
||||
ArbitrarySaveConfiguration
|
||||
> = new WeakMap();
|
||||
|
||||
export const setVariableSaveConfiguration = (
|
||||
_: gdjs.RuntimeScene,
|
||||
variable: gdjs.Variable,
|
||||
persistInDefaultProfile: boolean,
|
||||
persistedInProfilesAsString: string
|
||||
) => {
|
||||
variablesSaveConfiguration.set(variable, {
|
||||
defaultProfilePersistence: persistInDefaultProfile
|
||||
? 'Persisted'
|
||||
: 'DoNotSave',
|
||||
persistedInProfiles: new Set(
|
||||
parseCommaSeparatedProfileNames(persistedInProfilesAsString)
|
||||
),
|
||||
});
|
||||
};
|
||||
|
||||
export const setSceneDataSaveConfiguration = (
|
||||
runtimeScene: gdjs.RuntimeScene,
|
||||
sceneName: string,
|
||||
persistInDefaultProfile: boolean,
|
||||
persistedInProfilesAsString: string
|
||||
) => {
|
||||
const runtimeSceneDataSaveConfigurations =
|
||||
runtimeSceneDataSaveConfiguration.get(runtimeScene.getGame()) || {};
|
||||
|
||||
runtimeSceneDataSaveConfiguration.set(runtimeScene.getGame(), {
|
||||
...runtimeSceneDataSaveConfigurations,
|
||||
[sceneName]: {
|
||||
defaultProfilePersistence: persistInDefaultProfile
|
||||
? 'Persisted'
|
||||
: 'DoNotSave',
|
||||
persistedInProfiles: new Set(
|
||||
parseCommaSeparatedProfileNames(persistedInProfilesAsString)
|
||||
),
|
||||
},
|
||||
});
|
||||
};
|
||||
|
||||
export const setGameDataSaveConfiguration = (
|
||||
runtimeScene: gdjs.RuntimeScene,
|
||||
persistInDefaultProfile: boolean,
|
||||
persistedInProfilesAsString: string
|
||||
) => {
|
||||
runtimeGameDataSaveConfiguration.set(runtimeScene.getGame(), {
|
||||
defaultProfilePersistence: persistInDefaultProfile
|
||||
? 'Persisted'
|
||||
: 'DoNotSave',
|
||||
persistedInProfiles: new Set(
|
||||
parseCommaSeparatedProfileNames(persistedInProfilesAsString)
|
||||
),
|
||||
});
|
||||
};
|
||||
|
||||
const checkIfIsPersistedInProfiles = (
|
||||
profileNames: string[],
|
||||
configuration: ArbitrarySaveConfiguration | null | undefined
|
||||
) => {
|
||||
if (profileNames.includes('default')) {
|
||||
if (
|
||||
!configuration ||
|
||||
configuration.defaultProfilePersistence === 'Persisted'
|
||||
) {
|
||||
return true;
|
||||
}
|
||||
}
|
||||
|
||||
if (configuration) {
|
||||
for (const profileName of profileNames) {
|
||||
if (configuration.persistedInProfiles.has(profileName)) {
|
||||
return true;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return false;
|
||||
};
|
||||
|
||||
const makeIsVariableExcludedFromSaveState =
|
||||
(profileNames: string[]) => (variable: gdjs.Variable) => {
|
||||
const saveConfiguration = variablesSaveConfiguration.get(variable);
|
||||
return !checkIfIsPersistedInProfiles(
|
||||
profileNames,
|
||||
saveConfiguration || null
|
||||
);
|
||||
};
|
||||
|
||||
let lastSaveTime: number | null = null;
|
||||
let lastLoadTime: number | null = null;
|
||||
let saveJustSucceeded: boolean = false;
|
||||
let saveJustFailed: boolean = false;
|
||||
let loadJustSucceeded: boolean = false;
|
||||
let loadJustFailed: boolean = false;
|
||||
|
||||
let restoreRequestOptions: RestoreRequestOptions | null = null;
|
||||
|
||||
export const getSecondsSinceLastSave = (_: RuntimeScene): number => {
|
||||
if (!lastSaveTime) return -1;
|
||||
return Math.floor((Date.now() - lastSaveTime) / 1000);
|
||||
};
|
||||
export const getSecondsSinceLastLoad = (_: RuntimeScene): number => {
|
||||
if (!lastLoadTime) return -1;
|
||||
return Math.floor((Date.now() - lastLoadTime) / 1000);
|
||||
};
|
||||
export const hasSaveJustSucceeded = (_: RuntimeScene) => {
|
||||
return saveJustSucceeded;
|
||||
};
|
||||
export const hasLoadJustSucceeded = (_: RuntimeScene) => {
|
||||
return loadJustSucceeded;
|
||||
};
|
||||
export const hasSaveJustFailed = (_: RuntimeScene) => {
|
||||
return saveJustFailed;
|
||||
};
|
||||
export const hasLoadJustFailed = (_: RuntimeScene) => {
|
||||
return loadJustFailed;
|
||||
};
|
||||
export const markSaveJustSucceeded = (_: RuntimeScene) => {
|
||||
saveJustSucceeded = true;
|
||||
lastSaveTime = Date.now();
|
||||
};
|
||||
export const markLoadJustSucceeded = (_: RuntimeScene) => {
|
||||
loadJustSucceeded = true;
|
||||
lastLoadTime = Date.now();
|
||||
};
|
||||
export const markSaveJustFailed = (_: RuntimeScene) => {
|
||||
saveJustFailed = true;
|
||||
};
|
||||
export const markLoadJustFailed = (_: RuntimeScene) => {
|
||||
loadJustFailed = true;
|
||||
};
|
||||
|
||||
// Ensure that the condition "save/load just succeeded/failed" are valid only for one frame.
|
||||
gdjs.registerRuntimeScenePostEventsCallback(() => {
|
||||
saveJustSucceeded = false;
|
||||
saveJustFailed = false;
|
||||
loadJustSucceeded = false;
|
||||
loadJustFailed = false;
|
||||
});
|
||||
|
||||
gdjs.registerRuntimeScenePostEventsCallback(
|
||||
(runtimeScene: gdjs.RuntimeScene) => {
|
||||
checkAndRestoreGameSaveStateAtEndOfFrame(runtimeScene);
|
||||
}
|
||||
);
|
||||
|
||||
/**
|
||||
* Create a Save State from the given game.
|
||||
*
|
||||
* Only objects, variables etc... tagged with at least one of the profiles
|
||||
* given in `options.profileNames` will be saved.
|
||||
*/
|
||||
export const createGameSaveState = (
|
||||
runtimeGame: RuntimeGame,
|
||||
options: {
|
||||
profileNames: string[];
|
||||
}
|
||||
) => {
|
||||
const { profileNames } = options;
|
||||
|
||||
const getNetworkSyncOptions: GetNetworkSyncDataOptions = {
|
||||
syncObjectIdentifiers: true,
|
||||
shouldExcludeVariableFromData:
|
||||
makeIsVariableExcludedFromSaveState(profileNames),
|
||||
syncAllBehaviors: true,
|
||||
syncGameVariables: true,
|
||||
syncSceneTimers: true,
|
||||
syncOnceTriggers: true,
|
||||
syncSounds: true,
|
||||
syncTweens: true,
|
||||
syncLayers: true,
|
||||
syncAsyncTasks: true,
|
||||
syncSceneVisualProps: true,
|
||||
syncFullTileMaps: true,
|
||||
};
|
||||
|
||||
const shouldPersistGameData = checkIfIsPersistedInProfiles(
|
||||
options.profileNames,
|
||||
runtimeGameDataSaveConfiguration.get(runtimeGame)
|
||||
);
|
||||
|
||||
const gameSaveState: GameSaveState = {
|
||||
// Always persist some game data, but limit it to just the scene stack
|
||||
// if asked to not persist the game data.
|
||||
gameNetworkSyncData: runtimeGame.getNetworkSyncData({
|
||||
...getNetworkSyncOptions,
|
||||
syncGameVariables: shouldPersistGameData,
|
||||
syncSounds: shouldPersistGameData,
|
||||
}),
|
||||
layoutNetworkSyncDatas: [],
|
||||
};
|
||||
|
||||
const scenes = runtimeGame.getSceneStack().getAllScenes();
|
||||
scenes.forEach((runtimeScene, index) => {
|
||||
gameSaveState.layoutNetworkSyncDatas[index] = {
|
||||
sceneData: {} as LayoutNetworkSyncData,
|
||||
objectDatas: {},
|
||||
};
|
||||
|
||||
// First collect all object sync data, as they may generate unique
|
||||
// identifiers like their networkId.
|
||||
for (const object of runtimeScene.getAdhocListOfAllInstances()) {
|
||||
// By default, an object which has no SaveConfiguration behavior is like
|
||||
// it has the default profile persistence set to "Persisted".
|
||||
let shouldPersist = profileNames.includes('default');
|
||||
|
||||
// @ts-ignore - access to `_behaviors` is an exceptional case for the SaveConfiguration behavior.
|
||||
for (const behavior of object._behaviors) {
|
||||
if (behavior instanceof gdjs.SaveConfigurationRuntimeBehavior) {
|
||||
// This object has a SaveConfiguration behavior. Check if the configuration is set to
|
||||
// persist it in one of the given profiles.
|
||||
if (
|
||||
(profileNames.includes('default') &&
|
||||
behavior.getDefaultProfilePersistence() === 'Persisted') ||
|
||||
profileNames.some((profileName) =>
|
||||
// TODO: avoid do it for every single object instance?
|
||||
behavior
|
||||
.getPersistedInProfiles()
|
||||
.split(',')
|
||||
.map((profileName) => profileName.trim())
|
||||
.includes(profileName)
|
||||
)
|
||||
) {
|
||||
shouldPersist = true;
|
||||
} else {
|
||||
shouldPersist = false;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
if (shouldPersist) {
|
||||
const objectSyncData = object.getNetworkSyncData(
|
||||
getNetworkSyncOptions
|
||||
);
|
||||
gameSaveState.layoutNetworkSyncDatas[index].objectDatas[object.id] =
|
||||
objectSyncData;
|
||||
}
|
||||
}
|
||||
|
||||
// Collect scene data after the objects:
|
||||
const shouldPersistSceneData = checkIfIsPersistedInProfiles(
|
||||
options.profileNames,
|
||||
(runtimeSceneDataSaveConfiguration.get(runtimeGame) || {})[
|
||||
runtimeScene.getName()
|
||||
]
|
||||
);
|
||||
if (shouldPersistSceneData) {
|
||||
const sceneData = runtimeScene.getNetworkSyncData(
|
||||
getNetworkSyncOptions
|
||||
);
|
||||
if (sceneData) {
|
||||
gameSaveState.layoutNetworkSyncDatas[index].sceneData = sceneData;
|
||||
}
|
||||
}
|
||||
});
|
||||
|
||||
return gameSaveState;
|
||||
};
|
||||
|
||||
export const createGameSaveStateInVariable = async function (
|
||||
runtimeScene: RuntimeScene,
|
||||
variable: gdjs.Variable,
|
||||
commaSeparatedProfileNames: string
|
||||
) {
|
||||
try {
|
||||
const gameSaveState = createGameSaveState(runtimeScene.getGame(), {
|
||||
profileNames: parseCommaSeparatedProfileNamesOrDefault(
|
||||
commaSeparatedProfileNames
|
||||
),
|
||||
});
|
||||
variable.fromJSObject(gameSaveState);
|
||||
markSaveJustSucceeded(runtimeScene);
|
||||
} catch (error) {
|
||||
logger.error('Error saving to variable:', error);
|
||||
markSaveJustFailed(runtimeScene);
|
||||
}
|
||||
};
|
||||
|
||||
export const createGameSaveStateInStorage = async function (
|
||||
runtimeScene: RuntimeScene,
|
||||
storageKey: string,
|
||||
commaSeparatedProfileNames: string
|
||||
) {
|
||||
try {
|
||||
const gameSaveState = createGameSaveState(runtimeScene.getGame(), {
|
||||
profileNames: parseCommaSeparatedProfileNamesOrDefault(
|
||||
commaSeparatedProfileNames
|
||||
),
|
||||
});
|
||||
await gdjs.indexedDb.saveToIndexedDB(
|
||||
getIndexedDbDatabaseName(),
|
||||
getIndexedDbObjectStore(),
|
||||
getIndexedDbStorageKey(storageKey),
|
||||
gameSaveState
|
||||
);
|
||||
markSaveJustSucceeded(runtimeScene);
|
||||
} catch (error) {
|
||||
logger.error('Error saving to IndexedDB:', error);
|
||||
markSaveJustFailed(runtimeScene);
|
||||
}
|
||||
};
|
||||
|
||||
const checkAndRestoreGameSaveStateAtEndOfFrame = function (
|
||||
runtimeScene: RuntimeScene
|
||||
) {
|
||||
const runtimeGame = runtimeScene.getGame();
|
||||
|
||||
if (!restoreRequestOptions) return;
|
||||
const { fromVariable, fromStorageName, profileNames, clearSceneStack } =
|
||||
restoreRequestOptions;
|
||||
|
||||
// Reset it so we don't load it twice.
|
||||
restoreRequestOptions = null;
|
||||
|
||||
if (fromVariable) {
|
||||
const saveState = fromVariable.toJSObject();
|
||||
|
||||
try {
|
||||
restoreGameSaveState(runtimeGame, saveState, {
|
||||
profileNames,
|
||||
clearSceneStack,
|
||||
});
|
||||
markLoadJustSucceeded(runtimeScene);
|
||||
} catch (error) {
|
||||
logger.error('Error loading from variable:', error);
|
||||
markLoadJustFailed(runtimeScene);
|
||||
}
|
||||
} else if (fromStorageName) {
|
||||
gdjs.indexedDb
|
||||
.loadFromIndexedDB(
|
||||
getIndexedDbDatabaseName(),
|
||||
getIndexedDbObjectStore(),
|
||||
getIndexedDbStorageKey(fromStorageName)
|
||||
)
|
||||
.then((jsonData) => {
|
||||
const saveState = jsonData as GameSaveState;
|
||||
restoreGameSaveState(runtimeGame, saveState, {
|
||||
profileNames,
|
||||
clearSceneStack,
|
||||
});
|
||||
markLoadJustSucceeded(runtimeScene);
|
||||
})
|
||||
.catch((error) => {
|
||||
logger.error('Error loading from IndexedDB:', error);
|
||||
markLoadJustFailed(runtimeScene);
|
||||
});
|
||||
}
|
||||
};
|
||||
|
||||
const getInstanceFromNetworkId = ({
|
||||
runtimeScene,
|
||||
objectName,
|
||||
networkId,
|
||||
}: {
|
||||
runtimeScene: gdjs.RuntimeScene;
|
||||
objectName: string;
|
||||
networkId: string;
|
||||
}): gdjs.RuntimeObject | null => {
|
||||
const instances = runtimeScene.getInstancesOf(objectName);
|
||||
if (!instances) {
|
||||
// object does not exist in the scene, cannot find the instance.
|
||||
return null;
|
||||
}
|
||||
let instance =
|
||||
instances.find((instance) => instance.networkId === networkId) || null;
|
||||
|
||||
// Check if there is already an instance with the given network ID.
|
||||
if (instance) {
|
||||
debugLogger.info(
|
||||
`Found instance ${networkId}, will use it for restoring.`
|
||||
);
|
||||
return instance;
|
||||
}
|
||||
|
||||
// Instance not found - it must have been deleted. Create it now.
|
||||
debugLogger.info(
|
||||
`Instance ${networkId} not found, creating instance ${objectName}.`
|
||||
);
|
||||
const newInstance = runtimeScene.createObject(objectName);
|
||||
if (!newInstance) {
|
||||
// Object does not exist in the scene, cannot create the instance.
|
||||
return null;
|
||||
}
|
||||
|
||||
newInstance.networkId = networkId;
|
||||
return newInstance;
|
||||
};
|
||||
|
||||
/**
|
||||
* Restore the game using the given Save State.
|
||||
*
|
||||
* `options.profileNames` is the list of profiles to restore: only objects, variables etc... tagged with at least
|
||||
* one of these profiles will be restored (or recreated if they don't exist, or deleted if not in the save state).
|
||||
* Others will be left untouched.
|
||||
*
|
||||
* If `options.clearSceneStack` is true, all the scenes will be unloaded and re-created
|
||||
* (meaning all instances will be re-created, variables will go back to their initial values, etc...).
|
||||
* Otherwise, the existing scenes will be updated (or unloaded or created if the save state has different scenes).
|
||||
*/
|
||||
export const restoreGameSaveState = (
|
||||
runtimeGame: RuntimeGame,
|
||||
saveState: GameSaveState,
|
||||
options: {
|
||||
profileNames: string[];
|
||||
clearSceneStack: boolean;
|
||||
}
|
||||
): void => {
|
||||
const getObjectNamesToRestoreForRuntimeScene = (
|
||||
runtimeScene: RuntimeScene
|
||||
): Set<string> => {
|
||||
const allObjectData = [];
|
||||
runtimeScene._objects.values(allObjectData);
|
||||
return getObjectNamesIncludedInProfiles(
|
||||
allObjectData,
|
||||
options.profileNames
|
||||
);
|
||||
};
|
||||
|
||||
const updateFromNetworkSyncDataOptions: UpdateFromNetworkSyncDataOptions =
|
||||
{
|
||||
clearSceneStack:
|
||||
options.clearSceneStack === undefined
|
||||
? true
|
||||
: options.clearSceneStack,
|
||||
getExcludedObjectNames: getObjectNamesToRestoreForRuntimeScene,
|
||||
preventSoundsStoppingOnStartup: true,
|
||||
clearInputs: true,
|
||||
keepControl: true,
|
||||
ignoreVariableOwnership: true,
|
||||
shouldExcludeVariableFromUpdate: makeIsVariableExcludedFromSaveState(
|
||||
options.profileNames
|
||||
),
|
||||
};
|
||||
|
||||
// First update the game, which will update the variables,
|
||||
// and set the scene stack to update when ready.
|
||||
if (saveState.gameNetworkSyncData) {
|
||||
const shouldRestoreGameData = checkIfIsPersistedInProfiles(
|
||||
options.profileNames,
|
||||
runtimeGameDataSaveConfiguration.get(runtimeGame)
|
||||
);
|
||||
|
||||
runtimeGame.updateFromNetworkSyncData(
|
||||
shouldRestoreGameData
|
||||
? saveState.gameNetworkSyncData
|
||||
: {
|
||||
// Disable game data restoration if asked to, but
|
||||
// still always keep `ss` (scene stack) restoration as it's always needed.
|
||||
ss: saveState.gameNetworkSyncData.ss,
|
||||
},
|
||||
updateFromNetworkSyncDataOptions
|
||||
);
|
||||
}
|
||||
|
||||
// Apply the scene stack updates, as we are at the end of a frame,
|
||||
// we can safely do it.
|
||||
const sceneStack = runtimeGame.getSceneStack();
|
||||
sceneStack.applyUpdateFromNetworkSyncDataIfAny(
|
||||
updateFromNetworkSyncDataOptions
|
||||
);
|
||||
|
||||
// Then get all scenes, which we assume will be the expected ones
|
||||
// after the load has been done, so we can update them,
|
||||
// and create their objects.
|
||||
const runtimeScenes = sceneStack.getAllScenes();
|
||||
runtimeScenes.forEach((runtimeScene, index) => {
|
||||
const layoutSyncData = saveState.layoutNetworkSyncDatas[index];
|
||||
if (!layoutSyncData) return;
|
||||
|
||||
// List names of objects that must be restored
|
||||
// (and only them - instances of others will be left alone).
|
||||
const objectNamesToRestore =
|
||||
getObjectNamesToRestoreForRuntimeScene(runtimeScene);
|
||||
|
||||
// Create objects first, so they are available for the scene update,
|
||||
// especially so that they have a networkId defined.
|
||||
const allLoadedNetworkIds = new Set<string>();
|
||||
const objectDatas = layoutSyncData.objectDatas;
|
||||
for (const id in objectDatas) {
|
||||
const objectNetworkSyncData = objectDatas[id];
|
||||
const objectName = objectNetworkSyncData.n;
|
||||
if (!objectName) {
|
||||
logger.warn('Tried to recreate an object without a name.');
|
||||
continue;
|
||||
}
|
||||
if (!objectNamesToRestore.has(objectName)) {
|
||||
// Object is in the save state, but not in the profiles to restore, don't restore it.
|
||||
continue;
|
||||
}
|
||||
|
||||
// Object is both in the save state and in the profiles to restore, restore it.
|
||||
// Either find the existing instance with the same networkId, or create a new one.
|
||||
const networkId = objectNetworkSyncData.networkId || '';
|
||||
allLoadedNetworkIds.add(networkId);
|
||||
|
||||
const object = getInstanceFromNetworkId({
|
||||
runtimeScene,
|
||||
objectName: objectName,
|
||||
networkId,
|
||||
});
|
||||
if (object) {
|
||||
object.updateFromNetworkSyncData(
|
||||
objectNetworkSyncData,
|
||||
updateFromNetworkSyncDataOptions
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
// Clean instances of objects that are not in the profiles to restore but not in the save state
|
||||
// (i.e: those who don't have a networkId, or it's not in the save state: they must not exist).
|
||||
for (const objectName of objectNamesToRestore) {
|
||||
// /!\ Clone the instances to avoid it being modified while iterating through them.
|
||||
const objects = [...runtimeScene.getInstancesOf(objectName)];
|
||||
for (const object of objects) {
|
||||
// This is an object instance that is part of the object that are being restored,
|
||||
// but it has not network id (created after the save state was created) or the network
|
||||
// id is not in the save state: it's not part of the save state and must be deleted.
|
||||
if (
|
||||
!object.networkId ||
|
||||
!allLoadedNetworkIds.has(object.networkId)
|
||||
) {
|
||||
object.deleteFromScene();
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Update the rest of the scene last.
|
||||
if (
|
||||
checkIfIsPersistedInProfiles(
|
||||
options.profileNames,
|
||||
(runtimeSceneDataSaveConfiguration.get(runtimeGame) || {})[
|
||||
runtimeScene.getName()
|
||||
]
|
||||
)
|
||||
) {
|
||||
runtimeScene.updateFromNetworkSyncData(
|
||||
layoutSyncData.sceneData,
|
||||
updateFromNetworkSyncDataOptions
|
||||
);
|
||||
}
|
||||
});
|
||||
};
|
||||
|
||||
const parseCommaSeparatedProfileNames = (
|
||||
commaSeparatedProfileNames: string
|
||||
): string[] | null => {
|
||||
if (!commaSeparatedProfileNames) return null;
|
||||
|
||||
return commaSeparatedProfileNames
|
||||
.split(',')
|
||||
.map((profileName) => profileName.trim());
|
||||
};
|
||||
|
||||
const parseCommaSeparatedProfileNamesOrDefault = (
|
||||
commaSeparatedProfileNames: string
|
||||
): string[] => {
|
||||
return (
|
||||
parseCommaSeparatedProfileNames(commaSeparatedProfileNames) || [
|
||||
'default',
|
||||
]
|
||||
);
|
||||
};
|
||||
|
||||
export const restoreGameSaveStateFromVariable = async function (
|
||||
_: gdjs.RuntimeScene,
|
||||
variable: gdjs.Variable,
|
||||
commaSeparatedProfileNames: string,
|
||||
clearSceneStack: boolean
|
||||
) {
|
||||
// The information is saved, so that the restore can be done
|
||||
// at the end of the frame,
|
||||
// and avoid possible conflicts with running events.
|
||||
restoreRequestOptions = {
|
||||
fromVariable: variable,
|
||||
profileNames: parseCommaSeparatedProfileNamesOrDefault(
|
||||
commaSeparatedProfileNames
|
||||
),
|
||||
clearSceneStack,
|
||||
};
|
||||
};
|
||||
|
||||
export const restoreGameSaveStateFromStorage = async function (
|
||||
_: gdjs.RuntimeScene,
|
||||
storageName: string,
|
||||
commaSeparatedProfileNames: string,
|
||||
clearSceneStack: boolean
|
||||
) {
|
||||
// The information is saved, so that the restore can be done
|
||||
// at the end of the frame,
|
||||
// and avoid possible conflicts with running events.
|
||||
restoreRequestOptions = {
|
||||
fromStorageName: storageName,
|
||||
profileNames: parseCommaSeparatedProfileNamesOrDefault(
|
||||
commaSeparatedProfileNames
|
||||
),
|
||||
clearSceneStack,
|
||||
};
|
||||
};
|
||||
|
||||
/**
|
||||
* Compute, by looking at the "static" object data (i.e: in the Project Data),
|
||||
* the name of objects which must be restored, based on the given profiles.
|
||||
*/
|
||||
const getObjectNamesIncludedInProfiles = (
|
||||
allObjectData: ObjectData[],
|
||||
profileNames: string[]
|
||||
): Set<string> => {
|
||||
const objectNames = new Set<string>();
|
||||
for (const objectData of allObjectData) {
|
||||
// By default, an object which has no SaveConfiguration behavior is like
|
||||
// it has the default profile persistence set to "Persisted".
|
||||
let includedInProfiles = profileNames.includes('default');
|
||||
|
||||
for (const behaviorData of objectData.behaviors) {
|
||||
if (behaviorData.type !== 'SaveState::SaveConfiguration') continue;
|
||||
|
||||
const defaultProfilePersistence =
|
||||
behaviorData.defaultProfilePersistence === 'Persisted'
|
||||
? 'Persisted'
|
||||
: 'DoNotSave';
|
||||
const persistedInProfiles =
|
||||
typeof behaviorData.persistedInProfiles === 'string'
|
||||
? behaviorData.persistedInProfiles
|
||||
.split(',')
|
||||
.map((profileName: string) => profileName.trim())
|
||||
: [];
|
||||
|
||||
// This object has a SaveConfiguration behavior. Check if the configuration is set to
|
||||
// persist it in one of the given profiles.
|
||||
includedInProfiles = false;
|
||||
|
||||
if (
|
||||
(profileNames.includes('default') &&
|
||||
defaultProfilePersistence === 'Persisted') ||
|
||||
profileNames.some((profileName) =>
|
||||
persistedInProfiles.includes(profileName)
|
||||
)
|
||||
) {
|
||||
// This object must be persisted in one of the given profile.
|
||||
includedInProfiles = true;
|
||||
}
|
||||
}
|
||||
|
||||
if (includedInProfiles) {
|
||||
objectNames.add(objectData.name);
|
||||
}
|
||||
}
|
||||
|
||||
return objectNames;
|
||||
};
|
||||
}
|
||||
}
|
1224
Extensions/SaveState/tests/SaveState.spec.js
Normal file
1224
Extensions/SaveState/tests/SaveState.spec.js
Normal file
File diff suppressed because it is too large
Load Diff
@@ -53,6 +53,8 @@ namespace gdjs {
|
||||
|
||||
readonly spineResourceName: string;
|
||||
|
||||
static isHitBoxesUpdateDisabled = false;
|
||||
|
||||
/**
|
||||
* @param instanceContainer The container the object belongs to.
|
||||
* @param objectData The object data used to initialize the object
|
||||
@@ -74,6 +76,10 @@ namespace gdjs {
|
||||
this.setAnimationIndex(0);
|
||||
this._renderer.updateAnimation(0);
|
||||
|
||||
if (SpineRuntimeObject.isHitBoxesUpdateDisabled) {
|
||||
this.hitBoxes.length = 0;
|
||||
}
|
||||
|
||||
// *ALWAYS* call `this.onCreated()` at the very end of your object constructor.
|
||||
this.onCreated();
|
||||
}
|
||||
@@ -111,9 +117,11 @@ namespace gdjs {
|
||||
return true;
|
||||
}
|
||||
|
||||
getNetworkSyncData(): SpineNetworkSyncData {
|
||||
getNetworkSyncData(
|
||||
syncOptions: GetNetworkSyncDataOptions
|
||||
): SpineNetworkSyncData {
|
||||
return {
|
||||
...super.getNetworkSyncData(),
|
||||
...super.getNetworkSyncData(syncOptions),
|
||||
opa: this._opacity,
|
||||
scaX: this.getScaleX(),
|
||||
scaY: this.getScaleY(),
|
||||
@@ -127,8 +135,11 @@ namespace gdjs {
|
||||
};
|
||||
}
|
||||
|
||||
updateFromNetworkSyncData(syncData: SpineNetworkSyncData): void {
|
||||
super.updateFromNetworkSyncData(syncData);
|
||||
updateFromNetworkSyncData(
|
||||
syncData: SpineNetworkSyncData,
|
||||
options: UpdateFromNetworkSyncDataOptions
|
||||
): void {
|
||||
super.updateFromNetworkSyncData(syncData, options);
|
||||
|
||||
if (syncData.opa !== undefined && syncData.opa !== this._opacity) {
|
||||
this.setOpacity(syncData.opa);
|
||||
@@ -183,6 +194,14 @@ namespace gdjs {
|
||||
}
|
||||
}
|
||||
|
||||
updateHitBoxes(): void {
|
||||
if (SpineRuntimeObject.isHitBoxesUpdateDisabled) {
|
||||
return;
|
||||
}
|
||||
|
||||
super.updateHitBoxes();
|
||||
}
|
||||
|
||||
extraInitializationFromInitialInstance(
|
||||
initialInstanceData: InstanceData
|
||||
): void {
|
||||
|
@@ -267,9 +267,11 @@ namespace gdjs {
|
||||
return true;
|
||||
}
|
||||
|
||||
getNetworkSyncData(): TextInputNetworkSyncData {
|
||||
getNetworkSyncData(
|
||||
syncOptions: GetNetworkSyncDataOptions
|
||||
): TextInputNetworkSyncData {
|
||||
return {
|
||||
...super.getNetworkSyncData(),
|
||||
...super.getNetworkSyncData(syncOptions),
|
||||
opa: this.getOpacity(),
|
||||
txt: this.getText(),
|
||||
frn: this.getFontResourceName(),
|
||||
@@ -288,8 +290,11 @@ namespace gdjs {
|
||||
};
|
||||
}
|
||||
|
||||
updateFromNetworkSyncData(syncData: TextInputNetworkSyncData): void {
|
||||
super.updateFromNetworkSyncData(syncData);
|
||||
updateFromNetworkSyncData(
|
||||
syncData: TextInputNetworkSyncData,
|
||||
options: UpdateFromNetworkSyncDataOptions
|
||||
): void {
|
||||
super.updateFromNetworkSyncData(syncData, options);
|
||||
|
||||
if (syncData.opa !== undefined) this.setOpacity(syncData.opa);
|
||||
if (syncData.txt !== undefined) this.setText(syncData.txt);
|
||||
|
@@ -52,6 +52,7 @@ namespace gdjs {
|
||||
c: number[];
|
||||
scale: number;
|
||||
ta: string;
|
||||
vta: string;
|
||||
wrap: boolean;
|
||||
wrapw: float;
|
||||
oena: boolean;
|
||||
@@ -179,9 +180,6 @@ namespace gdjs {
|
||||
if (oldContent.text !== newContent.text) {
|
||||
this.setText(newContent.text);
|
||||
}
|
||||
if (oldContent.underlined !== newContent.underlined) {
|
||||
return false;
|
||||
}
|
||||
if (oldContent.textAlignment !== newContent.textAlignment) {
|
||||
this.setTextAlignment(newContent.textAlignment);
|
||||
}
|
||||
@@ -220,12 +218,18 @@ namespace gdjs {
|
||||
if ((oldContent.lineHeight || 0) !== (newContent.lineHeight || 0)) {
|
||||
this.setLineHeight(newContent.lineHeight || 0);
|
||||
}
|
||||
if (oldContent.underlined !== newContent.underlined) {
|
||||
return false;
|
||||
}
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
override getNetworkSyncData(): TextObjectNetworkSyncData {
|
||||
override getNetworkSyncData(
|
||||
syncOptions: GetNetworkSyncDataOptions
|
||||
): TextObjectNetworkSyncData {
|
||||
return {
|
||||
...super.getNetworkSyncData(),
|
||||
...super.getNetworkSyncData(syncOptions),
|
||||
str: this._str,
|
||||
o: this.opacity,
|
||||
cs: this._characterSize,
|
||||
@@ -236,6 +240,7 @@ namespace gdjs {
|
||||
c: this._color,
|
||||
scale: this.getScale(),
|
||||
ta: this._textAlign,
|
||||
vta: this._verticalTextAlignment,
|
||||
wrap: this._wrapping,
|
||||
wrapw: this._wrappingWidth,
|
||||
oena: this._isOutlineEnabled,
|
||||
@@ -253,9 +258,10 @@ namespace gdjs {
|
||||
}
|
||||
|
||||
override updateFromNetworkSyncData(
|
||||
networkSyncData: TextObjectNetworkSyncData
|
||||
networkSyncData: TextObjectNetworkSyncData,
|
||||
options: UpdateFromNetworkSyncDataOptions
|
||||
): void {
|
||||
super.updateFromNetworkSyncData(networkSyncData);
|
||||
super.updateFromNetworkSyncData(networkSyncData, options);
|
||||
if (networkSyncData.str !== undefined) {
|
||||
this.setText(networkSyncData.str);
|
||||
}
|
||||
@@ -286,8 +292,8 @@ namespace gdjs {
|
||||
if (networkSyncData.ta !== undefined) {
|
||||
this.setTextAlignment(networkSyncData.ta);
|
||||
}
|
||||
if (networkSyncData.ta !== undefined) {
|
||||
this.setVerticalTextAlignment(networkSyncData.ta);
|
||||
if (networkSyncData.vta !== undefined) {
|
||||
this.setVerticalTextAlignment(networkSyncData.vta);
|
||||
}
|
||||
if (networkSyncData.wrap !== undefined) {
|
||||
this.setWrapping(networkSyncData.wrap);
|
||||
|
@@ -9,7 +9,7 @@ import {
|
||||
* A tile map model.
|
||||
*
|
||||
* Tile map files are parsed into this model by {@link TiledTileMapLoader} or {@link LDtkTileMapLoader}.
|
||||
* This model is used for rending ({@link TileMapRuntimeObjectPixiRenderer})
|
||||
* This model is used for rendering ({@link TileMapRuntimeObjectPixiRenderer})
|
||||
* and hitboxes handling ({@link TransformedCollisionTileMap}).
|
||||
* This allows to support new file format with only a new parser.
|
||||
*/
|
||||
@@ -71,7 +71,7 @@ export declare class EditableTileMap {
|
||||
tileSetRowCount: number;
|
||||
}
|
||||
): EditableTileMap;
|
||||
toJSObject(): Object;
|
||||
toJSObject(): EditableTileMapAsJsObject;
|
||||
/**
|
||||
* @returns The tile map width in pixels.
|
||||
*/
|
||||
@@ -205,7 +205,7 @@ declare abstract class AbstractEditableLayer {
|
||||
*/
|
||||
constructor(tileMap: EditableTileMap, id: integer);
|
||||
setVisible(visible: boolean): void;
|
||||
toJSObject(): Object;
|
||||
toJSObject(): EditableTileMapLayerAsJsObject;
|
||||
/**
|
||||
* @returns true if the layer is visible.
|
||||
*/
|
||||
@@ -284,7 +284,7 @@ export declare class EditableTileMapLayer extends AbstractEditableLayer {
|
||||
tileMap: EditableTileMap,
|
||||
isTileIdValid: (tileId: number) => boolean
|
||||
): EditableTileMapLayer;
|
||||
toJSObject(): Object;
|
||||
toJSObject(): EditableTileMapLayerAsJsObject;
|
||||
/**
|
||||
* The opacity (between 0-1) of the layer
|
||||
*/
|
||||
|
@@ -2,7 +2,6 @@
|
||||
namespace gdjs {
|
||||
export type SimpleTileMapObjectDataType = {
|
||||
content: {
|
||||
opacity: number;
|
||||
atlasImage: string;
|
||||
rowCount: number;
|
||||
columnCount: number;
|
||||
@@ -16,8 +15,7 @@ namespace gdjs {
|
||||
|
||||
export type SimpleTileMapNetworkSyncDataType = {
|
||||
op: number;
|
||||
ai: string;
|
||||
// TODO: Support tilemap synchronization. Find an efficient way to send tiles changes.
|
||||
tm?: TileMapHelper.EditableTileMapAsJsObject;
|
||||
};
|
||||
|
||||
export type SimpleTileMapNetworkSyncData = ObjectNetworkSyncData &
|
||||
@@ -38,6 +36,7 @@ namespace gdjs {
|
||||
_opacity: float = 255;
|
||||
_atlasImage: string;
|
||||
_tileMapManager: gdjs.TileMap.TileMapRuntimeManager;
|
||||
_tileMap: TileMapHelper.EditableTileMap | null = null;
|
||||
_renderer: gdjs.TileMapRuntimeObjectPixiRenderer;
|
||||
readonly _rowCount: number;
|
||||
readonly _columnCount: number;
|
||||
@@ -62,7 +61,6 @@ namespace gdjs {
|
||||
objectData: SimpleTileMapObjectDataType
|
||||
) {
|
||||
super(instanceContainer, objectData);
|
||||
this._opacity = objectData.content.opacity;
|
||||
this._atlasImage = objectData.content.atlasImage;
|
||||
this._rowCount = objectData.content.rowCount;
|
||||
this._columnCount = objectData.content.columnCount;
|
||||
@@ -87,16 +85,19 @@ namespace gdjs {
|
||||
instanceContainer
|
||||
);
|
||||
|
||||
this._loadInitialTileMap((tileMap: TileMapHelper.EditableTileMap) => {
|
||||
this._renderer.updatePosition();
|
||||
this._loadTileMap(
|
||||
this._initialTileMapAsJsObject,
|
||||
(tileMap: TileMapHelper.EditableTileMap) => {
|
||||
this._renderer.updatePosition();
|
||||
|
||||
this._collisionTileMap = new gdjs.TileMap.TransformedCollisionTileMap(
|
||||
tileMap,
|
||||
this._hitBoxTag
|
||||
);
|
||||
this._collisionTileMap = new gdjs.TileMap.TransformedCollisionTileMap(
|
||||
tileMap,
|
||||
this._hitBoxTag
|
||||
);
|
||||
|
||||
this.updateTransformation();
|
||||
});
|
||||
this.updateTransformation();
|
||||
}
|
||||
);
|
||||
|
||||
// *ALWAYS* call `this.onCreated()` at the very end of your object constructor.
|
||||
this.onCreated();
|
||||
@@ -139,8 +140,8 @@ namespace gdjs {
|
||||
);
|
||||
if (!shouldContinue) return;
|
||||
if (this._collisionTileMap) {
|
||||
const tileMap = this._renderer.getTileMap();
|
||||
if (tileMap) this._collisionTileMap.updateFromTileMap(tileMap);
|
||||
if (this._tileMap)
|
||||
this._collisionTileMap.updateFromTileMap(this._tileMap);
|
||||
}
|
||||
this._isTileMapDirty = false;
|
||||
}
|
||||
@@ -150,9 +151,6 @@ namespace gdjs {
|
||||
oldObjectData: SimpleTileMapObjectData,
|
||||
newObjectData: SimpleTileMapObjectData
|
||||
): boolean {
|
||||
if (oldObjectData.content.opacity !== newObjectData.content.opacity) {
|
||||
this.setOpacity(newObjectData.content.opacity);
|
||||
}
|
||||
if (
|
||||
oldObjectData.content.atlasImage !== newObjectData.content.atlasImage
|
||||
) {
|
||||
@@ -163,27 +161,58 @@ namespace gdjs {
|
||||
return true;
|
||||
}
|
||||
|
||||
getNetworkSyncData(): SimpleTileMapNetworkSyncData {
|
||||
return {
|
||||
...super.getNetworkSyncData(),
|
||||
getNetworkSyncData(
|
||||
syncOptions: GetNetworkSyncDataOptions
|
||||
): SimpleTileMapNetworkSyncData {
|
||||
const syncData: SimpleTileMapNetworkSyncData = {
|
||||
...super.getNetworkSyncData(syncOptions),
|
||||
op: this._opacity,
|
||||
ai: this._atlasImage,
|
||||
};
|
||||
if (this._tileMap && syncOptions.syncFullTileMaps) {
|
||||
const currentTileMapAsJsObject = this._tileMap.toJSObject();
|
||||
syncData.tm = currentTileMapAsJsObject;
|
||||
}
|
||||
|
||||
return syncData;
|
||||
}
|
||||
|
||||
updateFromNetworkSyncData(
|
||||
networkSyncData: SimpleTileMapNetworkSyncData
|
||||
networkSyncData: SimpleTileMapNetworkSyncData,
|
||||
options: UpdateFromNetworkSyncDataOptions
|
||||
): void {
|
||||
super.updateFromNetworkSyncData(networkSyncData);
|
||||
super.updateFromNetworkSyncData(networkSyncData, options);
|
||||
|
||||
if (
|
||||
networkSyncData.op !== undefined &&
|
||||
networkSyncData.op !== this._opacity
|
||||
) {
|
||||
this.setOpacity(networkSyncData.op);
|
||||
}
|
||||
if (networkSyncData.ai !== undefined) {
|
||||
// TODO: support changing the atlas texture
|
||||
if (networkSyncData.tm !== undefined) {
|
||||
this._loadTileMap(
|
||||
networkSyncData.tm,
|
||||
(tileMap: TileMapHelper.EditableTileMap) => {
|
||||
if (networkSyncData.w !== undefined) {
|
||||
this.setWidth(networkSyncData.w);
|
||||
}
|
||||
if (networkSyncData.h !== undefined) {
|
||||
this.setHeight(networkSyncData.h);
|
||||
}
|
||||
if (networkSyncData.op !== undefined) {
|
||||
this.setOpacity(networkSyncData.op);
|
||||
}
|
||||
|
||||
// 4. Update position (calculations based on renderer's dimensions).
|
||||
this._renderer.updatePosition();
|
||||
|
||||
if (this._collisionTileMap) {
|
||||
// If collision tile map is already defined, only update it.
|
||||
this._collisionTileMap.updateFromTileMap(tileMap);
|
||||
} else {
|
||||
this._collisionTileMap =
|
||||
new gdjs.TileMap.TransformedCollisionTileMap(
|
||||
tileMap,
|
||||
this._hitBoxTag
|
||||
);
|
||||
}
|
||||
|
||||
this.updateTransformation();
|
||||
}
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -199,39 +228,43 @@ namespace gdjs {
|
||||
|
||||
// 2. Update the renderer so that it updates the tilemap object
|
||||
// (used for width and position calculations).
|
||||
this._loadInitialTileMap((tileMap: TileMapHelper.EditableTileMap) => {
|
||||
// 3. Set custom dimensions & opacity if applicable.
|
||||
if (initialInstanceData.customSize) {
|
||||
this.setWidth(initialInstanceData.width);
|
||||
this.setHeight(initialInstanceData.height);
|
||||
}
|
||||
if (initialInstanceData.opacity !== undefined) {
|
||||
this.setOpacity(initialInstanceData.opacity);
|
||||
}
|
||||
this._loadTileMap(
|
||||
this._initialTileMapAsJsObject,
|
||||
(tileMap: TileMapHelper.EditableTileMap) => {
|
||||
// 3. Set custom dimensions & opacity if applicable.
|
||||
if (initialInstanceData.customSize) {
|
||||
this.setWidth(initialInstanceData.width);
|
||||
this.setHeight(initialInstanceData.height);
|
||||
}
|
||||
if (initialInstanceData.opacity !== undefined) {
|
||||
this.setOpacity(initialInstanceData.opacity);
|
||||
}
|
||||
|
||||
// 4. Update position (calculations based on renderer's dimensions).
|
||||
this._renderer.updatePosition();
|
||||
// 4. Update position (calculations based on renderer's dimensions).
|
||||
this._renderer.updatePosition();
|
||||
|
||||
if (this._collisionTileMap) {
|
||||
// If collision tile map is already defined, there's a good chance it means
|
||||
// extraInitializationFromInitialInstance is called when hot reloading the
|
||||
// scene so the collision is tile map is updated instead of being re-created.
|
||||
this._collisionTileMap.updateFromTileMap(tileMap);
|
||||
} else {
|
||||
this._collisionTileMap = new gdjs.TileMap.TransformedCollisionTileMap(
|
||||
tileMap,
|
||||
this._hitBoxTag
|
||||
);
|
||||
if (this._collisionTileMap) {
|
||||
// If collision tile map is already defined, there's a good chance it means
|
||||
// extraInitializationFromInitialInstance is called when hot reloading the
|
||||
// scene so the collision is tile map is updated instead of being re-created.
|
||||
this._collisionTileMap.updateFromTileMap(tileMap);
|
||||
} else {
|
||||
this._collisionTileMap =
|
||||
new gdjs.TileMap.TransformedCollisionTileMap(
|
||||
tileMap,
|
||||
this._hitBoxTag
|
||||
);
|
||||
}
|
||||
|
||||
this.updateTransformation();
|
||||
}
|
||||
|
||||
this.updateTransformation();
|
||||
});
|
||||
);
|
||||
}
|
||||
|
||||
private _loadInitialTileMap(
|
||||
private _loadTileMap(
|
||||
tileMapAsJsObject: TileMapHelper.EditableTileMapAsJsObject,
|
||||
tileMapLoadingCallback: (tileMap: TileMapHelper.EditableTileMap) => void
|
||||
): void {
|
||||
if (!this._initialTileMapAsJsObject) return;
|
||||
if (this._columnCount <= 0 || this._rowCount <= 0) {
|
||||
console.error(
|
||||
`Tilemap object ${this.name} is not configured properly.`
|
||||
@@ -240,7 +273,7 @@ namespace gdjs {
|
||||
}
|
||||
|
||||
this._tileMapManager.getOrLoadSimpleTileMap(
|
||||
this._initialTileMapAsJsObject,
|
||||
tileMapAsJsObject,
|
||||
this.name,
|
||||
this._tileSize,
|
||||
this._columnCount,
|
||||
@@ -284,7 +317,8 @@ namespace gdjs {
|
||||
// getOrLoadTextureCache already log warns and errors.
|
||||
return;
|
||||
}
|
||||
this._renderer.updatePixiTileMap(tileMap, textureCache);
|
||||
this._tileMap = tileMap;
|
||||
this._renderer.refreshPixiTileMap(textureCache);
|
||||
tileMapLoadingCallback(tileMap);
|
||||
},
|
||||
(error) => {
|
||||
@@ -640,7 +674,7 @@ namespace gdjs {
|
||||
}
|
||||
|
||||
getTileAtGridCoordinates(columnIndex: integer, rowIndex: integer): integer {
|
||||
return this._renderer.getTileId(columnIndex, rowIndex, 0);
|
||||
return this.getTileId(columnIndex, rowIndex, 0);
|
||||
}
|
||||
|
||||
setTileAtPosition(tileId: number, x: float, y: float) {
|
||||
@@ -654,11 +688,10 @@ namespace gdjs {
|
||||
columnIndex: integer,
|
||||
rowIndex: integer
|
||||
) {
|
||||
const tileMap = this._renderer._tileMap;
|
||||
if (!tileMap) {
|
||||
if (!this._tileMap) {
|
||||
return;
|
||||
}
|
||||
const layer = tileMap.getTileLayer(this._layerIndex);
|
||||
const layer = this._tileMap.getTileLayer(this._layerIndex);
|
||||
if (!layer) {
|
||||
return;
|
||||
}
|
||||
@@ -670,8 +703,8 @@ namespace gdjs {
|
||||
|
||||
if (this._collisionTileMap) {
|
||||
const oldTileDefinition =
|
||||
oldTileId !== undefined && tileMap.getTileDefinition(oldTileId);
|
||||
const newTileDefinition = tileMap.getTileDefinition(tileId);
|
||||
oldTileId !== undefined && this._tileMap.getTileDefinition(oldTileId);
|
||||
const newTileDefinition = this._tileMap.getTileDefinition(tileId);
|
||||
const hadFullHitBox =
|
||||
!!oldTileDefinition &&
|
||||
oldTileDefinition.hasFullHitBox(this._hitBoxTag);
|
||||
@@ -707,7 +740,7 @@ namespace gdjs {
|
||||
rowIndex: integer,
|
||||
flip: boolean
|
||||
) {
|
||||
this._renderer.flipTileOnY(columnIndex, rowIndex, 0, flip);
|
||||
this.flipTileOnY(columnIndex, rowIndex, 0, flip);
|
||||
this._isTileMapDirty = true;
|
||||
// No need to invalidate hit boxes since at the moment, collision mask
|
||||
// cannot be configured on each tile.
|
||||
@@ -718,7 +751,7 @@ namespace gdjs {
|
||||
rowIndex: integer,
|
||||
flip: boolean
|
||||
) {
|
||||
this._renderer.flipTileOnX(columnIndex, rowIndex, 0, flip);
|
||||
this.flipTileOnX(columnIndex, rowIndex, 0, flip);
|
||||
this._isTileMapDirty = true;
|
||||
// No need to invalidate hit boxes since at the moment, collision mask
|
||||
// cannot be configured on each tile.
|
||||
@@ -728,22 +761,22 @@ namespace gdjs {
|
||||
const [columnIndex, rowIndex] =
|
||||
this.getGridCoordinatesFromSceneCoordinates(x, y);
|
||||
|
||||
return this._renderer.isTileFlippedOnX(columnIndex, rowIndex, 0);
|
||||
return this.isTileFlippedOnX(columnIndex, rowIndex, 0);
|
||||
}
|
||||
|
||||
isTileFlippedOnXAtGridCoordinates(columnIndex: integer, rowIndex: integer) {
|
||||
return this._renderer.isTileFlippedOnX(columnIndex, rowIndex, 0);
|
||||
return this.isTileFlippedOnX(columnIndex, rowIndex, 0);
|
||||
}
|
||||
|
||||
isTileFlippedOnYAtPosition(x: float, y: float) {
|
||||
const [columnIndex, rowIndex] =
|
||||
this.getGridCoordinatesFromSceneCoordinates(x, y);
|
||||
|
||||
return this._renderer.isTileFlippedOnY(columnIndex, rowIndex, 0);
|
||||
return this.isTileFlippedOnY(columnIndex, rowIndex, 0);
|
||||
}
|
||||
|
||||
isTileFlippedOnYAtGridCoordinates(columnIndex: integer, rowIndex: integer) {
|
||||
return this._renderer.isTileFlippedOnY(columnIndex, rowIndex, 0);
|
||||
return this.isTileFlippedOnY(columnIndex, rowIndex, 0);
|
||||
}
|
||||
|
||||
removeTileAtPosition(x: float, y: float) {
|
||||
@@ -753,11 +786,10 @@ namespace gdjs {
|
||||
}
|
||||
|
||||
removeTileAtGridCoordinates(columnIndex: integer, rowIndex: integer) {
|
||||
const tileMap = this._renderer._tileMap;
|
||||
if (!tileMap) {
|
||||
if (!this._tileMap) {
|
||||
return;
|
||||
}
|
||||
const layer = tileMap.getTileLayer(this._layerIndex);
|
||||
const layer = this._tileMap.getTileLayer(this._layerIndex);
|
||||
if (!layer) {
|
||||
return;
|
||||
}
|
||||
@@ -779,24 +811,28 @@ namespace gdjs {
|
||||
|
||||
setGridRowCount(targetRowCount: integer) {
|
||||
if (targetRowCount <= 0) return;
|
||||
this._renderer.setGridRowCount(targetRowCount);
|
||||
if (!this._tileMap) return;
|
||||
this._tileMap.setDimensionY(targetRowCount);
|
||||
this._isTileMapDirty = true;
|
||||
this.invalidateHitboxes();
|
||||
}
|
||||
|
||||
setGridColumnCount(targetColumnCount: integer) {
|
||||
if (targetColumnCount <= 0) return;
|
||||
this._renderer.setGridColumnCount(targetColumnCount);
|
||||
if (!this._tileMap) return;
|
||||
this._tileMap.setDimensionX(targetColumnCount);
|
||||
this._isTileMapDirty = true;
|
||||
this.invalidateHitboxes();
|
||||
}
|
||||
|
||||
getGridRowCount(): integer {
|
||||
return this._renderer.getGridRowCount();
|
||||
if (!this._tileMap) return 0;
|
||||
return this._tileMap.getDimensionY();
|
||||
}
|
||||
|
||||
getGridColumnCount(): integer {
|
||||
return this._renderer.getGridColumnCount();
|
||||
if (!this._tileMap) return 0;
|
||||
return this._tileMap.getDimensionX();
|
||||
}
|
||||
|
||||
getTilesetColumnCount(): integer {
|
||||
@@ -806,6 +842,73 @@ namespace gdjs {
|
||||
getTilesetRowCount(): integer {
|
||||
return this._rowCount;
|
||||
}
|
||||
|
||||
getTileMap(): TileMapHelper.EditableTileMap | null {
|
||||
return this._tileMap;
|
||||
}
|
||||
|
||||
getTileMapWidth() {
|
||||
const tileMap = this._tileMap;
|
||||
return tileMap ? tileMap.getWidth() : 20;
|
||||
}
|
||||
|
||||
getTileMapHeight() {
|
||||
const tileMap = this._tileMap;
|
||||
return tileMap ? tileMap.getHeight() : 20;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param x The layer column.
|
||||
* @param y The layer row.
|
||||
* @param layerIndex The layer index.
|
||||
* @returns The tile's id.
|
||||
*/
|
||||
getTileId(x: integer, y: integer, layerIndex: integer): integer {
|
||||
if (!this._tileMap) return -1;
|
||||
return this._tileMap.getTileId(x, y, layerIndex);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param x The layer column.
|
||||
* @param y The layer row.
|
||||
* @param layerIndex The layer index.
|
||||
* @param flip true if the tile should be flipped.
|
||||
*/
|
||||
flipTileOnY(x: integer, y: integer, layerIndex: integer, flip: boolean) {
|
||||
if (!this._tileMap) return;
|
||||
this._tileMap.flipTileOnY(x, y, layerIndex, flip);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param x The layer column.
|
||||
* @param y The layer row.
|
||||
* @param layerIndex The layer index.
|
||||
* @param flip true if the tile should be flipped.
|
||||
*/
|
||||
flipTileOnX(x: integer, y: integer, layerIndex: integer, flip: boolean) {
|
||||
if (!this._tileMap) return;
|
||||
this._tileMap.flipTileOnX(x, y, layerIndex, flip);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param x The layer column.
|
||||
* @param y The layer row.
|
||||
* @param layerIndex The layer index.
|
||||
*/
|
||||
isTileFlippedOnX(x: integer, y: integer, layerIndex: integer): boolean {
|
||||
if (!this._tileMap) return false;
|
||||
return this._tileMap.isTileFlippedOnX(x, y, layerIndex);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param x The layer column.
|
||||
* @param y The layer row.
|
||||
* @param layerIndex The layer index.
|
||||
*/
|
||||
isTileFlippedOnY(x: integer, y: integer, layerIndex: integer): boolean {
|
||||
if (!this._tileMap) return false;
|
||||
return this._tileMap.isTileFlippedOnY(x, y, layerIndex);
|
||||
}
|
||||
}
|
||||
gdjs.registerObject(
|
||||
'TileMap::SimpleTileMap',
|
||||
|
@@ -189,9 +189,11 @@ namespace gdjs {
|
||||
return true;
|
||||
}
|
||||
|
||||
getNetworkSyncData(): TilemapCollisionMaskNetworkSyncData {
|
||||
getNetworkSyncData(
|
||||
syncOptions: GetNetworkSyncDataOptions
|
||||
): TilemapCollisionMaskNetworkSyncData {
|
||||
return {
|
||||
...super.getNetworkSyncData(),
|
||||
...super.getNetworkSyncData(syncOptions),
|
||||
tmjf: this.getTilemapJsonFile(),
|
||||
tsjf: this.getTilesetJsonFile(),
|
||||
dm: this.getDebugMode(),
|
||||
@@ -204,9 +206,10 @@ namespace gdjs {
|
||||
}
|
||||
|
||||
updateFromNetworkSyncData(
|
||||
networkSyncData: TilemapCollisionMaskNetworkSyncData
|
||||
networkSyncData: TilemapCollisionMaskNetworkSyncData,
|
||||
options: UpdateFromNetworkSyncDataOptions
|
||||
): void {
|
||||
super.updateFromNetworkSyncData(networkSyncData);
|
||||
super.updateFromNetworkSyncData(networkSyncData, options);
|
||||
|
||||
if (networkSyncData.tmjf !== undefined) {
|
||||
this.setTilemapJsonFile(networkSyncData.tmjf);
|
||||
|
@@ -10,8 +10,6 @@ namespace gdjs {
|
||||
private _object:
|
||||
| gdjs.TileMapRuntimeObject
|
||||
| gdjs.SimpleTileMapRuntimeObject;
|
||||
// TODO Move this attribute in the object as it's a model.
|
||||
_tileMap: TileMapHelper.EditableTileMap | null = null;
|
||||
|
||||
private _pixiObject: PIXI.tilemap.CompositeTilemap;
|
||||
|
||||
@@ -51,40 +49,9 @@ namespace gdjs {
|
||||
this._pixiObject.tileAnim[0] += 1;
|
||||
}
|
||||
|
||||
updatePixiTileMap(
|
||||
tileMap: TileMapHelper.EditableTileMap,
|
||||
textureCache: TileMapHelper.TileTextureCache
|
||||
) {
|
||||
this._tileMap = tileMap;
|
||||
TileMapHelper.PixiTileMapHelper.updatePixiTileMap(
|
||||
this._pixiObject,
|
||||
tileMap,
|
||||
textureCache,
|
||||
// @ts-ignore
|
||||
this._object._displayMode,
|
||||
this._object._layerIndex
|
||||
);
|
||||
}
|
||||
|
||||
refreshPixiTileMap(textureCache: TileMapHelper.TileTextureCache) {
|
||||
if (!this._tileMap) return;
|
||||
TileMapHelper.PixiTileMapHelper.updatePixiTileMap(
|
||||
this._pixiObject,
|
||||
this._tileMap,
|
||||
textureCache,
|
||||
// @ts-ignore
|
||||
this._object._displayMode,
|
||||
this._object._layerIndex
|
||||
);
|
||||
}
|
||||
|
||||
getTileMap(): TileMapHelper.EditableTileMap | null {
|
||||
return this._tileMap;
|
||||
}
|
||||
|
||||
updatePosition(): void {
|
||||
this._pixiObject.pivot.x = this.getTileMapWidth() / 2;
|
||||
this._pixiObject.pivot.y = this.getTileMapHeight() / 2;
|
||||
this._pixiObject.pivot.x = this._object.getTileMapWidth() / 2;
|
||||
this._pixiObject.pivot.y = this._object.getTileMapHeight() / 2;
|
||||
this._pixiObject.position.x = this._object.x + this.getWidth() / 2;
|
||||
this._pixiObject.position.y = this._object.y + this.getHeight() / 2;
|
||||
}
|
||||
@@ -98,7 +65,7 @@ namespace gdjs {
|
||||
// opacity. Setting alpha on each layer tile might not be useful as
|
||||
// each layer would be separately transparent instead of the whole tilemap.
|
||||
this._pixiObject.alpha = this._object._opacity / 255;
|
||||
const tileMap = this._tileMap;
|
||||
const tileMap = this._object.getTileMap();
|
||||
if (!tileMap) return;
|
||||
for (const layer of tileMap.getLayers()) {
|
||||
if (
|
||||
@@ -114,44 +81,34 @@ namespace gdjs {
|
||||
}
|
||||
}
|
||||
|
||||
getTileMapWidth() {
|
||||
const tileMap = this._tileMap;
|
||||
return tileMap ? tileMap.getWidth() : 20;
|
||||
}
|
||||
|
||||
getTileMapHeight() {
|
||||
const tileMap = this._tileMap;
|
||||
return tileMap ? tileMap.getHeight() : 20;
|
||||
}
|
||||
|
||||
setWidth(width: float): void {
|
||||
this._pixiObject.scale.x = width / this.getTileMapWidth();
|
||||
this._pixiObject.scale.x = width / this._object.getTileMapWidth();
|
||||
this._pixiObject.position.x = this._object.x + width / 2;
|
||||
}
|
||||
|
||||
setHeight(height: float): void {
|
||||
this._pixiObject.scale.y = height / this.getTileMapHeight();
|
||||
this._pixiObject.scale.y = height / this._object.getTileMapHeight();
|
||||
this._pixiObject.position.y = this._object.y + height / 2;
|
||||
}
|
||||
|
||||
setScaleX(scaleX: float): void {
|
||||
this._pixiObject.scale.x = scaleX;
|
||||
const width = scaleX * this.getTileMapWidth();
|
||||
const width = scaleX * this._object.getTileMapWidth();
|
||||
this._pixiObject.position.x = this._object.x + width / 2;
|
||||
}
|
||||
|
||||
setScaleY(scaleY: float): void {
|
||||
this._pixiObject.scale.y = scaleY;
|
||||
const height = scaleY * this.getTileMapHeight();
|
||||
const height = scaleY * this._object.getTileMapHeight();
|
||||
this._pixiObject.position.y = this._object.y + height / 2;
|
||||
}
|
||||
|
||||
getWidth(): float {
|
||||
return this.getTileMapWidth() * this._pixiObject.scale.x;
|
||||
return this._object.getTileMapWidth() * this._pixiObject.scale.x;
|
||||
}
|
||||
|
||||
getHeight(): float {
|
||||
return this.getTileMapHeight() * this._pixiObject.scale.y;
|
||||
return this._object.getTileMapHeight() * this._pixiObject.scale.y;
|
||||
}
|
||||
|
||||
getScaleX(): float {
|
||||
@@ -162,91 +119,17 @@ namespace gdjs {
|
||||
return this._pixiObject.scale.y;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param x The layer column.
|
||||
* @param y The layer row.
|
||||
* @param layerIndex The layer index.
|
||||
* @returns The tile's id.
|
||||
*/
|
||||
getTileId(x: integer, y: integer, layerIndex: integer): integer {
|
||||
const tileMap = this._tileMap;
|
||||
if (!tileMap) return -1;
|
||||
return tileMap.getTileId(x, y, layerIndex);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param x The layer column.
|
||||
* @param y The layer row.
|
||||
* @param layerIndex The layer index.
|
||||
* @param flip true if the tile should be flipped.
|
||||
*/
|
||||
flipTileOnY(x: integer, y: integer, layerIndex: integer, flip: boolean) {
|
||||
const tileMap = this._tileMap;
|
||||
refreshPixiTileMap(textureCache: TileMapHelper.TileTextureCache) {
|
||||
const tileMap = this._object.getTileMap();
|
||||
if (!tileMap) return;
|
||||
tileMap.flipTileOnY(x, y, layerIndex, flip);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param x The layer column.
|
||||
* @param y The layer row.
|
||||
* @param layerIndex The layer index.
|
||||
* @param flip true if the tile should be flipped.
|
||||
*/
|
||||
flipTileOnX(x: integer, y: integer, layerIndex: integer, flip: boolean) {
|
||||
const tileMap = this._tileMap;
|
||||
if (!tileMap) return;
|
||||
tileMap.flipTileOnX(x, y, layerIndex, flip);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param x The layer column.
|
||||
* @param y The layer row.
|
||||
* @param layerIndex The layer index.
|
||||
*/
|
||||
isTileFlippedOnX(x: integer, y: integer, layerIndex: integer): boolean {
|
||||
const tileMap = this._tileMap;
|
||||
if (!tileMap) return false;
|
||||
return tileMap.isTileFlippedOnX(x, y, layerIndex);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param x The layer column.
|
||||
* @param y The layer row.
|
||||
* @param layerIndex The layer index.
|
||||
*/
|
||||
isTileFlippedOnY(x: integer, y: integer, layerIndex: integer): boolean {
|
||||
const tileMap = this._tileMap;
|
||||
if (!tileMap) return false;
|
||||
return tileMap.isTileFlippedOnY(x, y, layerIndex);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param targetRowCount The number of rows to have.
|
||||
*/
|
||||
setGridRowCount(targetRowCount: integer) {
|
||||
const tileMap = this._tileMap;
|
||||
if (!tileMap) return;
|
||||
return tileMap.setDimensionY(targetRowCount);
|
||||
}
|
||||
/**
|
||||
* @param targetColumnCount The number of rows to have.
|
||||
*/
|
||||
setGridColumnCount(targetColumnCount: integer) {
|
||||
const tileMap = this._tileMap;
|
||||
if (!tileMap) return;
|
||||
return tileMap.setDimensionX(targetColumnCount);
|
||||
}
|
||||
|
||||
getGridRowCount(): integer {
|
||||
const tileMap = this._tileMap;
|
||||
if (!tileMap) return 0;
|
||||
return tileMap.getDimensionY();
|
||||
}
|
||||
|
||||
getGridColumnCount(): integer {
|
||||
const tileMap = this._tileMap;
|
||||
if (!tileMap) return 0;
|
||||
return tileMap.getDimensionX();
|
||||
TileMapHelper.PixiTileMapHelper.updatePixiTileMap(
|
||||
this._pixiObject,
|
||||
tileMap,
|
||||
textureCache,
|
||||
// @ts-ignore
|
||||
this._displayMode,
|
||||
this._object._layerIndex
|
||||
);
|
||||
}
|
||||
|
||||
destroy(): void {
|
||||
|
@@ -2,7 +2,6 @@
|
||||
namespace gdjs {
|
||||
export type TilemapObjectDataType = {
|
||||
content: {
|
||||
opacity: number;
|
||||
tilemapJsonFile: string;
|
||||
tilesetJsonFile: string;
|
||||
tilemapAtlasImage: string;
|
||||
@@ -38,7 +37,7 @@ namespace gdjs {
|
||||
implements gdjs.Resizable, gdjs.Scalable, gdjs.OpacityHandler
|
||||
{
|
||||
_frameElapsedTime: float = 0;
|
||||
_opacity: float;
|
||||
_opacity: float = 255;
|
||||
_tilemapJsonFile: string;
|
||||
_tilesetJsonFile: string;
|
||||
_tilemapAtlasImage: string;
|
||||
@@ -48,11 +47,14 @@ namespace gdjs {
|
||||
_animationSpeedScale: number;
|
||||
_animationFps: number;
|
||||
_tileMapManager: gdjs.TileMap.TileMapRuntimeManager;
|
||||
_tileMap: TileMapHelper.EditableTileMap | null = null;
|
||||
_renderer: gdjs.TileMapRuntimeObjectPixiRenderer;
|
||||
|
||||
constructor(instanceContainer: gdjs.RuntimeInstanceContainer, objectData) {
|
||||
constructor(
|
||||
instanceContainer: gdjs.RuntimeInstanceContainer,
|
||||
objectData: TilemapObjectData
|
||||
) {
|
||||
super(instanceContainer, objectData);
|
||||
this._opacity = objectData.content.opacity;
|
||||
this._tilemapJsonFile = objectData.content.tilemapJsonFile;
|
||||
this._tilesetJsonFile = objectData.content.tilesetJsonFile;
|
||||
this._tilemapAtlasImage = objectData.content.tilemapAtlasImage;
|
||||
@@ -93,9 +95,6 @@ namespace gdjs {
|
||||
oldObjectData: TilemapObjectData,
|
||||
newObjectData: TilemapObjectData
|
||||
): boolean {
|
||||
if (oldObjectData.content.opacity !== newObjectData.content.opacity) {
|
||||
this.setOpacity(newObjectData.content.opacity);
|
||||
}
|
||||
if (
|
||||
oldObjectData.content.tilemapJsonFile !==
|
||||
newObjectData.content.tilemapJsonFile
|
||||
@@ -145,9 +144,11 @@ namespace gdjs {
|
||||
return true;
|
||||
}
|
||||
|
||||
getNetworkSyncData(): TilemapNetworkSyncData {
|
||||
getNetworkSyncData(
|
||||
syncOptions: GetNetworkSyncDataOptions
|
||||
): TilemapNetworkSyncData {
|
||||
return {
|
||||
...super.getNetworkSyncData(),
|
||||
...super.getNetworkSyncData(syncOptions),
|
||||
op: this._opacity,
|
||||
tmjf: this._tilemapJsonFile,
|
||||
tsjf: this._tilesetJsonFile,
|
||||
@@ -159,8 +160,11 @@ namespace gdjs {
|
||||
};
|
||||
}
|
||||
|
||||
updateFromNetworkSyncData(networkSyncData: TilemapNetworkSyncData): void {
|
||||
super.updateFromNetworkSyncData(networkSyncData);
|
||||
updateFromNetworkSyncData(
|
||||
networkSyncData: TilemapNetworkSyncData,
|
||||
options: UpdateFromNetworkSyncDataOptions
|
||||
): void {
|
||||
super.updateFromNetworkSyncData(networkSyncData, options);
|
||||
|
||||
if (networkSyncData.op !== undefined) {
|
||||
this.setOpacity(networkSyncData.op);
|
||||
@@ -230,7 +234,9 @@ namespace gdjs {
|
||||
// getOrLoadTextureCache already log warns and errors.
|
||||
return;
|
||||
}
|
||||
this._renderer.updatePixiTileMap(tileMap, textureCache);
|
||||
this._tileMap = tileMap;
|
||||
this._renderer.refreshPixiTileMap(textureCache);
|
||||
this.invalidateHitboxes();
|
||||
}
|
||||
);
|
||||
}
|
||||
@@ -427,6 +433,73 @@ namespace gdjs {
|
||||
getScaleY(): float {
|
||||
return this._renderer.getScaleY();
|
||||
}
|
||||
|
||||
getTileMap(): TileMapHelper.EditableTileMap | null {
|
||||
return this._tileMap;
|
||||
}
|
||||
|
||||
getTileMapWidth() {
|
||||
const tileMap = this._tileMap;
|
||||
return tileMap ? tileMap.getWidth() : 20;
|
||||
}
|
||||
|
||||
getTileMapHeight() {
|
||||
const tileMap = this._tileMap;
|
||||
return tileMap ? tileMap.getHeight() : 20;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param x The layer column.
|
||||
* @param y The layer row.
|
||||
* @param layerIndex The layer index.
|
||||
* @returns The tile's id.
|
||||
*/
|
||||
getTileId(x: integer, y: integer, layerIndex: integer): integer {
|
||||
if (!this._tileMap) return -1;
|
||||
return this._tileMap.getTileId(x, y, layerIndex);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param x The layer column.
|
||||
* @param y The layer row.
|
||||
* @param layerIndex The layer index.
|
||||
* @param flip true if the tile should be flipped.
|
||||
*/
|
||||
flipTileOnY(x: integer, y: integer, layerIndex: integer, flip: boolean) {
|
||||
if (!this._tileMap) return;
|
||||
this._tileMap.flipTileOnY(x, y, layerIndex, flip);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param x The layer column.
|
||||
* @param y The layer row.
|
||||
* @param layerIndex The layer index.
|
||||
* @param flip true if the tile should be flipped.
|
||||
*/
|
||||
flipTileOnX(x: integer, y: integer, layerIndex: integer, flip: boolean) {
|
||||
if (!this._tileMap) return;
|
||||
this._tileMap.flipTileOnX(x, y, layerIndex, flip);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param x The layer column.
|
||||
* @param y The layer row.
|
||||
* @param layerIndex The layer index.
|
||||
*/
|
||||
isTileFlippedOnX(x: integer, y: integer, layerIndex: integer): boolean {
|
||||
if (!this._tileMap) return false;
|
||||
return this._tileMap.isTileFlippedOnX(x, y, layerIndex);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param x The layer column.
|
||||
* @param y The layer row.
|
||||
* @param layerIndex The layer index.
|
||||
*/
|
||||
isTileFlippedOnY(x: integer, y: integer, layerIndex: integer): boolean {
|
||||
if (!this._tileMap) return false;
|
||||
return this._tileMap.isTileFlippedOnY(x, y, layerIndex);
|
||||
}
|
||||
}
|
||||
gdjs.registerObject('TileMap::TileMap', gdjs.TileMapRuntimeObject);
|
||||
}
|
||||
|
@@ -78,9 +78,11 @@ namespace gdjs {
|
||||
return true;
|
||||
}
|
||||
|
||||
getNetworkSyncData(): TiledSpriteNetworkSyncData {
|
||||
getNetworkSyncData(
|
||||
syncOptons: GetNetworkSyncDataOptions
|
||||
): TiledSpriteNetworkSyncData {
|
||||
return {
|
||||
...super.getNetworkSyncData(),
|
||||
...super.getNetworkSyncData(syncOptons),
|
||||
xo: this.getXOffset(),
|
||||
yo: this.getYOffset(),
|
||||
op: this.getOpacity(),
|
||||
@@ -89,9 +91,10 @@ namespace gdjs {
|
||||
}
|
||||
|
||||
updateFromNetworkSyncData(
|
||||
networkSyncData: TiledSpriteNetworkSyncData
|
||||
networkSyncData: TiledSpriteNetworkSyncData,
|
||||
options: UpdateFromNetworkSyncDataOptions
|
||||
): void {
|
||||
super.updateFromNetworkSyncData(networkSyncData);
|
||||
super.updateFromNetworkSyncData(networkSyncData, options);
|
||||
|
||||
// Texture is not synchronized, see if this is asked or not.
|
||||
|
||||
|
@@ -63,7 +63,7 @@ namespace gdjs {
|
||||
// This is useful when the object is synchronized by an external source
|
||||
// like in a multiplayer game, and we want to be able to predict the
|
||||
// movement of the object, even if the inputs are not updated every frame.
|
||||
_dontClearInputsBetweenFrames: boolean = false;
|
||||
private _clearInputsBetweenFrames: boolean = true;
|
||||
// This is useful when the object is synchronized over the network,
|
||||
// object is controlled by the network and we want to ensure the current player
|
||||
// cannot control it.
|
||||
@@ -109,14 +109,16 @@ namespace gdjs {
|
||||
: behaviorData.useLegacyTurnBack;
|
||||
}
|
||||
|
||||
getNetworkSyncData(): TopDownMovementNetworkSyncData {
|
||||
getNetworkSyncData(
|
||||
options: GetNetworkSyncDataOptions
|
||||
): TopDownMovementNetworkSyncData {
|
||||
// This method is called, so we are synchronizing this object.
|
||||
// Let's clear the inputs between frames as we control it.
|
||||
this._dontClearInputsBetweenFrames = false;
|
||||
this._clearInputsBetweenFrames = true;
|
||||
this._ignoreDefaultControlsAsSyncedByNetwork = false;
|
||||
|
||||
return {
|
||||
...super.getNetworkSyncData(),
|
||||
...super.getNetworkSyncData(options),
|
||||
props: {
|
||||
a: this._angle,
|
||||
xv: this._xVelocity,
|
||||
@@ -134,9 +136,10 @@ namespace gdjs {
|
||||
}
|
||||
|
||||
updateFromNetworkSyncData(
|
||||
networkSyncData: TopDownMovementNetworkSyncData
|
||||
networkSyncData: TopDownMovementNetworkSyncData,
|
||||
options: UpdateFromNetworkSyncDataOptions
|
||||
): void {
|
||||
super.updateFromNetworkSyncData(networkSyncData);
|
||||
super.updateFromNetworkSyncData(networkSyncData, options);
|
||||
|
||||
const behaviorSpecificProps = networkSyncData.props;
|
||||
if (behaviorSpecificProps.a !== undefined) {
|
||||
@@ -173,10 +176,10 @@ namespace gdjs {
|
||||
this._stickForce = behaviorSpecificProps.sf;
|
||||
}
|
||||
|
||||
// When the object is synchronized from the network, the inputs must not be cleared.
|
||||
this._dontClearInputsBetweenFrames = true;
|
||||
// And we are not using the default controls.
|
||||
this._ignoreDefaultControlsAsSyncedByNetwork = true;
|
||||
// Clear user inputs between frames only if requested.
|
||||
this._clearInputsBetweenFrames = !!options.clearInputs;
|
||||
// And ignore default controls if not asked otherwise.
|
||||
this._ignoreDefaultControlsAsSyncedByNetwork = !options.keepControl;
|
||||
}
|
||||
|
||||
updateFromBehaviorData(oldBehaviorData, newBehaviorData): boolean {
|
||||
@@ -581,7 +584,7 @@ namespace gdjs {
|
||||
this._wasRightKeyPressed = this._rightKey;
|
||||
this._wasUpKeyPressed = this._upKey;
|
||||
this._wasDownKeyPressed = this._downKey;
|
||||
if (!this._dontClearInputsBetweenFrames) {
|
||||
if (this._clearInputsBetweenFrames) {
|
||||
this._leftKey = false;
|
||||
this._rightKey = false;
|
||||
this._upKey = false;
|
||||
|
File diff suppressed because it is too large
Load Diff
@@ -4,6 +4,15 @@ Copyright (c) 2010-2023 Florian Rival (Florian.Rival@gmail.com)
|
||||
*/
|
||||
namespace gdjs {
|
||||
const logger = new gdjs.Logger('Tween');
|
||||
|
||||
interface TweenBehaviorNetworkSyncDataType {
|
||||
tweenManager: TweenManagerNetworkSyncData;
|
||||
}
|
||||
export interface TweenBehaviorNetworkSyncData
|
||||
extends BehaviorNetworkSyncData {
|
||||
props: TweenBehaviorNetworkSyncDataType;
|
||||
}
|
||||
|
||||
interface IColorable extends gdjs.RuntimeObject {
|
||||
setColor(color: string): void;
|
||||
getColor(): string;
|
||||
@@ -59,6 +68,305 @@ namespace gdjs {
|
||||
const exponentialInterpolation =
|
||||
gdjs.evtTools.common.exponentialInterpolation;
|
||||
|
||||
const tweenObjectValueSetter = () => {};
|
||||
const getTweenVariableSetter = (variable: gdjs.Variable) => {
|
||||
return (value: float) => variable.setNumber(value);
|
||||
};
|
||||
const getTweenObjectPositionXSetter = (object: gdjs.RuntimeObject) => {
|
||||
return (value: float) => object.setX(value);
|
||||
};
|
||||
const getTweenObjectPositionYSetter = (object: gdjs.RuntimeObject) => {
|
||||
return (value: float) => object.setY(value);
|
||||
};
|
||||
const getTweenObjectPositionZSetter = (object: gdjs.RuntimeObject) => {
|
||||
if (!is3D(object)) return () => {};
|
||||
return (value: float) => object.setZ(value);
|
||||
};
|
||||
const getTweenObjectPositionSetter = (object: gdjs.RuntimeObject) => {
|
||||
return ([x, y]: float[]) => object.setPosition(x, y);
|
||||
};
|
||||
const getTweenObjectAngleSetter = (object: gdjs.RuntimeObject) => {
|
||||
return (value: float) => object.setAngle(value);
|
||||
};
|
||||
const getTweenObjectWidthSetter = (object: gdjs.RuntimeObject) => {
|
||||
return (value: float) => object.setWidth(value);
|
||||
};
|
||||
const getTweenObjectHeightSetter = (object: gdjs.RuntimeObject) => {
|
||||
return (value: float) => object.setHeight(value);
|
||||
};
|
||||
const getTweenObjectRotationXSetter = (
|
||||
object: gdjs.RuntimeObject & gdjs.Base3DHandler
|
||||
) => {
|
||||
return (value: float) => object.setRotationX(value);
|
||||
};
|
||||
const getTweenObjectRotationYSetter = (
|
||||
object: gdjs.RuntimeObject & gdjs.Base3DHandler
|
||||
) => {
|
||||
return (value: float) => object.setRotationY(value);
|
||||
};
|
||||
const getTweenObjectDepthSetter = (
|
||||
object: gdjs.RuntimeObject & gdjs.Base3DHandler
|
||||
) => {
|
||||
return (value: float) => object.setDepth(value);
|
||||
};
|
||||
const getTweenObjectScaleXYSetter = (
|
||||
object: gdjs.RuntimeObject & gdjs.Scalable,
|
||||
scaleFromCenterOfObject: boolean
|
||||
) => {
|
||||
return scaleFromCenterOfObject
|
||||
? ([scaleX, scaleY]: float[]) => {
|
||||
const oldX = object.getCenterXInScene();
|
||||
const oldY = object.getCenterYInScene();
|
||||
object.setScaleX(scaleX);
|
||||
object.setScaleY(scaleY);
|
||||
object.setCenterPositionInScene(oldX, oldY);
|
||||
}
|
||||
: ([scaleX, scaleY]: float[]) => {
|
||||
object.setScaleX(scaleX);
|
||||
object.setScaleY(scaleY);
|
||||
};
|
||||
};
|
||||
const getTweenObjectScaleSetter = (
|
||||
object: gdjs.RuntimeObject & gdjs.Scalable,
|
||||
object3d: (gdjs.RuntimeObject & gdjs.Base3DHandler) | null,
|
||||
scaleFromCenterOfObject: boolean
|
||||
) => {
|
||||
return scaleFromCenterOfObject
|
||||
? (scale: float) => {
|
||||
const oldX = object.getCenterXInScene();
|
||||
const oldY = object.getCenterYInScene();
|
||||
const oldZ = object3d ? object3d.getCenterZInScene() : 0;
|
||||
object.setScale(scale);
|
||||
object.setCenterXInScene(oldX);
|
||||
object.setCenterYInScene(oldY);
|
||||
if (object3d) {
|
||||
object3d.setCenterZInScene(oldZ);
|
||||
}
|
||||
}
|
||||
: (scale: float) => object.setScale(scale);
|
||||
};
|
||||
const getTweenObjectScaleXSetter = (
|
||||
object: gdjs.RuntimeObject & gdjs.Scalable,
|
||||
scaleFromCenterOfObject: boolean
|
||||
) => {
|
||||
return scaleFromCenterOfObject
|
||||
? (scaleX: float) => {
|
||||
const oldX = object.getCenterXInScene();
|
||||
object.setScaleX(scaleX);
|
||||
object.setCenterXInScene(oldX);
|
||||
}
|
||||
: (scaleX: float) => object.setScaleX(scaleX);
|
||||
};
|
||||
const getTweenObjectScaleYSetter = (
|
||||
object: gdjs.RuntimeObject & gdjs.Scalable,
|
||||
scaleFromCenterOfObject: boolean
|
||||
) => {
|
||||
return scaleFromCenterOfObject
|
||||
? (scaleY: float) => {
|
||||
const oldY = object.getCenterYInScene();
|
||||
object.setScaleY(scaleY);
|
||||
object.setCenterYInScene(oldY);
|
||||
}
|
||||
: (scaleY: float) => object.setScaleY(scaleY);
|
||||
};
|
||||
const getTweenObjectOpacitySetter = (
|
||||
object: gdjs.RuntimeObject & gdjs.OpacityHandler
|
||||
) => {
|
||||
return (value: float) => object.setOpacity(value);
|
||||
};
|
||||
const getTweenObjectCharacterSizeSetter = (object: ICharacterScalable) => {
|
||||
return (value: float) => object.setCharacterSize(value);
|
||||
};
|
||||
const getTweenObjectNumberEffectPropertySetter = (
|
||||
effect: PixiFiltersTools.Filter,
|
||||
propertyName: string
|
||||
) => {
|
||||
return (value: float) => {
|
||||
effect.updateDoubleParameter(propertyName, value);
|
||||
};
|
||||
};
|
||||
const getTweenObjectColorEffectPropertySetter = (
|
||||
effect: PixiFiltersTools.Filter,
|
||||
propertyName: string
|
||||
) => {
|
||||
return ([hue, saturation, lightness]: number[]) => {
|
||||
const rgbFromHslColor = gdjs.evtTools.tween.hslToRgb(
|
||||
hue,
|
||||
saturation,
|
||||
lightness
|
||||
);
|
||||
effect.updateColorParameter(
|
||||
propertyName,
|
||||
gdjs.rgbToHexNumber(
|
||||
rgbFromHslColor[0],
|
||||
rgbFromHslColor[1],
|
||||
rgbFromHslColor[2]
|
||||
)
|
||||
);
|
||||
};
|
||||
};
|
||||
const getTweenObjectColorSetter = (
|
||||
object: IColorable,
|
||||
useHSLColorTransition: boolean
|
||||
) => {
|
||||
if (useHSLColorTransition) {
|
||||
return ([hue, saturation, lightness]: number[]) => {
|
||||
const rgbFromHslColor = gdjs.evtTools.tween.hslToRgb(
|
||||
hue,
|
||||
saturation,
|
||||
lightness
|
||||
);
|
||||
object.setColor(
|
||||
Math.floor(rgbFromHslColor[0]) +
|
||||
';' +
|
||||
Math.floor(rgbFromHslColor[1]) +
|
||||
';' +
|
||||
Math.floor(rgbFromHslColor[2])
|
||||
);
|
||||
};
|
||||
} else {
|
||||
return ([red, green, blue]: number[]) => {
|
||||
object.setColor(
|
||||
Math.floor(red) + ';' + Math.floor(green) + ';' + Math.floor(blue)
|
||||
);
|
||||
};
|
||||
}
|
||||
};
|
||||
const getTweenObjectColorHSLSetter = (object: IColorable) => {
|
||||
return ([hue, saturation, lightness]: number[]) => {
|
||||
const rgbFromHslColor = gdjs.evtTools.tween.hslToRgb(
|
||||
hue,
|
||||
saturation,
|
||||
lightness
|
||||
);
|
||||
|
||||
object.setColor(
|
||||
Math.floor(rgbFromHslColor[0]) +
|
||||
';' +
|
||||
Math.floor(rgbFromHslColor[1]) +
|
||||
';' +
|
||||
Math.floor(rgbFromHslColor[2])
|
||||
);
|
||||
};
|
||||
};
|
||||
|
||||
const tweenSetterFactory =
|
||||
(object: RuntimeObject) =>
|
||||
(tweenInformation: TweenInformationNetworkSyncData) => {
|
||||
const type = tweenInformation.type;
|
||||
const variablePath = tweenInformation.variablePath;
|
||||
const effectName = tweenInformation.effectName;
|
||||
const propertyName = tweenInformation.propertyName;
|
||||
const scaleFromCenterOfObject =
|
||||
!!tweenInformation.scaleFromCenterOfObject;
|
||||
const useHSLColorTransition = !!tweenInformation.useHSLColorTransition;
|
||||
if (type === 'objectValue') {
|
||||
return tweenObjectValueSetter;
|
||||
}
|
||||
if (type === 'variable' && variablePath) {
|
||||
const variable = object
|
||||
.getVariables()
|
||||
.getVariableFromPath(variablePath);
|
||||
if (!variable) return () => {};
|
||||
return getTweenVariableSetter(variable);
|
||||
}
|
||||
if (type === 'positionX') {
|
||||
return getTweenObjectPositionXSetter(object);
|
||||
}
|
||||
if (type === 'positionY') {
|
||||
return getTweenObjectPositionYSetter(object);
|
||||
}
|
||||
if (type === 'position') {
|
||||
return getTweenObjectPositionSetter(object);
|
||||
}
|
||||
if (type === 'positionZ') {
|
||||
return getTweenObjectPositionZSetter(object);
|
||||
}
|
||||
if (type === 'width') {
|
||||
return getTweenObjectWidthSetter(object);
|
||||
}
|
||||
if (type === 'height') {
|
||||
return getTweenObjectHeightSetter(object);
|
||||
}
|
||||
if (type === 'depth') {
|
||||
if (!is3D(object)) return () => {};
|
||||
return getTweenObjectDepthSetter(object);
|
||||
}
|
||||
if (type === 'angle') {
|
||||
return getTweenObjectAngleSetter(object);
|
||||
}
|
||||
if (type === 'rotationX') {
|
||||
if (!is3D(object)) return () => {};
|
||||
return getTweenObjectRotationXSetter(object);
|
||||
}
|
||||
if (type === 'rotationY') {
|
||||
if (!is3D(object)) return () => {};
|
||||
return getTweenObjectRotationYSetter(object);
|
||||
}
|
||||
if (type === 'scale') {
|
||||
if (!isScalable(object)) return () => {};
|
||||
|
||||
const object3d = is3D(object) ? object : null;
|
||||
return getTweenObjectScaleSetter(
|
||||
object,
|
||||
object3d,
|
||||
scaleFromCenterOfObject
|
||||
);
|
||||
}
|
||||
if (type === 'scaleXY') {
|
||||
if (!isScalable(object)) return () => {};
|
||||
return getTweenObjectScaleXYSetter(object, scaleFromCenterOfObject);
|
||||
}
|
||||
if (type === 'scaleX') {
|
||||
if (!isScalable(object)) return () => {};
|
||||
return getTweenObjectScaleXSetter(object, scaleFromCenterOfObject);
|
||||
}
|
||||
if (type === 'scaleY') {
|
||||
if (!isScalable(object)) return () => {};
|
||||
return getTweenObjectScaleYSetter(object, scaleFromCenterOfObject);
|
||||
}
|
||||
if (type === 'opacity') {
|
||||
if (!isOpaque(object)) return () => {};
|
||||
return getTweenObjectOpacitySetter(object);
|
||||
}
|
||||
if (type === 'characterSize') {
|
||||
if (!isCharacterScalable(object)) return () => {};
|
||||
return getTweenObjectCharacterSizeSetter(object);
|
||||
}
|
||||
if (type === 'numberEffectProperty' && effectName && propertyName) {
|
||||
const effect = object.getRendererEffects()[effectName];
|
||||
if (!effect) {
|
||||
logger.error(
|
||||
`The object "${object.name}" doesn't have any effect called "${effectName}"`
|
||||
);
|
||||
}
|
||||
return getTweenObjectNumberEffectPropertySetter(effect, propertyName);
|
||||
}
|
||||
if (type === 'colorEffectProperty' && effectName && propertyName) {
|
||||
const effect = object.getRendererEffects()[effectName];
|
||||
if (!effect) {
|
||||
logger.error(
|
||||
`The object "${object.name}" doesn't have any effect called "${effectName}"`
|
||||
);
|
||||
}
|
||||
|
||||
return getTweenObjectColorEffectPropertySetter(effect, propertyName);
|
||||
}
|
||||
|
||||
if (type === 'objectColor') {
|
||||
if (!isColorable(object)) return () => {};
|
||||
|
||||
return getTweenObjectColorSetter(object, useHSLColorTransition);
|
||||
}
|
||||
if (type === 'objectColorHSL') {
|
||||
if (!isColorable(object)) return () => {};
|
||||
|
||||
return getTweenObjectColorHSLSetter(object);
|
||||
}
|
||||
|
||||
return () => {};
|
||||
};
|
||||
|
||||
export class TweenRuntimeBehavior extends gdjs.RuntimeBehavior {
|
||||
private _tweens = new gdjs.evtTools.tween.TweenManager();
|
||||
private _isActive: boolean = true;
|
||||
@@ -84,6 +392,43 @@ namespace gdjs {
|
||||
return true;
|
||||
}
|
||||
|
||||
getNetworkSyncData(
|
||||
syncOptions: GetNetworkSyncDataOptions
|
||||
): TweenBehaviorNetworkSyncData {
|
||||
return {
|
||||
...super.getNetworkSyncData(syncOptions),
|
||||
props: {
|
||||
tweenManager: this._tweens.getNetworkSyncData(),
|
||||
},
|
||||
};
|
||||
}
|
||||
|
||||
updateFromNetworkSyncData(
|
||||
networkSyncData: TweenBehaviorNetworkSyncData,
|
||||
options: UpdateFromNetworkSyncDataOptions
|
||||
): void {
|
||||
super.updateFromNetworkSyncData(networkSyncData, options);
|
||||
|
||||
if (networkSyncData.props.tweenManager) {
|
||||
this._tweens.updateFromNetworkSyncData(
|
||||
networkSyncData.props.tweenManager,
|
||||
(tweenInformationNetworkSyncData) => {
|
||||
return this.owner;
|
||||
},
|
||||
(tweenInformationNetworkSyncData) => {
|
||||
return tweenSetterFactory(this.owner)(
|
||||
tweenInformationNetworkSyncData
|
||||
);
|
||||
},
|
||||
(tweenInformationNetworkSyncData) => {
|
||||
return tweenInformationNetworkSyncData.destroyObjectWhenFinished
|
||||
? () => this._deleteFromScene()
|
||||
: null;
|
||||
}
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
doStepPreEvents(instanceContainer: gdjs.RuntimeInstanceContainer): void {
|
||||
this._tweens.step();
|
||||
}
|
||||
@@ -126,7 +471,12 @@ namespace gdjs {
|
||||
linearInterpolation,
|
||||
fromValue,
|
||||
toValue,
|
||||
(value: float) => variable.setNumber(value),
|
||||
getTweenVariableSetter(variable),
|
||||
{
|
||||
type: 'variable',
|
||||
variable,
|
||||
destroyObjectWhenFinished,
|
||||
},
|
||||
destroyObjectWhenFinished ? () => this._deleteFromScene() : null
|
||||
);
|
||||
}
|
||||
@@ -208,7 +558,12 @@ namespace gdjs {
|
||||
linearInterpolation,
|
||||
variable.getValue() as number,
|
||||
toValue,
|
||||
(value: float) => variable.setNumber(value),
|
||||
getTweenVariableSetter(variable),
|
||||
{
|
||||
type: 'variable',
|
||||
variable,
|
||||
destroyObjectWhenFinished,
|
||||
},
|
||||
destroyObjectWhenFinished ? () => this._deleteFromScene() : null
|
||||
);
|
||||
}
|
||||
@@ -243,7 +598,11 @@ namespace gdjs {
|
||||
: linearInterpolation,
|
||||
fromValue,
|
||||
toValue,
|
||||
(value: float) => {},
|
||||
tweenObjectValueSetter,
|
||||
{
|
||||
type: 'objectValue',
|
||||
destroyObjectWhenFinished,
|
||||
},
|
||||
destroyObjectWhenFinished ? () => this._deleteFromScene() : null
|
||||
);
|
||||
}
|
||||
@@ -322,7 +681,11 @@ namespace gdjs {
|
||||
linearInterpolation,
|
||||
[this.owner.getX(), this.owner.getY()],
|
||||
[toX, toY],
|
||||
([x, y]) => this.owner.setPosition(x, y),
|
||||
getTweenObjectPositionSetter(this.owner),
|
||||
{
|
||||
type: 'position',
|
||||
destroyObjectWhenFinished,
|
||||
},
|
||||
destroyObjectWhenFinished ? () => this._deleteFromScene() : null
|
||||
);
|
||||
}
|
||||
@@ -394,7 +757,11 @@ namespace gdjs {
|
||||
linearInterpolation,
|
||||
this.owner.getX(),
|
||||
toX,
|
||||
(value: float) => this.owner.setX(value),
|
||||
getTweenObjectPositionXSetter(this.owner),
|
||||
{
|
||||
type: 'positionX',
|
||||
destroyObjectWhenFinished,
|
||||
},
|
||||
destroyObjectWhenFinished ? () => this._deleteFromScene() : null
|
||||
);
|
||||
}
|
||||
@@ -466,7 +833,11 @@ namespace gdjs {
|
||||
linearInterpolation,
|
||||
this.owner.getY(),
|
||||
toY,
|
||||
(value: float) => this.owner.setY(value),
|
||||
getTweenObjectPositionYSetter(this.owner),
|
||||
{
|
||||
type: 'positionY',
|
||||
destroyObjectWhenFinished,
|
||||
},
|
||||
destroyObjectWhenFinished ? () => this._deleteFromScene() : null
|
||||
);
|
||||
}
|
||||
@@ -543,7 +914,11 @@ namespace gdjs {
|
||||
linearInterpolation,
|
||||
owner.getZ(),
|
||||
toZ,
|
||||
(value: float) => owner.setZ(value),
|
||||
getTweenObjectPositionZSetter(owner),
|
||||
{
|
||||
type: 'positionZ',
|
||||
destroyObjectWhenFinished,
|
||||
},
|
||||
destroyObjectWhenFinished ? () => this._deleteFromScene() : null
|
||||
);
|
||||
}
|
||||
@@ -615,7 +990,11 @@ namespace gdjs {
|
||||
linearInterpolation,
|
||||
this.owner.getAngle(),
|
||||
toAngle,
|
||||
(value: float) => this.owner.setAngle(value),
|
||||
getTweenObjectAngleSetter(this.owner),
|
||||
{
|
||||
type: 'angle',
|
||||
destroyObjectWhenFinished,
|
||||
},
|
||||
destroyObjectWhenFinished ? () => this._deleteFromScene() : null
|
||||
);
|
||||
}
|
||||
@@ -648,7 +1027,11 @@ namespace gdjs {
|
||||
linearInterpolation,
|
||||
owner.getRotationX(),
|
||||
toAngle,
|
||||
(value: float) => owner.setRotationX(value),
|
||||
getTweenObjectRotationXSetter(owner),
|
||||
{
|
||||
type: 'rotationX',
|
||||
destroyObjectWhenFinished,
|
||||
},
|
||||
destroyObjectWhenFinished ? () => this._deleteFromScene() : null
|
||||
);
|
||||
}
|
||||
@@ -681,7 +1064,11 @@ namespace gdjs {
|
||||
linearInterpolation,
|
||||
owner.getRotationY(),
|
||||
toAngle,
|
||||
(value: float) => owner.setRotationY(value),
|
||||
getTweenObjectRotationYSetter(owner),
|
||||
{
|
||||
type: 'rotationY',
|
||||
destroyObjectWhenFinished,
|
||||
},
|
||||
destroyObjectWhenFinished ? () => this._deleteFromScene() : null
|
||||
);
|
||||
}
|
||||
@@ -769,19 +1156,6 @@ namespace gdjs {
|
||||
if (toScaleX < 0) toScaleX = 0;
|
||||
if (toScaleY < 0) toScaleY = 0;
|
||||
|
||||
const setValue = scaleFromCenterOfObject
|
||||
? ([scaleX, scaleY]: float[]) => {
|
||||
const oldX = owner.getCenterXInScene();
|
||||
const oldY = owner.getCenterYInScene();
|
||||
owner.setScaleX(scaleX);
|
||||
owner.setScaleY(scaleY);
|
||||
owner.setCenterPositionInScene(oldX, oldY);
|
||||
}
|
||||
: ([scaleX, scaleY]: float[]) => {
|
||||
owner.setScaleX(scaleX);
|
||||
owner.setScaleY(scaleY);
|
||||
};
|
||||
|
||||
this._tweens.addMultiTween(
|
||||
identifier,
|
||||
timeSource,
|
||||
@@ -790,7 +1164,11 @@ namespace gdjs {
|
||||
interpolation,
|
||||
[owner.getScaleX(), owner.getScaleY()],
|
||||
[toScaleX, toScaleY],
|
||||
setValue,
|
||||
getTweenObjectScaleXYSetter(owner, scaleFromCenterOfObject),
|
||||
{
|
||||
type: 'scaleXY',
|
||||
destroyObjectWhenFinished,
|
||||
},
|
||||
destroyObjectWhenFinished ? () => this._deleteFromScene() : null
|
||||
);
|
||||
}
|
||||
@@ -830,20 +1208,6 @@ namespace gdjs {
|
||||
// when the 3D extension is not used.
|
||||
const owner3d = is3D(owner) ? owner : null;
|
||||
|
||||
const setValue = scaleFromCenterOfObject
|
||||
? (scale: float) => {
|
||||
const oldX = owner.getCenterXInScene();
|
||||
const oldY = owner.getCenterYInScene();
|
||||
const oldZ = owner3d ? owner3d.getCenterZInScene() : 0;
|
||||
owner.setScale(scale);
|
||||
owner.setCenterXInScene(oldX);
|
||||
owner.setCenterYInScene(oldY);
|
||||
if (owner3d) {
|
||||
owner3d.setCenterZInScene(oldZ);
|
||||
}
|
||||
}
|
||||
: (scale: float) => owner.setScale(scale);
|
||||
|
||||
this._tweens.addSimpleTween(
|
||||
identifier,
|
||||
this.owner,
|
||||
@@ -852,7 +1216,12 @@ namespace gdjs {
|
||||
exponentialInterpolation,
|
||||
owner.getScale(),
|
||||
toScale,
|
||||
setValue,
|
||||
getTweenObjectScaleSetter(owner, owner3d, scaleFromCenterOfObject),
|
||||
{
|
||||
type: 'scale',
|
||||
scaleFromCenterOfObject,
|
||||
destroyObjectWhenFinished,
|
||||
},
|
||||
destroyObjectWhenFinished ? () => this._deleteFromScene() : null
|
||||
);
|
||||
}
|
||||
@@ -929,14 +1298,6 @@ namespace gdjs {
|
||||
const owner = this.owner;
|
||||
if (!isScalable(owner)) return;
|
||||
|
||||
const setValue = scaleFromCenterOfObject
|
||||
? (scaleX: float) => {
|
||||
const oldX = owner.getCenterXInScene();
|
||||
owner.setScaleX(scaleX);
|
||||
owner.setCenterXInScene(oldX);
|
||||
}
|
||||
: (scaleX: float) => owner.setScaleX(scaleX);
|
||||
|
||||
this._tweens.addSimpleTween(
|
||||
identifier,
|
||||
timeSource,
|
||||
@@ -945,7 +1306,12 @@ namespace gdjs {
|
||||
interpolation,
|
||||
owner.getScaleX(),
|
||||
toScaleX,
|
||||
setValue,
|
||||
getTweenObjectScaleXSetter(owner, scaleFromCenterOfObject),
|
||||
{
|
||||
type: 'scaleX',
|
||||
scaleFromCenterOfObject,
|
||||
destroyObjectWhenFinished,
|
||||
},
|
||||
destroyObjectWhenFinished ? () => this._deleteFromScene() : null
|
||||
);
|
||||
}
|
||||
@@ -1022,14 +1388,6 @@ namespace gdjs {
|
||||
const owner = this.owner;
|
||||
if (!isScalable(owner)) return;
|
||||
|
||||
const setValue = scaleFromCenterOfObject
|
||||
? (scaleY: float) => {
|
||||
const oldY = owner.getCenterYInScene();
|
||||
owner.setScaleY(scaleY);
|
||||
owner.setCenterYInScene(oldY);
|
||||
}
|
||||
: (scaleY: float) => owner.setScaleY(scaleY);
|
||||
|
||||
this._tweens.addSimpleTween(
|
||||
identifier,
|
||||
timeSource,
|
||||
@@ -1038,7 +1396,12 @@ namespace gdjs {
|
||||
interpolation,
|
||||
owner.getScaleY(),
|
||||
toScaleY,
|
||||
setValue,
|
||||
getTweenObjectScaleYSetter(owner, scaleFromCenterOfObject),
|
||||
{
|
||||
type: 'scaleY',
|
||||
scaleFromCenterOfObject,
|
||||
destroyObjectWhenFinished,
|
||||
},
|
||||
destroyObjectWhenFinished ? () => this._deleteFromScene() : null
|
||||
);
|
||||
}
|
||||
@@ -1113,7 +1476,11 @@ namespace gdjs {
|
||||
linearInterpolation,
|
||||
owner.getOpacity(),
|
||||
toOpacity,
|
||||
(value: float) => owner.setOpacity(value),
|
||||
getTweenObjectOpacitySetter(owner),
|
||||
{
|
||||
type: 'opacity',
|
||||
destroyObjectWhenFinished,
|
||||
},
|
||||
destroyObjectWhenFinished ? () => this._deleteFromScene() : null
|
||||
);
|
||||
}
|
||||
@@ -1153,10 +1520,12 @@ namespace gdjs {
|
||||
linearInterpolation,
|
||||
effect ? effect.getDoubleParameter(propertyName) : 0,
|
||||
toValue,
|
||||
(value: float) => {
|
||||
if (effect) {
|
||||
effect.updateDoubleParameter(propertyName, value);
|
||||
}
|
||||
getTweenObjectNumberEffectPropertySetter(effect, propertyName),
|
||||
{
|
||||
type: 'numberEffectProperty',
|
||||
effectName,
|
||||
propertyName,
|
||||
destroyObjectWhenFinished,
|
||||
},
|
||||
destroyObjectWhenFinished ? () => this._deleteFromScene() : null
|
||||
);
|
||||
@@ -1210,22 +1579,12 @@ namespace gdjs {
|
||||
rgbToColor[1],
|
||||
rgbToColor[2]
|
||||
),
|
||||
([hue, saturation, lightness]) => {
|
||||
if (effect) {
|
||||
const rgbFromHslColor = gdjs.evtTools.tween.hslToRgb(
|
||||
hue,
|
||||
saturation,
|
||||
lightness
|
||||
);
|
||||
effect.updateColorParameter(
|
||||
propertyName,
|
||||
gdjs.rgbToHexNumber(
|
||||
rgbFromHslColor[0],
|
||||
rgbFromHslColor[1],
|
||||
rgbFromHslColor[2]
|
||||
)
|
||||
);
|
||||
}
|
||||
getTweenObjectColorEffectPropertySetter(effect, propertyName),
|
||||
{
|
||||
type: 'colorEffectProperty',
|
||||
effectName,
|
||||
propertyName,
|
||||
destroyObjectWhenFinished,
|
||||
},
|
||||
destroyObjectWhenFinished ? () => this._deleteFromScene() : null
|
||||
);
|
||||
@@ -1305,43 +1664,20 @@ namespace gdjs {
|
||||
const rgbFromColor: float[] = gdjs.rgbOrHexToRGBColor(owner.getColor());
|
||||
const rgbToColor: float[] = gdjs.rgbOrHexToRGBColor(toColorStr);
|
||||
|
||||
let initialValue;
|
||||
let targetedValue;
|
||||
let setValue;
|
||||
if (useHSLColorTransition) {
|
||||
initialValue = gdjs.evtTools.tween.rgbToHsl(
|
||||
rgbFromColor[0],
|
||||
rgbFromColor[1],
|
||||
rgbFromColor[2]
|
||||
);
|
||||
targetedValue = gdjs.evtTools.tween.rgbToHsl(
|
||||
rgbToColor[0],
|
||||
rgbToColor[1],
|
||||
rgbToColor[2]
|
||||
);
|
||||
setValue = ([hue, saturation, lightness]) => {
|
||||
const rgbFromHslColor = gdjs.evtTools.tween.hslToRgb(
|
||||
hue,
|
||||
saturation,
|
||||
lightness
|
||||
);
|
||||
owner.setColor(
|
||||
Math.round(rgbFromHslColor[0]) +
|
||||
';' +
|
||||
Math.round(rgbFromHslColor[1]) +
|
||||
';' +
|
||||
Math.round(rgbFromHslColor[2])
|
||||
);
|
||||
};
|
||||
} else {
|
||||
initialValue = rgbFromColor;
|
||||
targetedValue = rgbToColor;
|
||||
setValue = ([red, green, blue]) => {
|
||||
owner.setColor(
|
||||
Math.floor(red) + ';' + Math.floor(green) + ';' + Math.floor(blue)
|
||||
);
|
||||
};
|
||||
}
|
||||
const initialValue = useHSLColorTransition
|
||||
? gdjs.evtTools.tween.rgbToHsl(
|
||||
rgbFromColor[0],
|
||||
rgbFromColor[1],
|
||||
rgbFromColor[2]
|
||||
)
|
||||
: rgbFromColor;
|
||||
const targetedValue = useHSLColorTransition
|
||||
? gdjs.evtTools.tween.rgbToHsl(
|
||||
rgbToColor[0],
|
||||
rgbToColor[1],
|
||||
rgbToColor[2]
|
||||
)
|
||||
: rgbToColor;
|
||||
|
||||
this._tweens.addMultiTween(
|
||||
identifier,
|
||||
@@ -1351,7 +1687,12 @@ namespace gdjs {
|
||||
linearInterpolation,
|
||||
initialValue,
|
||||
targetedValue,
|
||||
setValue,
|
||||
getTweenObjectColorSetter(owner, useHSLColorTransition),
|
||||
{
|
||||
type: 'objectColor',
|
||||
useHSLColorTransition,
|
||||
destroyObjectWhenFinished,
|
||||
},
|
||||
destroyObjectWhenFinished ? () => this._deleteFromScene() : null
|
||||
);
|
||||
}
|
||||
@@ -1462,25 +1803,13 @@ namespace gdjs {
|
||||
duration,
|
||||
easing,
|
||||
linearInterpolation,
|
||||
|
||||
hslFromColor,
|
||||
[toH, toS, toL],
|
||||
([hue, saturation, lightness]) => {
|
||||
const rgbFromHslColor = gdjs.evtTools.tween.hslToRgb(
|
||||
hue,
|
||||
saturation,
|
||||
lightness
|
||||
);
|
||||
|
||||
owner.setColor(
|
||||
Math.round(rgbFromHslColor[0]) +
|
||||
';' +
|
||||
Math.round(rgbFromHslColor[1]) +
|
||||
';' +
|
||||
Math.round(rgbFromHslColor[2])
|
||||
);
|
||||
getTweenObjectColorHSLSetter(owner),
|
||||
{
|
||||
type: 'objectColorHSL',
|
||||
destroyObjectWhenFinished,
|
||||
},
|
||||
|
||||
destroyObjectWhenFinished ? () => this._deleteFromScene() : null
|
||||
);
|
||||
}
|
||||
@@ -1558,7 +1887,11 @@ namespace gdjs {
|
||||
interpolation,
|
||||
owner.getCharacterSize(),
|
||||
toSize,
|
||||
(value: float) => owner.setCharacterSize(value),
|
||||
getTweenObjectCharacterSizeSetter(owner),
|
||||
{
|
||||
type: 'characterSize',
|
||||
destroyObjectWhenFinished,
|
||||
},
|
||||
destroyObjectWhenFinished ? () => this._deleteFromScene() : null
|
||||
);
|
||||
}
|
||||
@@ -1630,7 +1963,11 @@ namespace gdjs {
|
||||
linearInterpolation,
|
||||
this.owner.getWidth(),
|
||||
toWidth,
|
||||
(value: float) => this.owner.setWidth(value),
|
||||
getTweenObjectWidthSetter(this.owner),
|
||||
{
|
||||
type: 'width',
|
||||
destroyObjectWhenFinished,
|
||||
},
|
||||
destroyObjectWhenFinished ? () => this._deleteFromScene() : null
|
||||
);
|
||||
}
|
||||
@@ -1702,7 +2039,11 @@ namespace gdjs {
|
||||
linearInterpolation,
|
||||
this.owner.getHeight(),
|
||||
toHeight,
|
||||
(value: float) => this.owner.setHeight(value),
|
||||
getTweenObjectHeightSetter(this.owner),
|
||||
{
|
||||
type: 'height',
|
||||
destroyObjectWhenFinished,
|
||||
},
|
||||
destroyObjectWhenFinished ? () => this._deleteFromScene() : null
|
||||
);
|
||||
}
|
||||
@@ -1779,7 +2120,11 @@ namespace gdjs {
|
||||
linearInterpolation,
|
||||
owner.getDepth(),
|
||||
toDepth,
|
||||
(value: float) => owner.setDepth(value),
|
||||
getTweenObjectDepthSetter(owner),
|
||||
{
|
||||
type: 'depth',
|
||||
destroyObjectWhenFinished,
|
||||
},
|
||||
destroyObjectWhenFinished ? () => this._deleteFromScene() : null
|
||||
);
|
||||
}
|
||||
|
@@ -10,6 +10,127 @@ namespace gdjs {
|
||||
export namespace tween {
|
||||
const logger = new gdjs.Logger('Tween');
|
||||
|
||||
const getTweenVariableSetter = (variable: gdjs.Variable) => {
|
||||
return (value: float) => variable.setNumber(value);
|
||||
};
|
||||
const tweenLayoutValueSetter = (value: float) => {};
|
||||
const tweenLayerValueSetter = (value: float) => {};
|
||||
const getTweenLayerCameraPositionSetter = (layer: gdjs.RuntimeLayer) => {
|
||||
return ([x, y]: Array<float>) => {
|
||||
layer.setCameraX(x);
|
||||
layer.setCameraY(y);
|
||||
};
|
||||
};
|
||||
const getTweenLayerCameraRotationSetter = (layer: gdjs.RuntimeLayer) => {
|
||||
return (value: float) => layer.setCameraRotation(value);
|
||||
};
|
||||
const getTweenLayerCameraZoomSetter = (layer: gdjs.RuntimeLayer) => {
|
||||
return (value: float) => layer.setCameraZoom(value);
|
||||
};
|
||||
const getTweenNumberEffectPropertySetter = (
|
||||
effect: PixiFiltersTools.Filter,
|
||||
propertyName: string
|
||||
) => {
|
||||
return (value: float) => {
|
||||
if (effect) {
|
||||
effect.updateDoubleParameter(propertyName, value);
|
||||
}
|
||||
};
|
||||
};
|
||||
const getTweenColorEffectPropertySetter = (
|
||||
effect: PixiFiltersTools.Filter,
|
||||
propertyName: string
|
||||
) => {
|
||||
return ([hue, saturation, lightness]: Array<float>) => {
|
||||
if (effect) {
|
||||
const rgbFromHslColor = gdjs.evtTools.tween.hslToRgb(
|
||||
hue,
|
||||
saturation,
|
||||
lightness
|
||||
);
|
||||
effect.updateColorParameter(
|
||||
propertyName,
|
||||
gdjs.rgbToHexNumber(
|
||||
rgbFromHslColor[0],
|
||||
rgbFromHslColor[1],
|
||||
rgbFromHslColor[2]
|
||||
)
|
||||
);
|
||||
}
|
||||
};
|
||||
};
|
||||
|
||||
// Factory to get the tween setter based on type and options
|
||||
export const tweenSetterFactory =
|
||||
(runtimeScene: RuntimeScene) =>
|
||||
(tweenInformation: TweenInformationNetworkSyncData) => {
|
||||
const type = tweenInformation.type;
|
||||
const layerName = tweenInformation.layerName;
|
||||
const variablePath = tweenInformation.variablePath;
|
||||
const effectName = tweenInformation.effectName;
|
||||
const propertyName = tweenInformation.propertyName;
|
||||
|
||||
if (type === 'variable' && variablePath) {
|
||||
const variable = runtimeScene
|
||||
.getVariables()
|
||||
.getVariableFromPath(variablePath);
|
||||
if (!variable) {
|
||||
return () => {};
|
||||
}
|
||||
return getTweenVariableSetter(variable);
|
||||
}
|
||||
if (type === 'cameraZoom' && layerName !== undefined) {
|
||||
const layer = runtimeScene.getLayer(layerName);
|
||||
return getTweenLayerCameraZoomSetter(layer);
|
||||
}
|
||||
if (type === 'cameraRotation' && layerName !== undefined) {
|
||||
const layer = runtimeScene.getLayer(layerName);
|
||||
return getTweenLayerCameraRotationSetter(layer);
|
||||
}
|
||||
if (type === 'cameraPosition' && layerName !== undefined) {
|
||||
const layer = runtimeScene.getLayer(layerName);
|
||||
return getTweenLayerCameraPositionSetter(layer);
|
||||
}
|
||||
if (
|
||||
type === 'colorEffectProperty' &&
|
||||
layerName !== undefined &&
|
||||
effectName &&
|
||||
propertyName
|
||||
) {
|
||||
const layer = runtimeScene.getLayer(layerName);
|
||||
const effect = layer.getRendererEffects()[effectName];
|
||||
if (!effect) {
|
||||
logger.error(
|
||||
`The layer "${layerName}" doesn't have any effect called "${effectName}"`
|
||||
);
|
||||
}
|
||||
|
||||
return getTweenColorEffectPropertySetter(effect, propertyName);
|
||||
}
|
||||
if (
|
||||
type === 'numberEffectProperty' &&
|
||||
layerName !== undefined &&
|
||||
effectName &&
|
||||
propertyName
|
||||
) {
|
||||
const layer = runtimeScene.getLayer(layerName);
|
||||
const effect = layer.getRendererEffects()[effectName];
|
||||
if (!effect) {
|
||||
logger.error(
|
||||
`The layer "${layerName}" doesn't have any effect called "${effectName}"`
|
||||
);
|
||||
}
|
||||
return getTweenNumberEffectPropertySetter(effect, propertyName);
|
||||
}
|
||||
if (type === 'layoutValue') {
|
||||
return tweenLayoutValueSetter;
|
||||
}
|
||||
if (type === 'layerValue') {
|
||||
return tweenLayerValueSetter;
|
||||
}
|
||||
return () => {};
|
||||
};
|
||||
|
||||
export const getTweensMap = (runtimeScene: RuntimeScene) =>
|
||||
runtimeScene._tweens ||
|
||||
(runtimeScene._tweens = new gdjs.evtTools.tween.TweenManager());
|
||||
@@ -20,6 +141,44 @@ namespace gdjs {
|
||||
gdjs.evtTools.tween.getTweensMap(runtimeScene).step();
|
||||
});
|
||||
|
||||
gdjs.registerRuntimeSceneGetSyncDataCallback(
|
||||
function (runtimeScene, currentLayoutSyncData, syncOptions) {
|
||||
if (!syncOptions.syncTweens) return;
|
||||
const tweensNetworkSyncData = gdjs.evtTools.tween
|
||||
.getTweensMap(runtimeScene)
|
||||
.getNetworkSyncData();
|
||||
|
||||
currentLayoutSyncData.tween = tweensNetworkSyncData;
|
||||
}
|
||||
);
|
||||
|
||||
gdjs.registerRuntimeSceneUpdateFromSyncDataCallback(
|
||||
function (runtimeScene, receivedSyncData, syncOptions) {
|
||||
if (!receivedSyncData.tween) return;
|
||||
|
||||
gdjs.evtTools.tween
|
||||
.getTweensMap(runtimeScene)
|
||||
.updateFromNetworkSyncData(
|
||||
receivedSyncData.tween,
|
||||
(tweenInformationNetworkSyncData) => {
|
||||
if (tweenInformationNetworkSyncData.layerName !== undefined) {
|
||||
return runtimeScene.getLayer(
|
||||
tweenInformationNetworkSyncData.layerName
|
||||
);
|
||||
}
|
||||
return runtimeScene;
|
||||
},
|
||||
(tweenInformationNetworkSyncData) => {
|
||||
return gdjs.evtTools.tween.tweenSetterFactory(runtimeScene)(
|
||||
tweenInformationNetworkSyncData
|
||||
);
|
||||
},
|
||||
// No onFinish for scene tweens.
|
||||
() => null
|
||||
);
|
||||
}
|
||||
);
|
||||
|
||||
export const sceneTweenExists = (
|
||||
runtimeScene: RuntimeScene,
|
||||
id: string
|
||||
@@ -130,7 +289,10 @@ namespace gdjs {
|
||||
: linearInterpolation,
|
||||
fromValue,
|
||||
toValue,
|
||||
(value: float) => {}
|
||||
tweenLayoutValueSetter,
|
||||
{
|
||||
type: 'layoutValue',
|
||||
}
|
||||
);
|
||||
};
|
||||
|
||||
@@ -167,7 +329,11 @@ namespace gdjs {
|
||||
: linearInterpolation,
|
||||
fromValue,
|
||||
toValue,
|
||||
(value: float) => {}
|
||||
tweenLayerValueSetter,
|
||||
{
|
||||
type: 'layerValue',
|
||||
layerName,
|
||||
}
|
||||
);
|
||||
};
|
||||
|
||||
@@ -197,7 +363,11 @@ namespace gdjs {
|
||||
linearInterpolation,
|
||||
from,
|
||||
to,
|
||||
(value: float) => variable.setNumber(value)
|
||||
getTweenVariableSetter(variable),
|
||||
{
|
||||
type: 'variable',
|
||||
variable,
|
||||
}
|
||||
);
|
||||
};
|
||||
|
||||
@@ -250,7 +420,11 @@ namespace gdjs {
|
||||
linearInterpolation,
|
||||
variable.getValue() as number,
|
||||
toValue,
|
||||
(value: float) => variable.setNumber(value)
|
||||
getTweenVariableSetter(variable),
|
||||
{
|
||||
type: 'variable',
|
||||
variable,
|
||||
}
|
||||
);
|
||||
};
|
||||
|
||||
@@ -329,9 +503,10 @@ namespace gdjs {
|
||||
linearInterpolation,
|
||||
[layer.getCameraX(), layer.getCameraY()],
|
||||
[toX, toY],
|
||||
([x, y]) => {
|
||||
layer.setCameraX(x);
|
||||
layer.setCameraY(y);
|
||||
getTweenLayerCameraPositionSetter(layer),
|
||||
{
|
||||
type: 'cameraPosition',
|
||||
layerName,
|
||||
}
|
||||
);
|
||||
};
|
||||
@@ -408,7 +583,11 @@ namespace gdjs {
|
||||
interpolation,
|
||||
layer.getCameraZoom(),
|
||||
toZoom,
|
||||
(value: float) => layer.setCameraZoom(value)
|
||||
getTweenLayerCameraZoomSetter(layer),
|
||||
{
|
||||
type: 'cameraZoom',
|
||||
layerName,
|
||||
}
|
||||
);
|
||||
};
|
||||
|
||||
@@ -478,7 +657,11 @@ namespace gdjs {
|
||||
linearInterpolation,
|
||||
layer.getCameraRotation(),
|
||||
toRotation,
|
||||
(value: float) => layer.setCameraRotation(value)
|
||||
getTweenLayerCameraRotationSetter(layer),
|
||||
{
|
||||
type: 'cameraRotation',
|
||||
layerName,
|
||||
}
|
||||
);
|
||||
};
|
||||
|
||||
@@ -518,10 +701,12 @@ namespace gdjs {
|
||||
linearInterpolation,
|
||||
effect ? effect.getDoubleParameter(propertyName) : 0,
|
||||
toValue,
|
||||
(value: float) => {
|
||||
if (effect) {
|
||||
effect.updateDoubleParameter(propertyName, value);
|
||||
}
|
||||
getTweenNumberEffectPropertySetter(effect, propertyName),
|
||||
{
|
||||
type: 'numberEffectProperty',
|
||||
layerName,
|
||||
effectName,
|
||||
propertyName,
|
||||
}
|
||||
);
|
||||
};
|
||||
@@ -575,22 +760,12 @@ namespace gdjs {
|
||||
rgbToColor[1],
|
||||
rgbToColor[2]
|
||||
),
|
||||
([hue, saturation, lightness]) => {
|
||||
if (effect) {
|
||||
const rgbFromHslColor = gdjs.evtTools.tween.hslToRgb(
|
||||
hue,
|
||||
saturation,
|
||||
lightness
|
||||
);
|
||||
effect.updateColorParameter(
|
||||
propertyName,
|
||||
gdjs.rgbToHexNumber(
|
||||
rgbFromHslColor[0],
|
||||
rgbFromHslColor[1],
|
||||
rgbFromHslColor[2]
|
||||
)
|
||||
);
|
||||
}
|
||||
getTweenColorEffectPropertySetter(effect, propertyName),
|
||||
{
|
||||
type: 'colorEffectProperty',
|
||||
layerName,
|
||||
effectName,
|
||||
propertyName,
|
||||
}
|
||||
);
|
||||
};
|
||||
|
@@ -16,7 +16,7 @@ namespace gdjs {
|
||||
|
||||
export type VideoObjectData = ObjectData & VideoObjectDataType;
|
||||
|
||||
export type VideoNetworkSyncDataType = {
|
||||
export type VideoObjectNetworkSyncDataType = {
|
||||
op: float;
|
||||
// We don't sync volume, as it's probably a user setting?
|
||||
pla: boolean;
|
||||
@@ -25,8 +25,8 @@ namespace gdjs {
|
||||
ps: number;
|
||||
};
|
||||
|
||||
export type VideoNetworkSyncData = ObjectNetworkSyncData &
|
||||
VideoNetworkSyncDataType;
|
||||
export type VideoObjectNetworkSyncData = ObjectNetworkSyncData &
|
||||
VideoObjectNetworkSyncDataType;
|
||||
|
||||
/**
|
||||
* An object displaying a video on screen.
|
||||
@@ -99,9 +99,11 @@ namespace gdjs {
|
||||
return true;
|
||||
}
|
||||
|
||||
getNetworkSyncData(): VideoNetworkSyncData {
|
||||
getNetworkSyncData(
|
||||
syncOptions: GetNetworkSyncDataOptions
|
||||
): VideoObjectNetworkSyncData {
|
||||
return {
|
||||
...super.getNetworkSyncData(),
|
||||
...super.getNetworkSyncData(syncOptions),
|
||||
op: this._opacity,
|
||||
pla: this.isPlayed(),
|
||||
loop: this.isLooped(),
|
||||
@@ -110,8 +112,11 @@ namespace gdjs {
|
||||
};
|
||||
}
|
||||
|
||||
updateFromNetworkSyncData(syncData: VideoNetworkSyncData): void {
|
||||
super.updateFromNetworkSyncData(syncData);
|
||||
updateFromNetworkSyncData(
|
||||
syncData: VideoObjectNetworkSyncData,
|
||||
options: UpdateFromNetworkSyncDataOptions
|
||||
): void {
|
||||
super.updateFromNetworkSyncData(syncData, options);
|
||||
|
||||
if (this._opacity !== undefined && this._opacity && syncData.op) {
|
||||
this.setOpacity(syncData.op);
|
||||
|
@@ -214,16 +214,16 @@ CODE_NAMESPACE.RUNTIME_BEHAVIOR_CLASSNAME = class RUNTIME_BEHAVIOR_CLASSNAME ext
|
||||
}
|
||||
|
||||
// Network sync:
|
||||
getNetworkSyncData() {
|
||||
getNetworkSyncData(syncOptions) {
|
||||
return {
|
||||
...super.getNetworkSyncData(),
|
||||
...super.getNetworkSyncData(syncOptions),
|
||||
props: {
|
||||
GET_NETWORK_SYNC_DATA_CODE
|
||||
}
|
||||
};
|
||||
}
|
||||
updateFromNetworkSyncData(networkSyncData) {
|
||||
super.updateFromNetworkSyncData(networkSyncData);
|
||||
updateFromNetworkSyncData(networkSyncData, options) {
|
||||
super.updateFromNetworkSyncData(networkSyncData, options);
|
||||
UPDATE_FROM_NETWORK_SYNC_DATA_CODE
|
||||
}
|
||||
|
||||
|
@@ -74,10 +74,15 @@ gd::String EventsCodeGenerator::GenerateEventsListCompleteFunctionCode(
|
||||
codeGenerator.GetCodeNamespace() + ".localVariables = [];\n";
|
||||
}
|
||||
|
||||
gd::String idToCallbackMapCode;
|
||||
idToCallbackMapCode +=
|
||||
codeGenerator.GetCodeNamespace() + ".idToCallbackMap = new Map();\n";
|
||||
|
||||
gd::String output =
|
||||
// clang-format off
|
||||
codeGenerator.GetCodeNamespace() + " = {};\n" +
|
||||
localVariablesInitializationCode +
|
||||
idToCallbackMapCode +
|
||||
globalDeclarations +
|
||||
globalObjectLists + "\n\n" +
|
||||
codeGenerator.GetCustomCodeOutsideMain() + "\n\n" +
|
||||
@@ -135,8 +140,11 @@ gd::String EventsCodeGenerator::GenerateEventsFunctionCode(
|
||||
gd::VariablesContainer::SourceType::Parameters);
|
||||
auto projectScopedContainers = gd::ProjectScopedContainers::
|
||||
MakeNewProjectScopedContainersForFreeEventsFunction(
|
||||
project, eventsFunctionsExtension, eventsFunction,
|
||||
parameterObjectsAndGroups, parameterVariablesContainer);
|
||||
project,
|
||||
eventsFunctionsExtension,
|
||||
eventsFunction,
|
||||
parameterObjectsAndGroups,
|
||||
parameterVariablesContainer);
|
||||
|
||||
EventsCodeGenerator codeGenerator(projectScopedContainers);
|
||||
codeGenerator.SetCodeNamespace(codeNamespace);
|
||||
@@ -145,16 +153,24 @@ gd::String EventsCodeGenerator::GenerateEventsFunctionCode(
|
||||
gd::DiagnosticReport diagnosticReport;
|
||||
codeGenerator.SetDiagnosticReport(&diagnosticReport);
|
||||
|
||||
// Generate the code setting up the context of the function.
|
||||
gd::String fullPreludeCode = "let scopeInstanceContainer = null;\n" +
|
||||
codeGenerator.GenerateFreeEventsFunctionContext(
|
||||
eventsFunctionsExtension,
|
||||
eventsFunction,
|
||||
"runtimeScene.getOnceTriggers()");
|
||||
|
||||
gd::String output = GenerateEventsListCompleteFunctionCode(
|
||||
codeGenerator, codeGenerator.GetCodeNamespaceAccessor() + "func",
|
||||
codeGenerator,
|
||||
codeGenerator.GetCodeNamespaceAccessor() + "func",
|
||||
codeGenerator.GenerateEventsFunctionParameterDeclarationsList(
|
||||
eventsFunction.GetParametersForEvents(
|
||||
eventsFunctionsExtension.GetEventsFunctions()),
|
||||
0, true),
|
||||
codeGenerator.GenerateFreeEventsFunctionContext(
|
||||
eventsFunctionsExtension, eventsFunction,
|
||||
"runtimeScene.getOnceTriggers()"),
|
||||
eventsFunction.GetEvents(), "",
|
||||
0,
|
||||
true),
|
||||
fullPreludeCode,
|
||||
eventsFunction.GetEvents(),
|
||||
"",
|
||||
codeGenerator.GenerateEventsFunctionReturn(eventsFunction));
|
||||
|
||||
// TODO: the editor should pass the diagnostic report and display it to the
|
||||
@@ -190,9 +206,13 @@ gd::String EventsCodeGenerator::GenerateBehaviorEventsFunctionCode(
|
||||
gd::VariablesContainer::SourceType::Properties);
|
||||
auto projectScopedContainers = gd::ProjectScopedContainers::
|
||||
MakeNewProjectScopedContainersForBehaviorEventsFunction(
|
||||
project, eventsFunctionsExtension, eventsBasedBehavior,
|
||||
eventsFunction, parameterObjectsContainers,
|
||||
parameterVariablesContainer, propertyVariablesContainer);
|
||||
project,
|
||||
eventsFunctionsExtension,
|
||||
eventsBasedBehavior,
|
||||
eventsFunction,
|
||||
parameterObjectsContainers,
|
||||
parameterVariablesContainer,
|
||||
propertyVariablesContainer);
|
||||
|
||||
EventsCodeGenerator codeGenerator(projectScopedContainers);
|
||||
codeGenerator.SetCodeNamespace(codeNamespace);
|
||||
@@ -206,9 +226,11 @@ gd::String EventsCodeGenerator::GenerateBehaviorEventsFunctionCode(
|
||||
preludeCode + "\n" + "var that = this;\n" +
|
||||
// runtimeScene is supposed to be always accessible, read
|
||||
// it from the behavior.
|
||||
// TODO: this should be renamed to "instanceContainer" and have the code generation
|
||||
// adapted for this (rely less on `gdjs.RuntimeScene`, and more on `RuntimeInstanceContainer`).
|
||||
// TODO: this should be renamed to "instanceContainer" and have the code
|
||||
// generation adapted for this (rely less on `gdjs.RuntimeScene`, and more
|
||||
// on `RuntimeInstanceContainer`).
|
||||
"var runtimeScene = this._runtimeScene;\n" +
|
||||
"let scopeInstanceContainer = null;\n" +
|
||||
// By convention of Behavior Events Function, the object is accessible
|
||||
// as a parameter called "Object", and thisObjectList is an array
|
||||
// containing it (for faster access, without having to go through the
|
||||
@@ -275,8 +297,12 @@ gd::String EventsCodeGenerator::GenerateObjectEventsFunctionCode(
|
||||
gd::VariablesContainer::SourceType::Properties);
|
||||
auto projectScopedContainers = gd::ProjectScopedContainers::
|
||||
MakeNewProjectScopedContainersForObjectEventsFunction(
|
||||
project, eventsFunctionsExtension, eventsBasedObject, eventsFunction,
|
||||
parameterObjectsContainers, parameterVariablesContainer,
|
||||
project,
|
||||
eventsFunctionsExtension,
|
||||
eventsBasedObject,
|
||||
eventsFunction,
|
||||
parameterObjectsContainers,
|
||||
parameterVariablesContainer,
|
||||
propertyVariablesContainer);
|
||||
|
||||
EventsCodeGenerator codeGenerator(projectScopedContainers);
|
||||
@@ -291,9 +317,11 @@ gd::String EventsCodeGenerator::GenerateObjectEventsFunctionCode(
|
||||
preludeCode + "\n" + "var that = this;\n" +
|
||||
// runtimeScene is supposed to be always accessible, read
|
||||
// it from the object.
|
||||
// TODO: this should be renamed to "instanceContainer" and have the code generation
|
||||
// adapted for this (rely less on `gdjs.RuntimeScene`, and more on `RuntimeInstanceContainer`).
|
||||
// TODO: this should be renamed to "instanceContainer" and have the code
|
||||
// generation adapted for this (rely less on `gdjs.RuntimeScene`, and more
|
||||
// on `RuntimeInstanceContainer`).
|
||||
"var runtimeScene = this._instanceContainer;\n" +
|
||||
"let scopeInstanceContainer = this._instanceContainer;\n" +
|
||||
// By convention of Object Events Function, the object is accessible
|
||||
// as a parameter called "Object", and thisObjectList is an array
|
||||
// containing it (for faster access, without having to go through the
|
||||
@@ -383,13 +411,14 @@ gd::String EventsCodeGenerator::GenerateFreeEventsFunctionContext(
|
||||
gd::String objectsGettersMap;
|
||||
gd::String objectArraysMap;
|
||||
gd::String behaviorNamesMap;
|
||||
return GenerateEventsFunctionContext(eventsFunctionsExtension,
|
||||
eventsFunctionsExtension.GetEventsFunctions(),
|
||||
eventsFunction,
|
||||
onceTriggersVariable,
|
||||
objectsGettersMap,
|
||||
objectArraysMap,
|
||||
behaviorNamesMap);
|
||||
return GenerateEventsFunctionContext(
|
||||
eventsFunctionsExtension,
|
||||
eventsFunctionsExtension.GetEventsFunctions(),
|
||||
eventsFunction,
|
||||
onceTriggersVariable,
|
||||
objectsGettersMap,
|
||||
objectArraysMap,
|
||||
behaviorNamesMap);
|
||||
}
|
||||
|
||||
gd::String EventsCodeGenerator::GenerateBehaviorEventsFunctionContext(
|
||||
@@ -624,7 +653,11 @@ gd::String EventsCodeGenerator::GenerateEventsFunctionContext(
|
||||
// the cost of creating/storing it for each events function might not
|
||||
// be worth it.
|
||||
" if (objectsList) {\n" +
|
||||
" const object = parentEventsFunctionContext ?\n" +
|
||||
" const object = parentEventsFunctionContext && "
|
||||
// Check if `objectName` is not a child object and is passed by
|
||||
// parameter from a parent instance container.
|
||||
"!(scopeInstanceContainer && "
|
||||
"scopeInstanceContainer.isObjectRegistered(objectName)) ?\n" +
|
||||
" "
|
||||
"parentEventsFunctionContext.createObject(objectsList.firstKey()) "
|
||||
":\n" +
|
||||
@@ -634,7 +667,7 @@ gd::String EventsCodeGenerator::GenerateEventsFunctionContext(
|
||||
" objectsList.get(objectsList.firstKey()).push(object);\n" +
|
||||
" "
|
||||
"eventsFunctionContext._objectArraysMap[objectName].push(object);\n" +
|
||||
" }\n" + " return object;" + " }\n" +
|
||||
" }\n" + " return object;\n" + " }\n" +
|
||||
// Unknown object, don't create anything:
|
||||
" return null;\n" +
|
||||
" },\n"
|
||||
@@ -646,7 +679,11 @@ gd::String EventsCodeGenerator::GenerateEventsFunctionContext(
|
||||
"eventsFunctionContext._objectsMap[objectName];\n" +
|
||||
" let count = 0;\n" + " if (objectsList) {\n" +
|
||||
" for(const objectName in objectsList.items)\n" +
|
||||
" count += parentEventsFunctionContext ?\n" +
|
||||
" count += parentEventsFunctionContext && "
|
||||
// Check if `objectName` is not a child object and is passed by
|
||||
// parameter from a parent instance container.
|
||||
"!(scopeInstanceContainer && "
|
||||
"scopeInstanceContainer.isObjectRegistered(objectName)) ?\n" +
|
||||
"parentEventsFunctionContext.getInstancesCountOnScene(objectName) "
|
||||
":\n" +
|
||||
" runtimeScene.getInstancesCountOnScene(objectName);\n" +
|
||||
@@ -916,7 +953,8 @@ gd::String EventsCodeGenerator::GenerateObjectAction(
|
||||
const std::vector<gd::String>& arguments,
|
||||
const gd::InstructionMetadata& instrInfos,
|
||||
gd::EventsCodeGenerationContext& context,
|
||||
const gd::String& optionalAsyncCallbackName) {
|
||||
const gd::String& optionalAsyncCallbackName,
|
||||
const gd::String& optionalAsyncCallbackId) {
|
||||
gd::String actionCode;
|
||||
|
||||
// Prepare call
|
||||
@@ -965,10 +1003,11 @@ gd::String EventsCodeGenerator::GenerateObjectAction(
|
||||
actionCode += " " + call + ";\n";
|
||||
actionCode += "}\n";
|
||||
|
||||
if (!optionalAsyncCallbackName.empty()) {
|
||||
if (!optionalAsyncCallbackName.empty() && !optionalAsyncCallbackId.empty()) {
|
||||
actionCode +=
|
||||
"runtimeScene.getAsyncTasksManager().addTask(asyncTaskGroup, " +
|
||||
optionalAsyncCallbackName + ")\n}";
|
||||
optionalAsyncCallbackName + ", " + optionalAsyncCallbackId +
|
||||
", asyncObjectsList)\n}";
|
||||
}
|
||||
|
||||
return actionCode;
|
||||
@@ -982,7 +1021,8 @@ gd::String EventsCodeGenerator::GenerateBehaviorAction(
|
||||
const std::vector<gd::String>& arguments,
|
||||
const gd::InstructionMetadata& instrInfos,
|
||||
gd::EventsCodeGenerationContext& context,
|
||||
const gd::String& optionalAsyncCallbackName) {
|
||||
const gd::String& optionalAsyncCallbackName,
|
||||
const gd::String& optionalAsyncCallbackId) {
|
||||
gd::String actionCode;
|
||||
|
||||
// Prepare call
|
||||
@@ -1042,10 +1082,12 @@ gd::String EventsCodeGenerator::GenerateBehaviorAction(
|
||||
actionCode += " " + call + ";\n";
|
||||
actionCode += "}\n";
|
||||
|
||||
if (!optionalAsyncCallbackName.empty()) {
|
||||
if (!optionalAsyncCallbackName.empty() &&
|
||||
!optionalAsyncCallbackId.empty()) {
|
||||
actionCode +=
|
||||
"runtimeScene.getAsyncTasksManager().addTask(asyncTaskGroup, " +
|
||||
optionalAsyncCallbackName + ");\n };";
|
||||
optionalAsyncCallbackName + ", " + optionalAsyncCallbackId +
|
||||
", asyncObjectsList);\n };";
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1364,17 +1406,16 @@ gd::String EventsCodeGenerator::GenerateGetVariable(
|
||||
scope == VARIABLE_OR_PROPERTY_OR_PARAMETER) {
|
||||
const auto variablesContainersList =
|
||||
GetProjectScopedContainers().GetVariablesContainersList();
|
||||
const auto &variablesContainer =
|
||||
const auto& variablesContainer =
|
||||
scope == VARIABLE_OR_PROPERTY_OR_PARAMETER
|
||||
? variablesContainersList.GetVariablesContainerFromVariableOrPropertyOrParameterName(
|
||||
variableName)
|
||||
? variablesContainersList
|
||||
.GetVariablesContainerFromVariableOrPropertyOrParameterName(
|
||||
variableName)
|
||||
: scope == VARIABLE_OR_PROPERTY
|
||||
? variablesContainersList
|
||||
.GetVariablesContainerFromVariableOrPropertyName(
|
||||
variableName)
|
||||
: variablesContainersList
|
||||
.GetVariablesContainerFromVariableNameOnly(
|
||||
variableName);
|
||||
.GetVariablesContainerFromVariableOrPropertyName(variableName)
|
||||
: variablesContainersList.GetVariablesContainerFromVariableNameOnly(
|
||||
variableName);
|
||||
const auto sourceType = variablesContainer.GetSourceType();
|
||||
if (sourceType == gd::VariablesContainer::SourceType::Scene) {
|
||||
variables = &variablesContainer;
|
||||
@@ -1397,48 +1438,50 @@ gd::String EventsCodeGenerator::GenerateGetVariable(
|
||||
gd::VariablesContainer::SourceType::ExtensionScene) {
|
||||
variables = &variablesContainer;
|
||||
output = "eventsFunctionContext.sceneVariablesForExtension";
|
||||
} else if (sourceType ==
|
||||
gd::VariablesContainer::SourceType::Properties) {
|
||||
} else if (sourceType == gd::VariablesContainer::SourceType::Properties) {
|
||||
if (hasChild) {
|
||||
// Properties with children are not supported.
|
||||
return "gdjs.VariablesContainer.badVariablesContainer";
|
||||
}
|
||||
const auto &propertiesContainersList =
|
||||
const auto& propertiesContainersList =
|
||||
GetProjectScopedContainers().GetPropertiesContainersList();
|
||||
const auto &propertiesContainerAndProperty =
|
||||
const auto& propertiesContainerAndProperty =
|
||||
propertiesContainersList.Get(variableName);
|
||||
return GeneratePropertyGetterWithoutCasting(
|
||||
propertiesContainerAndProperty.first,
|
||||
propertiesContainerAndProperty.second);
|
||||
} else if (sourceType ==
|
||||
gd::VariablesContainer::SourceType::Parameters) {
|
||||
} else if (sourceType == gd::VariablesContainer::SourceType::Parameters) {
|
||||
if (hasChild) {
|
||||
// Parameters with children are not supported.
|
||||
return "gdjs.VariablesContainer.badVariablesContainer";
|
||||
}
|
||||
const auto ¶metersVectorsList =
|
||||
const auto& parametersVectorsList =
|
||||
GetProjectScopedContainers().GetParametersVectorsList();
|
||||
const auto ¶meter =
|
||||
const auto& parameter =
|
||||
gd::ParameterMetadataTools::Get(parametersVectorsList, variableName);
|
||||
return GenerateParameterGetterWithoutCasting(parameter);
|
||||
}
|
||||
} else if (scope == LAYOUT_VARIABLE) {
|
||||
output = "runtimeScene.getScene().getVariables()";
|
||||
|
||||
const auto *legacySceneVariables = GetProjectScopedContainers().GetLegacySceneVariables();
|
||||
const auto* legacySceneVariables =
|
||||
GetProjectScopedContainers().GetLegacySceneVariables();
|
||||
if (HasProjectAndLayout()) {
|
||||
variables = &GetLayout().GetVariables();
|
||||
} else if (legacySceneVariables && legacySceneVariables->Has(variableName)) {
|
||||
} else if (legacySceneVariables &&
|
||||
legacySceneVariables->Has(variableName)) {
|
||||
variables = legacySceneVariables;
|
||||
output = "eventsFunctionContext.sceneVariablesForExtension";
|
||||
}
|
||||
} else if (scope == PROJECT_VARIABLE) {
|
||||
output = "runtimeScene.getGame().getVariables()";
|
||||
|
||||
const auto *legacyGlobalVariables = GetProjectScopedContainers().GetLegacyGlobalVariables();
|
||||
const auto* legacyGlobalVariables =
|
||||
GetProjectScopedContainers().GetLegacyGlobalVariables();
|
||||
if (HasProjectAndLayout()) {
|
||||
variables = &GetProject().GetVariables();
|
||||
} else if (legacyGlobalVariables && legacyGlobalVariables->Has(variableName)) {
|
||||
} else if (legacyGlobalVariables &&
|
||||
legacyGlobalVariables->Has(variableName)) {
|
||||
variables = legacyGlobalVariables;
|
||||
output = "eventsFunctionContext.globalVariablesForExtension";
|
||||
}
|
||||
@@ -1530,9 +1573,9 @@ gd::String EventsCodeGenerator::GenerateProfilerSectionEnd(
|
||||
}
|
||||
|
||||
gd::String EventsCodeGenerator::GeneratePropertySetterWithoutCasting(
|
||||
const gd::PropertiesContainer &propertiesContainer,
|
||||
const gd::NamedPropertyDescriptor &property,
|
||||
const gd::String &operandCode) {
|
||||
const gd::PropertiesContainer& propertiesContainer,
|
||||
const gd::NamedPropertyDescriptor& property,
|
||||
const gd::String& operandCode) {
|
||||
bool isLocalProperty =
|
||||
projectScopedContainers.GetPropertiesContainersList()
|
||||
.GetBottomMostPropertiesContainer() == &propertiesContainer;
|
||||
@@ -1558,8 +1601,8 @@ gd::String EventsCodeGenerator::GeneratePropertySetterWithoutCasting(
|
||||
}
|
||||
|
||||
gd::String EventsCodeGenerator::GeneratePropertyGetterWithoutCasting(
|
||||
const gd::PropertiesContainer &propertiesContainer,
|
||||
const gd::NamedPropertyDescriptor &property) {
|
||||
const gd::PropertiesContainer& propertiesContainer,
|
||||
const gd::NamedPropertyDescriptor& property) {
|
||||
bool isLocalProperty =
|
||||
projectScopedContainers.GetPropertiesContainersList()
|
||||
.GetBottomMostPropertiesContainer() == &propertiesContainer;
|
||||
@@ -1626,7 +1669,7 @@ gd::String EventsCodeGenerator::GeneratePropertyGetter(
|
||||
}
|
||||
|
||||
gd::String EventsCodeGenerator::GenerateParameterGetterWithoutCasting(
|
||||
const gd::ParameterMetadata ¶meter) {
|
||||
const gd::ParameterMetadata& parameter) {
|
||||
return "eventsFunctionContext.getArgument(" +
|
||||
ConvertToStringExplicit(parameter.GetName()) + ")";
|
||||
}
|
||||
|
@@ -59,7 +59,8 @@ class EventsCodeGenerator : public gd::EventsCodeGenerator {
|
||||
* Generate JavaScript for executing events of an events based function.
|
||||
*
|
||||
* \param project Project used.
|
||||
* \param eventsFunctionsExtension The container of the compiled event function.
|
||||
* \param eventsFunctionsExtension The container of the compiled event
|
||||
* function.
|
||||
* \param eventsFunction The events function to be compiled.
|
||||
* \param codeNamespace Where to store the context used by the function.
|
||||
* \param includeFiles Will be filled with the necessary include files.
|
||||
@@ -96,7 +97,7 @@ class EventsCodeGenerator : public gd::EventsCodeGenerator {
|
||||
*/
|
||||
static gd::String GenerateBehaviorEventsFunctionCode(
|
||||
gd::Project& project,
|
||||
const gd::EventsFunctionsExtension& eventsFunctionsExtension,
|
||||
const gd::EventsFunctionsExtension& eventsFunctionsExtension,
|
||||
const gd::EventsBasedBehavior& eventsBasedBehavior,
|
||||
const gd::EventsFunction& eventsFunction,
|
||||
const gd::String& codeNamespace,
|
||||
@@ -111,7 +112,8 @@ class EventsCodeGenerator : public gd::EventsCodeGenerator {
|
||||
* function.
|
||||
*
|
||||
* \param project Project used.
|
||||
* \param eventsBasedObject The object that contains the function to be compiled.
|
||||
* \param eventsBasedObject The object that contains the function to be
|
||||
* compiled.
|
||||
* \param eventsFunction The events function to be compiled.
|
||||
* \param codeNamespace Where to store the context used by the function.
|
||||
* \param fullyQualifiedFunctionName The function name with its namespace.
|
||||
@@ -129,7 +131,7 @@ class EventsCodeGenerator : public gd::EventsCodeGenerator {
|
||||
*/
|
||||
static gd::String GenerateObjectEventsFunctionCode(
|
||||
gd::Project& project,
|
||||
const gd::EventsFunctionsExtension& eventsFunctionsExtension,
|
||||
const gd::EventsFunctionsExtension& eventsFunctionsExtension,
|
||||
const gd::EventsBasedObject& eventsBasedObject,
|
||||
const gd::EventsFunction& eventsFunction,
|
||||
const gd::String& codeNamespace,
|
||||
@@ -152,7 +154,8 @@ class EventsCodeGenerator : public gd::EventsCodeGenerator {
|
||||
* \return Code
|
||||
*/
|
||||
virtual gd::String GenerateEventsListCode(
|
||||
gd::EventsList& events, gd::EventsCodeGenerationContext& context) override;
|
||||
gd::EventsList& events,
|
||||
gd::EventsCodeGenerationContext& context) override;
|
||||
|
||||
/**
|
||||
* Generate code for executing a condition list
|
||||
@@ -194,7 +197,8 @@ class EventsCodeGenerator : public gd::EventsCodeGenerator {
|
||||
* \brief Get the full name for accessing to a list of objects
|
||||
*/
|
||||
virtual gd::String GetObjectListName(
|
||||
const gd::String& name, const gd::EventsCodeGenerationContext& context) override;
|
||||
const gd::String& name,
|
||||
const gd::EventsCodeGenerationContext& context) override;
|
||||
|
||||
/**
|
||||
* \brief Get the namespace to be used to store code generated
|
||||
@@ -226,9 +230,9 @@ class EventsCodeGenerator : public gd::EventsCodeGenerator {
|
||||
};
|
||||
|
||||
virtual gd::String GeneratePropertySetterWithoutCasting(
|
||||
const gd::PropertiesContainer &propertiesContainer,
|
||||
const gd::NamedPropertyDescriptor &property,
|
||||
const gd::String &operandCode) override;
|
||||
const gd::PropertiesContainer& propertiesContainer,
|
||||
const gd::NamedPropertyDescriptor& property,
|
||||
const gd::String& operandCode) override;
|
||||
|
||||
protected:
|
||||
virtual gd::String GenerateParameterCodes(
|
||||
@@ -289,7 +293,8 @@ class EventsCodeGenerator : public gd::EventsCodeGenerator {
|
||||
const std::vector<gd::String>& arguments,
|
||||
const gd::InstructionMetadata& instrInfos,
|
||||
gd::EventsCodeGenerationContext& context,
|
||||
const gd::String& optionalAsyncCallbackName = "") override;
|
||||
const gd::String& optionalAsyncCallbackName = "",
|
||||
const gd::String& optionalAsyncCallbackId = "") override;
|
||||
|
||||
virtual gd::String GenerateBehaviorAction(
|
||||
const gd::String& objectName,
|
||||
@@ -299,7 +304,8 @@ class EventsCodeGenerator : public gd::EventsCodeGenerator {
|
||||
const std::vector<gd::String>& arguments,
|
||||
const gd::InstructionMetadata& instrInfos,
|
||||
gd::EventsCodeGenerationContext& context,
|
||||
const gd::String& optionalAsyncCallbackName = "") override;
|
||||
const gd::String& optionalAsyncCallbackName = "",
|
||||
const gd::String& optionalAsyncCallbackId = "") override;
|
||||
|
||||
virtual gd::String GenerateGetBehaviorNameCode(
|
||||
const gd::String& behaviorName) override;
|
||||
@@ -320,9 +326,9 @@ class EventsCodeGenerator : public gd::EventsCodeGenerator {
|
||||
gd::String expressionCode) override {
|
||||
// This uses `getChild` which allows to access a child
|
||||
// with a number (an index, for an array) or a string (for a structure).
|
||||
// This could be optimised, if the type of the accessed variable AND the type of the index is known,
|
||||
// so that `getChildAt` (for an array, with an index) or `getChildNamed` (for a structure, with a name)
|
||||
// is used instead.
|
||||
// This could be optimised, if the type of the accessed variable AND the
|
||||
// type of the index is known, so that `getChildAt` (for an array, with an
|
||||
// index) or `getChildNamed` (for a structure, with a name) is used instead.
|
||||
return ".getChild(" + expressionCode + ")";
|
||||
};
|
||||
|
||||
@@ -330,29 +336,33 @@ class EventsCodeGenerator : public gd::EventsCodeGenerator {
|
||||
return "gdjs.VariablesContainer.badVariable";
|
||||
}
|
||||
|
||||
virtual gd::String GeneratePropertyGetter(const gd::PropertiesContainer& propertiesContainer,
|
||||
const gd::NamedPropertyDescriptor& property,
|
||||
const gd::String& type,
|
||||
gd::EventsCodeGenerationContext& context) override;
|
||||
virtual gd::String GeneratePropertyGetter(
|
||||
const gd::PropertiesContainer& propertiesContainer,
|
||||
const gd::NamedPropertyDescriptor& property,
|
||||
const gd::String& type,
|
||||
gd::EventsCodeGenerationContext& context) override;
|
||||
|
||||
virtual gd::String GeneratePropertyGetterWithoutCasting(
|
||||
const gd::PropertiesContainer &propertiesContainer,
|
||||
const gd::NamedPropertyDescriptor &property) override;
|
||||
const gd::PropertiesContainer& propertiesContainer,
|
||||
const gd::NamedPropertyDescriptor& property) override;
|
||||
|
||||
virtual gd::String GenerateParameterGetter(const gd::ParameterMetadata& parameter,
|
||||
const gd::String& type,
|
||||
gd::EventsCodeGenerationContext& context) override;
|
||||
virtual gd::String GenerateParameterGetter(
|
||||
const gd::ParameterMetadata& parameter,
|
||||
const gd::String& type,
|
||||
gd::EventsCodeGenerationContext& context) override;
|
||||
|
||||
virtual gd::String GenerateParameterGetterWithoutCasting(
|
||||
const gd::ParameterMetadata ¶meter) override;
|
||||
const gd::ParameterMetadata& parameter) override;
|
||||
|
||||
virtual gd::String GenerateBadObject() override { return "null"; }
|
||||
|
||||
virtual gd::String GenerateObject(const gd::String& objectName,
|
||||
const gd::String& type,
|
||||
gd::EventsCodeGenerationContext& context) override;
|
||||
virtual gd::String GenerateObject(
|
||||
const gd::String& objectName,
|
||||
const gd::String& type,
|
||||
gd::EventsCodeGenerationContext& context) override;
|
||||
|
||||
virtual gd::String GenerateNegatedPredicate(const gd::String& predicate) const override {
|
||||
virtual gd::String GenerateNegatedPredicate(
|
||||
const gd::String& predicate) const override {
|
||||
return "!(" + predicate + ")";
|
||||
};
|
||||
|
||||
@@ -362,13 +372,15 @@ class EventsCodeGenerator : public gd::EventsCodeGenerator {
|
||||
virtual gd::String GenerateAllInstancesGetterCode(
|
||||
const gd::String& objectName, gd::EventsCodeGenerationContext& context);
|
||||
|
||||
virtual gd::String GenerateProfilerSectionBegin(const gd::String& section) override;
|
||||
virtual gd::String GenerateProfilerSectionEnd(const gd::String& section) override;
|
||||
virtual gd::String GenerateProfilerSectionBegin(
|
||||
const gd::String& section) override;
|
||||
virtual gd::String GenerateProfilerSectionEnd(
|
||||
const gd::String& section) override;
|
||||
|
||||
virtual gd::String GenerateRelationalOperation(
|
||||
const gd::String& relationalOperator,
|
||||
const gd::String& lhs,
|
||||
const gd::String& rhs) override;
|
||||
const gd::String& relationalOperator,
|
||||
const gd::String& lhs,
|
||||
const gd::String& rhs) override;
|
||||
|
||||
private:
|
||||
static gd::String GenerateEventsListCompleteFunctionCode(
|
||||
@@ -415,8 +427,8 @@ class EventsCodeGenerator : public gd::EventsCodeGenerator {
|
||||
* arguments from the rest of the events.
|
||||
*/
|
||||
gd::String GenerateFreeEventsFunctionContext(
|
||||
const gd::EventsFunctionsExtension &eventsFunctionsExtension,
|
||||
const gd::EventsFunction &eventsFunction,
|
||||
const gd::EventsFunctionsExtension& eventsFunctionsExtension,
|
||||
const gd::EventsFunction& eventsFunction,
|
||||
const gd::String& onceTriggersVariable);
|
||||
|
||||
/**
|
||||
@@ -425,9 +437,9 @@ class EventsCodeGenerator : public gd::EventsCodeGenerator {
|
||||
* arguments from the rest of the events.
|
||||
*/
|
||||
gd::String GenerateBehaviorEventsFunctionContext(
|
||||
const gd::EventsFunctionsExtension &eventsFunctionsExtension,
|
||||
const gd::EventsFunctionsExtension& eventsFunctionsExtension,
|
||||
const gd::EventsBasedBehavior& eventsBasedBehavior,
|
||||
const gd::EventsFunction &eventsFunction,
|
||||
const gd::EventsFunction& eventsFunction,
|
||||
const gd::String& onceTriggersVariable,
|
||||
const gd::String& thisObjectName,
|
||||
const gd::String& thisBehaviorName);
|
||||
@@ -438,9 +450,9 @@ class EventsCodeGenerator : public gd::EventsCodeGenerator {
|
||||
* arguments from the rest of the events.
|
||||
*/
|
||||
gd::String GenerateObjectEventsFunctionContext(
|
||||
const gd::EventsFunctionsExtension &eventsFunctionsExtension,
|
||||
const gd::EventsFunctionsExtension& eventsFunctionsExtension,
|
||||
const gd::EventsBasedObject& eventsBasedObject,
|
||||
const gd::EventsFunction &eventsFunction,
|
||||
const gd::EventsFunction& eventsFunction,
|
||||
const gd::String& onceTriggersVariable,
|
||||
const gd::String& thisObjectName);
|
||||
|
||||
@@ -455,7 +467,8 @@ class EventsCodeGenerator : public gd::EventsCodeGenerator {
|
||||
/**
|
||||
* \brief Construct a code generator for the specified containers.
|
||||
*/
|
||||
EventsCodeGenerator(const gd::ProjectScopedContainers& projectScopedContainers);
|
||||
EventsCodeGenerator(
|
||||
const gd::ProjectScopedContainers& projectScopedContainers);
|
||||
virtual ~EventsCodeGenerator();
|
||||
|
||||
gd::String codeNamespace; ///< Optional namespace for the generated code,
|
||||
@@ -467,16 +480,16 @@ class EventsCodeGenerator : public gd::EventsCodeGenerator {
|
||||
* to provides access objects, object creation and access to arguments from
|
||||
* the rest of the events.
|
||||
*/
|
||||
gd::String GenerateEventsFunctionContext(
|
||||
const gd::EventsFunctionsExtension &eventsFunctionsExtension,
|
||||
const gd::EventsFunctionsContainer &eventsFunctionsContainer,
|
||||
const gd::EventsFunction &eventsFunction,
|
||||
const gd::String &onceTriggersVariable,
|
||||
gd::String &objectsGettersMap,
|
||||
gd::String &objectArraysMap,
|
||||
gd::String &behaviorNamesMap,
|
||||
const gd::String &thisObjectName = "",
|
||||
const gd::String &thisBehaviorName = "");
|
||||
gd::String GenerateEventsFunctionContext(
|
||||
const gd::EventsFunctionsExtension& eventsFunctionsExtension,
|
||||
const gd::EventsFunctionsContainer& eventsFunctionsContainer,
|
||||
const gd::EventsFunction& eventsFunction,
|
||||
const gd::String& onceTriggersVariable,
|
||||
gd::String& objectsGettersMap,
|
||||
gd::String& objectArraysMap,
|
||||
gd::String& behaviorNamesMap,
|
||||
const gd::String& thisObjectName = "",
|
||||
const gd::String& thisBehaviorName = "");
|
||||
};
|
||||
|
||||
} // namespace gdjs
|
||||
|
@@ -22,9 +22,11 @@ AsyncExtension::AsyncExtension() {
|
||||
gd::AsyncEvent &event = dynamic_cast<gd::AsyncEvent &>(event_);
|
||||
|
||||
// Generate callback code
|
||||
const auto callbackDescriptor = codeGenerator.GenerateCallback(
|
||||
const auto callbackId =
|
||||
gd::String::From(codeGenerator.GenerateSingleUsageUniqueIdFor(
|
||||
event.GetInstruction().GetOriginalInstruction().lock().get())),
|
||||
event.GetInstruction().GetOriginalInstruction().lock().get()));
|
||||
const auto callbackDescriptor = codeGenerator.GenerateCallback(
|
||||
callbackId,
|
||||
parentContext,
|
||||
event.GetActions(),
|
||||
event.HasSubEvents() ? &event.GetSubEvents() : nullptr);
|
||||
@@ -33,10 +35,6 @@ AsyncExtension::AsyncExtension() {
|
||||
"(runtimeScene) => (" + callbackDescriptor.functionName + "(" +
|
||||
callbackDescriptor.argumentsList + "))";
|
||||
|
||||
// Generate the action and store the generated task.
|
||||
const gd::String asyncActionCode = codeGenerator.GenerateActionCode(
|
||||
event.GetInstruction(), parentContext, callbackCallCode);
|
||||
|
||||
// Generate code to backup the objects lists.
|
||||
// Do it after generating the code of the action so that it uses the
|
||||
// same object list as used in the action.
|
||||
@@ -70,6 +68,13 @@ AsyncExtension::AsyncExtension() {
|
||||
", obj);\n";
|
||||
}
|
||||
|
||||
// Generate the action and store the generated task.
|
||||
const gd::String asyncActionCode =
|
||||
codeGenerator.GenerateActionCode(event.GetInstruction(),
|
||||
parentContext,
|
||||
callbackCallCode,
|
||||
callbackId);
|
||||
|
||||
return "{\n" + parentAsyncObjectsListGetter + "{\n" +
|
||||
asyncContextBuilder + asyncActionCode + "}\n" + "}\n";
|
||||
});
|
||||
|
@@ -53,6 +53,7 @@ BaseObjectExtension::BaseObjectExtension() {
|
||||
"runtimeobject.js");
|
||||
objectActions["RotateTowardAngle"].SetFunctionName("rotateTowardAngle");
|
||||
objectActions["RotateTowardPosition"].SetFunctionName("rotateTowardPosition");
|
||||
objectActions["RotateTowardObject"].SetFunctionName("rotateTowardObject");
|
||||
objectActions["ChangeLayer"].SetFunctionName("setLayer");
|
||||
objectConditions["Layer"].SetFunctionName("isOnLayer");
|
||||
objectActions["ChangePlan"]
|
||||
@@ -229,6 +230,8 @@ BaseObjectExtension::BaseObjectExtension() {
|
||||
"gdjs.evtTools.object.pickRandomObject");
|
||||
GetAllConditions()["AjoutHasard"].SetFunctionName(
|
||||
"gdjs.evtTools.object.pickRandomObject");
|
||||
GetAllActions()["PickNearest"].SetFunctionName(
|
||||
"gdjs.evtTools.object.pickNearestObject");
|
||||
GetAllConditions()["PickNearest"].SetFunctionName(
|
||||
"gdjs.evtTools.object.pickNearestObject");
|
||||
|
||||
|
@@ -844,6 +844,7 @@ void ExporterHelper::AddLibsInclude(bool pixiRenderers,
|
||||
InsertUnique(includesFiles, "CustomRuntimeObjectInstanceContainer.js");
|
||||
InsertUnique(includesFiles, "CustomRuntimeObject.js");
|
||||
InsertUnique(includesFiles, "CustomRuntimeObject2D.js");
|
||||
InsertUnique(includesFiles, "indexeddb.js");
|
||||
|
||||
// Common includes for events only.
|
||||
InsertUnique(includesFiles, "events-tools/commontools.js");
|
||||
|
@@ -4,6 +4,33 @@
|
||||
* This project is released under the MIT License.
|
||||
*/
|
||||
namespace gdjs {
|
||||
export type WaitTaskNetworkSyncData = {
|
||||
type: 'wait';
|
||||
duration: float;
|
||||
timeElapsedOnScene: float;
|
||||
};
|
||||
export type ResolveTaskNetworkSyncData = null;
|
||||
export type PromiseTaskNetworkSyncData = null;
|
||||
export type ManuallyResolvableTaskNetworkSyncData = null;
|
||||
export type TaskGroupNetworkSyncData = {
|
||||
type: 'group';
|
||||
tasks: AsyncTaskNetworkSyncData[];
|
||||
};
|
||||
export type AsyncTaskNetworkSyncData =
|
||||
| WaitTaskNetworkSyncData
|
||||
| TaskGroupNetworkSyncData
|
||||
| PromiseTaskNetworkSyncData
|
||||
| ManuallyResolvableTaskNetworkSyncData
|
||||
| ResolveTaskNetworkSyncData;
|
||||
|
||||
export type AsyncTasksManagerNetworkSyncData = {
|
||||
tasks: Array<{
|
||||
callbackId: string;
|
||||
asyncTask: AsyncTaskNetworkSyncData;
|
||||
objectsList: gdjs.LongLivedObjectsListNetworkSyncData;
|
||||
}>;
|
||||
};
|
||||
|
||||
/**
|
||||
* This stores all asynchronous tasks waiting to be completed,
|
||||
* for a given scene.
|
||||
@@ -15,7 +42,12 @@ namespace gdjs {
|
||||
*/
|
||||
private tasksWithCallback = new Array<{
|
||||
asyncTask: AsyncTask;
|
||||
callback: (runtimeScene: gdjs.RuntimeScene) => void;
|
||||
callback: (
|
||||
runtimeScene: gdjs.RuntimeScene,
|
||||
longLivedObjectsList: gdjs.LongLivedObjectsList
|
||||
) => void;
|
||||
callbackId: string;
|
||||
longLivedObjectsList: gdjs.LongLivedObjectsList;
|
||||
}>();
|
||||
|
||||
/**
|
||||
@@ -26,7 +58,10 @@ namespace gdjs {
|
||||
const taskWithCallback = this.tasksWithCallback[i];
|
||||
if (taskWithCallback.asyncTask.update(runtimeScene)) {
|
||||
// The task has finished, run the callback and remove it.
|
||||
taskWithCallback.callback(runtimeScene);
|
||||
taskWithCallback.callback(
|
||||
runtimeScene,
|
||||
taskWithCallback.longLivedObjectsList
|
||||
);
|
||||
this.tasksWithCallback.splice(i--, 1);
|
||||
}
|
||||
}
|
||||
@@ -39,9 +74,19 @@ namespace gdjs {
|
||||
*/
|
||||
addTask(
|
||||
asyncTask: AsyncTask,
|
||||
callback: (runtimeScene: RuntimeScene) => void
|
||||
callback: (
|
||||
runtimeScene: RuntimeScene,
|
||||
longLivedObjectsList: gdjs.LongLivedObjectsList
|
||||
) => void,
|
||||
callbackId: string,
|
||||
longLivedObjectsList: gdjs.LongLivedObjectsList
|
||||
): void {
|
||||
this.tasksWithCallback.push({ asyncTask, callback });
|
||||
this.tasksWithCallback.push({
|
||||
asyncTask,
|
||||
callback,
|
||||
callbackId,
|
||||
longLivedObjectsList,
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -51,6 +96,80 @@ namespace gdjs {
|
||||
clearTasks() {
|
||||
this.tasksWithCallback.length = 0;
|
||||
}
|
||||
|
||||
getNetworkSyncData(
|
||||
syncOptions: GetNetworkSyncDataOptions
|
||||
): AsyncTasksManagerNetworkSyncData {
|
||||
const tasksData = this.tasksWithCallback
|
||||
.map(({ asyncTask, callbackId, longLivedObjectsList }) => {
|
||||
// Stay compatible with old extensions declaring tasks without a getNetworkSyncData method.
|
||||
if (!asyncTask.getNetworkSyncData) return null;
|
||||
|
||||
return {
|
||||
callbackId,
|
||||
asyncTask: asyncTask.getNetworkSyncData(),
|
||||
objectsList: longLivedObjectsList.getNetworkSyncData(syncOptions),
|
||||
};
|
||||
})
|
||||
.filter(Boolean);
|
||||
|
||||
return {
|
||||
tasks: tasksData,
|
||||
};
|
||||
}
|
||||
|
||||
updateFromNetworkSyncData(
|
||||
syncData: AsyncTasksManagerNetworkSyncData,
|
||||
idToCallbackMap: Map<
|
||||
string,
|
||||
(
|
||||
runtimeScene: gdjs.RuntimeScene,
|
||||
asyncObjectsList: gdjs.LongLivedObjectsList
|
||||
) => void
|
||||
>,
|
||||
runtimeScene: gdjs.RuntimeScene,
|
||||
syncOptions: UpdateFromNetworkSyncDataOptions
|
||||
) {
|
||||
this.clearTasks();
|
||||
|
||||
const unknownTaskTypes: string[] = [];
|
||||
|
||||
syncData.tasks.forEach(({ callbackId, asyncTask, objectsList }) => {
|
||||
if (!asyncTask) return;
|
||||
|
||||
const callback = idToCallbackMap.get(callbackId);
|
||||
if (callback) {
|
||||
const longLivedObjectsList = new gdjs.LongLivedObjectsList();
|
||||
longLivedObjectsList.updateFromNetworkSyncData(
|
||||
objectsList,
|
||||
runtimeScene,
|
||||
syncOptions
|
||||
);
|
||||
|
||||
if (asyncTask.type === 'group') {
|
||||
const task = new TaskGroup();
|
||||
task.updateFromNetworkSyncData(asyncTask);
|
||||
this.addTask(task, callback, callbackId, longLivedObjectsList);
|
||||
} else if (asyncTask.type === 'wait') {
|
||||
const task = new gdjs.evtTools.runtimeScene.WaitTask(
|
||||
asyncTask.duration
|
||||
);
|
||||
task.updateFromNetworkSyncData(asyncTask);
|
||||
this.addTask(task, callback, callbackId, longLivedObjectsList);
|
||||
} else {
|
||||
// Unknown task type.
|
||||
// @ts-ignore
|
||||
unknownTaskTypes.push(asyncTask.type);
|
||||
}
|
||||
}
|
||||
});
|
||||
|
||||
if (unknownTaskTypes.length) {
|
||||
console.warn(
|
||||
`${unknownTaskTypes.length} asynchronous task(s) could not be restored from network sync data. ${unknownTaskTypes.join(', ')}`
|
||||
);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -63,6 +182,12 @@ namespace gdjs {
|
||||
* @return True if the task is finished, false if it needs to continue running.
|
||||
*/
|
||||
abstract update(runtimeScene: RuntimeScene): boolean;
|
||||
|
||||
abstract getNetworkSyncData(): AsyncTaskNetworkSyncData;
|
||||
|
||||
abstract updateFromNetworkSyncData(
|
||||
syncData: AsyncTaskNetworkSyncData
|
||||
): void;
|
||||
}
|
||||
|
||||
export class TaskGroup extends AsyncTask {
|
||||
@@ -80,12 +205,54 @@ namespace gdjs {
|
||||
|
||||
return this.tasks.length === 0;
|
||||
}
|
||||
|
||||
getNetworkSyncData(): TaskGroupNetworkSyncData {
|
||||
return {
|
||||
type: 'group',
|
||||
tasks: this.tasks.map((task) => task.getNetworkSyncData()),
|
||||
};
|
||||
}
|
||||
|
||||
updateFromNetworkSyncData(syncData: TaskGroupNetworkSyncData) {
|
||||
const unknownTaskTypes: string[] = [];
|
||||
syncData.tasks.forEach((asyncTask) => {
|
||||
if (!asyncTask) return;
|
||||
|
||||
if (asyncTask.type === 'group') {
|
||||
const task = new TaskGroup();
|
||||
task.updateFromNetworkSyncData(asyncTask);
|
||||
this.addTask(task);
|
||||
} else if (asyncTask.type === 'wait') {
|
||||
const task = new gdjs.evtTools.runtimeScene.WaitTask(
|
||||
asyncTask.duration
|
||||
);
|
||||
task.updateFromNetworkSyncData(asyncTask);
|
||||
this.addTask(task);
|
||||
} else {
|
||||
// Unknown task type.
|
||||
// @ts-ignore
|
||||
unknownTaskTypes.push(asyncTask.type);
|
||||
}
|
||||
});
|
||||
|
||||
if (unknownTaskTypes.length) {
|
||||
console.warn(
|
||||
`${unknownTaskTypes.length} asynchronous task(s) could not be restored from network sync data. ${unknownTaskTypes.join(', ')}`
|
||||
);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
export class ResolveTask extends AsyncTask {
|
||||
update() {
|
||||
return true;
|
||||
}
|
||||
|
||||
getNetworkSyncData(): AsyncTaskNetworkSyncData {
|
||||
return null;
|
||||
}
|
||||
|
||||
updateFromNetworkSyncData(syncData: AsyncTaskNetworkSyncData): void {}
|
||||
}
|
||||
|
||||
const logger = new gdjs.Logger('Internal PromiseTask');
|
||||
@@ -121,6 +288,12 @@ ${error ? 'The following error was thrown: ' + error : ''}`
|
||||
update() {
|
||||
return this.isResolved;
|
||||
}
|
||||
|
||||
getNetworkSyncData(): AsyncTaskNetworkSyncData {
|
||||
return null;
|
||||
}
|
||||
|
||||
updateFromNetworkSyncData(syncData: AsyncTaskNetworkSyncData): void {}
|
||||
}
|
||||
|
||||
export class ManuallyResolvableTask extends AsyncTask {
|
||||
@@ -133,5 +306,11 @@ ${error ? 'The following error was thrown: ' + error : ''}`
|
||||
update(): boolean {
|
||||
return this.isResolved;
|
||||
}
|
||||
|
||||
getNetworkSyncData(): AsyncTaskNetworkSyncData {
|
||||
return null;
|
||||
}
|
||||
|
||||
updateFromNetworkSyncData(syncData: AsyncTaskNetworkSyncData): void {}
|
||||
}
|
||||
}
|
||||
|
@@ -17,11 +17,19 @@ namespace gdjs {
|
||||
isInnerAreaFollowingParentSize: boolean;
|
||||
};
|
||||
|
||||
export type CustomObjectNetworkSyncDataType = ObjectNetworkSyncData & {
|
||||
export type CustomObjectNetworkSyncDataType = {
|
||||
anim?: SpriteAnimatorNetworkSyncData;
|
||||
ifx: boolean;
|
||||
ify: boolean;
|
||||
sx: float;
|
||||
sy: float;
|
||||
op: float;
|
||||
cc?: [float, float];
|
||||
};
|
||||
|
||||
export type CustomObjectNetworkSyncData = ObjectNetworkSyncData &
|
||||
CustomObjectNetworkSyncDataType;
|
||||
|
||||
/**
|
||||
* An object that contains other object.
|
||||
*
|
||||
@@ -221,24 +229,66 @@ namespace gdjs {
|
||||
return true;
|
||||
}
|
||||
|
||||
getNetworkSyncData(): CustomObjectNetworkSyncDataType {
|
||||
return {
|
||||
...super.getNetworkSyncData(),
|
||||
getNetworkSyncData(
|
||||
syncOptions: GetNetworkSyncDataOptions
|
||||
): CustomObjectNetworkSyncData {
|
||||
const animator = this.getAnimator();
|
||||
const networkSyncData: CustomObjectNetworkSyncData = {
|
||||
...super.getNetworkSyncData(syncOptions),
|
||||
ifx: this.isFlippedX(),
|
||||
ify: this.isFlippedY(),
|
||||
sx: this._scaleX,
|
||||
sy: this._scaleY,
|
||||
op: this.opacity,
|
||||
};
|
||||
if (animator) {
|
||||
networkSyncData.anim = animator.getNetworkSyncData();
|
||||
}
|
||||
if (this._customCenter) {
|
||||
networkSyncData.cc = this._customCenter;
|
||||
}
|
||||
return networkSyncData;
|
||||
}
|
||||
|
||||
updateFromNetworkSyncData(
|
||||
networkSyncData: CustomObjectNetworkSyncDataType
|
||||
networkSyncData: CustomObjectNetworkSyncData,
|
||||
options: UpdateFromNetworkSyncDataOptions
|
||||
) {
|
||||
super.updateFromNetworkSyncData(networkSyncData);
|
||||
super.updateFromNetworkSyncData(networkSyncData, options);
|
||||
if (networkSyncData.ifx !== undefined) {
|
||||
this.flipX(networkSyncData.ifx);
|
||||
}
|
||||
if (networkSyncData.ify !== undefined) {
|
||||
this.flipY(networkSyncData.ify);
|
||||
}
|
||||
if (networkSyncData.sx !== undefined) {
|
||||
this.setScaleX(Math.abs(networkSyncData.sx));
|
||||
}
|
||||
if (networkSyncData.sy !== undefined) {
|
||||
this.setScaleY(Math.abs(networkSyncData.sy));
|
||||
}
|
||||
if (networkSyncData.op !== undefined) {
|
||||
this.setOpacity(networkSyncData.op);
|
||||
}
|
||||
if (networkSyncData.anim) {
|
||||
const animator = this.getAnimator();
|
||||
if (animator) {
|
||||
animator.updateFromNetworkSyncData(networkSyncData.anim);
|
||||
}
|
||||
}
|
||||
if (networkSyncData.cc) {
|
||||
this.setRotationCenter(networkSyncData.cc[0], networkSyncData.cc[1]);
|
||||
}
|
||||
if (
|
||||
networkSyncData.ifx !== undefined ||
|
||||
networkSyncData.ify !== undefined ||
|
||||
networkSyncData.sx !== undefined ||
|
||||
networkSyncData.sy !== undefined ||
|
||||
networkSyncData.anim !== undefined ||
|
||||
networkSyncData.cc !== undefined
|
||||
) {
|
||||
this.onChildrenLocationChanged();
|
||||
}
|
||||
}
|
||||
|
||||
override extraInitializationFromInitialInstance(
|
||||
|
@@ -312,15 +312,15 @@ namespace gdjs {
|
||||
xPos: float,
|
||||
yPos: float,
|
||||
zPos: float,
|
||||
trackByPersistentUuid: boolean
|
||||
trackByPersistentUuid: boolean,
|
||||
options?: {
|
||||
excludedObjectNames?: Set<string> | null;
|
||||
}
|
||||
): void {
|
||||
let zOffset: number;
|
||||
let shouldTrackByPersistentUuid: boolean;
|
||||
let zOffset: number = zPos;
|
||||
let shouldTrackByPersistentUuid: boolean = trackByPersistentUuid;
|
||||
|
||||
if (arguments.length === 5) {
|
||||
zOffset = zPos;
|
||||
shouldTrackByPersistentUuid = trackByPersistentUuid;
|
||||
} else {
|
||||
if (arguments.length <= 4) {
|
||||
/**
|
||||
* Support for the previous signature (before 3D was introduced):
|
||||
* createObjectsFrom(data, xPos, yPos, trackByPersistentUuid)
|
||||
@@ -332,6 +332,10 @@ namespace gdjs {
|
||||
for (let i = 0, len = data.length; i < len; ++i) {
|
||||
const instanceData = data[i];
|
||||
const objectName = instanceData.name;
|
||||
if (options?.excludedObjectNames?.has(objectName)) {
|
||||
continue;
|
||||
}
|
||||
|
||||
const newObject = this.createObject(objectName);
|
||||
if (newObject !== null) {
|
||||
if (shouldTrackByPersistentUuid) {
|
||||
@@ -609,7 +613,7 @@ namespace gdjs {
|
||||
* @param name Name of the object for which the instances must be returned.
|
||||
* @return The list of objects with the given name
|
||||
*/
|
||||
getObjects(name: string): gdjs.RuntimeObject[] | undefined {
|
||||
getObjects(name: string): gdjs.RuntimeObject[] {
|
||||
if (!this._instances.containsKey(name)) {
|
||||
logger.info(
|
||||
'RuntimeScene.getObjects: No instances called "' +
|
||||
@@ -623,7 +627,7 @@ namespace gdjs {
|
||||
|
||||
/**
|
||||
* Create a new object from its name. The object is also added to the instances
|
||||
* living in the container (No need to call {@link gdjs.RuntimeScene.addObject})
|
||||
* living in the container (No need to call {@link addObject})
|
||||
* @param objectName The name of the object to be created
|
||||
* @return The created object
|
||||
*/
|
||||
@@ -636,18 +640,20 @@ namespace gdjs {
|
||||
return null;
|
||||
}
|
||||
|
||||
const objectData = this._objects.get(objectName);
|
||||
|
||||
// Create a new object using the object constructor (cached during loading)
|
||||
// and the stored object's data:
|
||||
const cache = this._instancesCache.get(objectName);
|
||||
const ctor = this._objectsCtor.get(objectName);
|
||||
let obj;
|
||||
if (!cache || cache.length === 0) {
|
||||
obj = new ctor(this, this._objects.get(objectName));
|
||||
obj = new ctor(this, objectData);
|
||||
} else {
|
||||
// Reuse an objet destroyed before. If there is an object in the cache,
|
||||
// then it means it does support reinitialization.
|
||||
obj = cache.pop();
|
||||
obj.reinitialize(this._objects.get(objectName));
|
||||
obj.reinitialize(objectData);
|
||||
}
|
||||
this.addObject(obj);
|
||||
return obj;
|
||||
|
@@ -116,6 +116,101 @@ namespace gdjs {
|
||||
}
|
||||
}
|
||||
|
||||
getNetworkSyncData(): LayerNetworkSyncData {
|
||||
const effectsNetworkSyncData = {};
|
||||
for (const effectName in this._rendererEffects) {
|
||||
effectsNetworkSyncData[effectName] =
|
||||
this._rendererEffects[effectName].getNetworkSyncData();
|
||||
}
|
||||
|
||||
return {
|
||||
timeScale: this._timeScale,
|
||||
defaultZOrder: this._defaultZOrder,
|
||||
hidden: this._hidden,
|
||||
effects: effectsNetworkSyncData,
|
||||
followBaseLayerCamera: this._followBaseLayerCamera,
|
||||
clearColor: this._clearColor,
|
||||
cameraX: this.getCameraX(),
|
||||
cameraY: this.getCameraY(),
|
||||
cameraZ: this.getCameraZ(null),
|
||||
cameraRotation: this.getCameraRotation(),
|
||||
cameraZoom: this.getCameraZoom(),
|
||||
};
|
||||
}
|
||||
|
||||
updateFromNetworkSyncData(networkSyncData: LayerNetworkSyncData): void {
|
||||
if (
|
||||
networkSyncData.timeScale !== undefined &&
|
||||
networkSyncData.timeScale !== this._timeScale
|
||||
) {
|
||||
this.setTimeScale(networkSyncData.timeScale);
|
||||
}
|
||||
if (
|
||||
networkSyncData.defaultZOrder !== undefined &&
|
||||
networkSyncData.defaultZOrder !== this._defaultZOrder
|
||||
) {
|
||||
this.setDefaultZOrder(networkSyncData.defaultZOrder);
|
||||
}
|
||||
if (
|
||||
this._hidden != undefined &&
|
||||
this._hidden !== networkSyncData.hidden
|
||||
) {
|
||||
this.show(!networkSyncData.hidden);
|
||||
}
|
||||
if (
|
||||
networkSyncData.followBaseLayerCamera !== undefined &&
|
||||
networkSyncData.followBaseLayerCamera !== this._followBaseLayerCamera
|
||||
) {
|
||||
this.setFollowBaseLayerCamera(networkSyncData.followBaseLayerCamera);
|
||||
}
|
||||
if (
|
||||
networkSyncData.clearColor !== undefined &&
|
||||
networkSyncData.clearColor !== this._clearColor
|
||||
) {
|
||||
this.setClearColor(
|
||||
networkSyncData.clearColor[0] * 255,
|
||||
networkSyncData.clearColor[1] * 255,
|
||||
networkSyncData.clearColor[2] * 255
|
||||
);
|
||||
}
|
||||
if (
|
||||
networkSyncData.cameraX !== undefined &&
|
||||
networkSyncData.cameraX !== this.getCameraX()
|
||||
) {
|
||||
this.setCameraX(networkSyncData.cameraX);
|
||||
}
|
||||
if (
|
||||
networkSyncData.cameraY !== undefined &&
|
||||
networkSyncData.cameraY !== this.getCameraY()
|
||||
) {
|
||||
this.setCameraY(networkSyncData.cameraY);
|
||||
}
|
||||
if (
|
||||
networkSyncData.cameraZ !== undefined &&
|
||||
networkSyncData.cameraZ !== this.getCameraZ(null)
|
||||
) {
|
||||
this.setCameraZ(networkSyncData.cameraZ, null);
|
||||
}
|
||||
if (
|
||||
networkSyncData.cameraRotation !== undefined &&
|
||||
networkSyncData.cameraRotation !== this.getCameraRotation()
|
||||
) {
|
||||
this.setCameraRotation(networkSyncData.cameraRotation);
|
||||
}
|
||||
if (
|
||||
networkSyncData.cameraZoom !== undefined &&
|
||||
networkSyncData.cameraZoom !== this.getCameraZoom()
|
||||
) {
|
||||
this.setCameraZoom(networkSyncData.cameraZoom);
|
||||
}
|
||||
|
||||
for (const effectName in networkSyncData.effects) {
|
||||
this._rendererEffects[effectName].updateFromNetworkSyncData(
|
||||
networkSyncData.effects[effectName]
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
getRuntimeLayer(): gdjs.RuntimeLayer {
|
||||
return this;
|
||||
}
|
||||
|
@@ -348,7 +348,7 @@ namespace gdjs {
|
||||
// It can't actually happen.
|
||||
this._logs.push({
|
||||
kind: 'error',
|
||||
message: "Can't hot-reload as no scene are opened.",
|
||||
message: "Can't hot-reload as no scene is opened.",
|
||||
});
|
||||
return;
|
||||
}
|
||||
|
@@ -410,7 +410,12 @@ namespace gdjs {
|
||||
return true;
|
||||
};
|
||||
|
||||
export const pickNearestObject = function (objectsLists, x, y, inverted) {
|
||||
export const pickNearestObject = function (
|
||||
objectsLists: ObjectsLists,
|
||||
x: float,
|
||||
y: float,
|
||||
inverted?: boolean | undefined
|
||||
) {
|
||||
let bestObject = null;
|
||||
let best = 0;
|
||||
let first = true;
|
||||
@@ -421,8 +426,7 @@ namespace gdjs {
|
||||
for (let j = 0; j < list.length; ++j) {
|
||||
const object = list[j];
|
||||
const distance = object.getSqDistanceToPosition(x, y);
|
||||
// @ts-ignore
|
||||
if (first || (distance < best) ^ inverted) {
|
||||
if (first || distance < best !== inverted) {
|
||||
best = distance;
|
||||
bestObject = object;
|
||||
}
|
||||
@@ -622,6 +626,14 @@ namespace gdjs {
|
||||
}
|
||||
}
|
||||
|
||||
const logger = new gdjs.Logger('LongLivedObjectsLists');
|
||||
export type LongLivedObjectsListNetworkSyncData = {
|
||||
objectsLists: {
|
||||
[objectName: string]: Array<string>;
|
||||
};
|
||||
localVariablesContainers: Array<Array<VariableNetworkSyncData>>;
|
||||
};
|
||||
|
||||
/**
|
||||
* A container for objects lists that should last more than the current frame.
|
||||
* It automatically removes objects that were destroyed from the objects lists.
|
||||
@@ -695,5 +707,85 @@ namespace gdjs {
|
||||
): void {
|
||||
gdjs.copyArray(variablesContainers, this.localVariablesContainers);
|
||||
}
|
||||
|
||||
getNetworkSyncData(
|
||||
syncOptions: GetNetworkSyncDataOptions
|
||||
): LongLivedObjectsListNetworkSyncData {
|
||||
const objectsLists: {
|
||||
[objectName: string]: Array<string>;
|
||||
} = {};
|
||||
for (const [objectName, runtimeObjects] of this.objectsLists.entries()) {
|
||||
const objectNetworkIds: Array<string> = [];
|
||||
for (const runtimeObject of runtimeObjects) {
|
||||
const objectNetworkId = runtimeObject.getNetworkId();
|
||||
if (!objectNetworkId) {
|
||||
logger.warn(
|
||||
'Tried to get sync data of a LongLivedObjectsList and found an object without a network ID'
|
||||
);
|
||||
continue;
|
||||
}
|
||||
objectNetworkIds.push(objectNetworkId);
|
||||
}
|
||||
objectsLists[objectName] = objectNetworkIds;
|
||||
}
|
||||
return {
|
||||
objectsLists,
|
||||
localVariablesContainers: this.localVariablesContainers.map(
|
||||
(container) => container.getNetworkSyncData(syncOptions)
|
||||
),
|
||||
};
|
||||
}
|
||||
|
||||
updateFromNetworkSyncData(
|
||||
syncData: LongLivedObjectsListNetworkSyncData,
|
||||
runtimeScene: gdjs.RuntimeScene,
|
||||
syncOptions: UpdateFromNetworkSyncDataOptions
|
||||
) {
|
||||
const { objectsLists, localVariablesContainers } = syncData;
|
||||
|
||||
// Clear the current state.
|
||||
this.objectsLists.clear();
|
||||
this.localVariablesContainers.length = 0;
|
||||
|
||||
// Restore the list of objects.
|
||||
for (const [objectName, objectNetworkIds] of Object.entries(
|
||||
objectsLists
|
||||
)) {
|
||||
const runtimeObjects = runtimeScene.getObjects(objectName);
|
||||
if (!runtimeObjects) {
|
||||
logger.warn(
|
||||
'Tried to update sync data of a LongLivedObjectsList but cannot find objects with name: ' +
|
||||
objectName
|
||||
);
|
||||
continue;
|
||||
}
|
||||
|
||||
const runtimeObjectsFromSyncData = runtimeObjects.filter(
|
||||
(runtimeObject) => {
|
||||
const runtimeObjectNetworkId = runtimeObject.getNetworkId();
|
||||
return (
|
||||
!!runtimeObjectNetworkId &&
|
||||
objectNetworkIds.includes(runtimeObjectNetworkId)
|
||||
);
|
||||
}
|
||||
);
|
||||
|
||||
for (const runtimeObject of runtimeObjectsFromSyncData) {
|
||||
this.addObject(objectName, runtimeObject);
|
||||
}
|
||||
}
|
||||
|
||||
// Restore the local variables containers.
|
||||
this.localVariablesContainers = localVariablesContainers.map(
|
||||
(localVariablesContainer) => {
|
||||
const newContainer = new gdjs.VariablesContainer();
|
||||
newContainer.updateFromNetworkSyncData(
|
||||
localVariablesContainer,
|
||||
syncOptions
|
||||
);
|
||||
return newContainer;
|
||||
}
|
||||
);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
@@ -143,6 +143,19 @@ namespace gdjs {
|
||||
.getElapsedTime();
|
||||
return this.timeElapsedOnScene >= this.duration;
|
||||
}
|
||||
|
||||
getNetworkSyncData(): WaitTaskNetworkSyncData {
|
||||
return {
|
||||
type: 'wait',
|
||||
duration: this.duration,
|
||||
timeElapsedOnScene: this.timeElapsedOnScene,
|
||||
};
|
||||
}
|
||||
|
||||
updateFromNetworkSyncData(syncData: WaitTaskNetworkSyncData): void {
|
||||
this.duration = syncData.duration;
|
||||
this.timeElapsedOnScene = syncData.timeElapsedOnScene;
|
||||
}
|
||||
}
|
||||
|
||||
export const wait = (durationInSeconds: float): AsyncTask =>
|
||||
|
@@ -32,6 +32,16 @@ namespace gdjs {
|
||||
instanceContainer: gdjs.RuntimeInstanceContainer,
|
||||
runtimeObject: gdjs.RuntimeObject
|
||||
) => void;
|
||||
type RuntimeSceneGetSyncDataCallback = (
|
||||
runtimeScene: gdjs.RuntimeScene,
|
||||
currentSyncData: LayoutNetworkSyncData,
|
||||
syncOptions: GetNetworkSyncDataOptions
|
||||
) => void;
|
||||
type RuntimeSceneUpdateFromSyncData = (
|
||||
runtimeScene: gdjs.RuntimeScene,
|
||||
receivedSyncData: LayoutNetworkSyncData,
|
||||
options: UpdateFromNetworkSyncDataOptions
|
||||
) => void;
|
||||
|
||||
export const callbacksFirstRuntimeSceneLoaded: Array<RuntimeSceneCallback> =
|
||||
[];
|
||||
@@ -45,6 +55,10 @@ namespace gdjs {
|
||||
export const callbacksRuntimeSceneUnloaded: Array<RuntimeSceneCallback> = [];
|
||||
export const callbacksObjectDeletedFromScene: Array<RuntimeSceneRuntimeObjectCallback> =
|
||||
[];
|
||||
export const callbacksRuntimeSceneGetSyncData: Array<RuntimeSceneGetSyncDataCallback> =
|
||||
[];
|
||||
export const callbacksRuntimeSceneUpdateFromSyncData: Array<RuntimeSceneUpdateFromSyncData> =
|
||||
[];
|
||||
|
||||
/** Base64 encoded logo of GDevelop for the splash screen. */
|
||||
export let gdevelopLogo: string = '';
|
||||
@@ -397,6 +411,28 @@ namespace gdjs {
|
||||
gdjs.callbacksObjectDeletedFromScene.push(callback);
|
||||
};
|
||||
|
||||
/**
|
||||
* Register a function to be called each time a scene is getting its sync
|
||||
* data retrieved (via getNetworkSyncData).
|
||||
* @param callback The function to be called.
|
||||
*/
|
||||
export const registerRuntimeSceneGetSyncDataCallback = function (
|
||||
callback: RuntimeSceneGetSyncDataCallback
|
||||
): void {
|
||||
gdjs.callbacksRuntimeSceneGetSyncData.push(callback);
|
||||
};
|
||||
|
||||
/**
|
||||
* Register a function to be called each time a scene is getting its sync
|
||||
* data updated (via updateFromNetworkSyncData).
|
||||
* @param callback The function to be called.
|
||||
*/
|
||||
export const registerRuntimeSceneUpdateFromSyncDataCallback = function (
|
||||
callback: RuntimeSceneUpdateFromSyncData
|
||||
): void {
|
||||
gdjs.callbacksRuntimeSceneUpdateFromSyncData.push(callback);
|
||||
};
|
||||
|
||||
/**
|
||||
* Unregister a callback.
|
||||
* This should not be used apart from the code generated from extensions
|
||||
|
@@ -30,6 +30,36 @@ namespace gdjs {
|
||||
return volume;
|
||||
};
|
||||
|
||||
/**
|
||||
* Handles errors that occur when calling Howler sound methods.
|
||||
*
|
||||
* This function provides special handling for "Maximum call stack size exceeded" errors
|
||||
* that can occur in Howler.js due to recursive method calls in volume(), seek(), fade(),
|
||||
* and other sound manipulation methods. Instead of crashing the application, these
|
||||
* specific errors are logged as warnings to allow the application to continue running.
|
||||
*
|
||||
* @param error - The error that occurred during the method call
|
||||
* @param methodName - The name of the Howler method that caused the error (e.g., 'volume', 'seek')
|
||||
*
|
||||
* @throws {Error} Re-throws the original error if it's not a stack overflow error
|
||||
*
|
||||
*/
|
||||
const handleHowlerSoundMethodError = (error: unknown, methodName: string) => {
|
||||
if (
|
||||
error instanceof Error &&
|
||||
error.message &&
|
||||
typeof error.message === 'string' &&
|
||||
error.message.startsWith('Maximum call stack size exceeded')
|
||||
) {
|
||||
console.warn(
|
||||
`An error occurred when call method "${methodName}":`,
|
||||
error
|
||||
);
|
||||
} else {
|
||||
throw error;
|
||||
}
|
||||
};
|
||||
|
||||
/**
|
||||
* A thin wrapper around a Howl object with:
|
||||
* * Handling of callbacks when the sound is not yet loaded.
|
||||
@@ -84,11 +114,23 @@ namespace gdjs {
|
||||
*/
|
||||
private _onPlay: Array<HowlCallback> = [];
|
||||
|
||||
constructor(howl: Howl, volume: float, loop: boolean, rate: float) {
|
||||
/**
|
||||
* The filepath to the resource
|
||||
*/
|
||||
private _audioResourceName: string;
|
||||
|
||||
constructor(
|
||||
howl: Howl,
|
||||
volume: float,
|
||||
loop: boolean,
|
||||
rate: float,
|
||||
audioResourceName: string
|
||||
) {
|
||||
this._howl = howl;
|
||||
this._initialVolume = clampVolume(volume);
|
||||
this._loop = loop;
|
||||
this._rate = rate;
|
||||
this._audioResourceName = audioResourceName;
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -103,33 +145,36 @@ namespace gdjs {
|
||||
* @returns The current instance for chaining.
|
||||
*/
|
||||
play(): this {
|
||||
if (this.isLoaded()) {
|
||||
const newID = this._howl.play(
|
||||
this._id === null ? '__default' : this._id
|
||||
);
|
||||
this._id = newID;
|
||||
try {
|
||||
if (this.isLoaded()) {
|
||||
const newID = this._howl.play(
|
||||
this._id === null ? '__default' : this._id
|
||||
);
|
||||
this._id = newID;
|
||||
|
||||
// Set the howl properties as soon as the sound is played and we have its ID.
|
||||
this._howl.volume(this._initialVolume, newID); // this._initialVolume is already clamped between 0 and 1.
|
||||
this._howl.loop(this._loop, newID);
|
||||
// this._rate is not clamped, but we need to clamp it when passing it to Howler.js as it
|
||||
// only supports a specific range.
|
||||
this._howl.rate(gdjs.HowlerSoundManager.clampRate(this._rate), newID);
|
||||
|
||||
// Manually handle the play event before we have an ID.
|
||||
// Before loading, howler won't register events as without an ID we cannot set a listener.
|
||||
// Once we have an ID, we can transfer control of the events to howler.
|
||||
// We also need to call them once as Howler doesn't for the first play event.
|
||||
this._onPlay.forEach((func) => {
|
||||
// Transfer the event to howler now that we have an ID
|
||||
this.on('play', func);
|
||||
func(newID);
|
||||
});
|
||||
this._oncePlay.forEach((func) => func(newID));
|
||||
this._onPlay = [];
|
||||
this._oncePlay = [];
|
||||
} else this._howl.once('load', () => this.play()); // Play only once the howl is fully loaded
|
||||
// Set the howl properties as soon as the sound is played and we have its ID.
|
||||
this._howl.volume(this._initialVolume, newID); // this._initialVolume is already clamped between 0 and 1.
|
||||
this._howl.loop(this._loop, newID);
|
||||
// this._rate is not clamped, but we need to clamp it when passing it to Howler.js as it
|
||||
// only supports a specific range.
|
||||
this._howl.rate(gdjs.HowlerSoundManager.clampRate(this._rate), newID);
|
||||
|
||||
// Manually handle the play event before we have an ID.
|
||||
// Before loading, howler won't register events as without an ID we cannot set a listener.
|
||||
// Once we have an ID, we can transfer control of the events to howler.
|
||||
// We also need to call them once as Howler doesn't for the first play event.
|
||||
this._onPlay.forEach((func) => {
|
||||
// Transfer the event to howler now that we have an ID
|
||||
this.on('play', func);
|
||||
func(newID);
|
||||
});
|
||||
this._oncePlay.forEach((func) => func(newID));
|
||||
this._onPlay = [];
|
||||
this._oncePlay = [];
|
||||
} else this._howl.once('load', () => this.play()); // Play only once the howl is fully loaded
|
||||
} catch (error) {
|
||||
handleHowlerSoundMethodError(error, 'play');
|
||||
}
|
||||
return this;
|
||||
}
|
||||
|
||||
@@ -138,7 +183,11 @@ namespace gdjs {
|
||||
* @returns The current instance for chaining.
|
||||
*/
|
||||
pause(): this {
|
||||
if (this._id !== null) this._howl.pause(this._id);
|
||||
try {
|
||||
if (this._id !== null) this._howl.pause(this._id);
|
||||
} catch (error) {
|
||||
handleHowlerSoundMethodError(error, 'pause');
|
||||
}
|
||||
return this;
|
||||
}
|
||||
|
||||
@@ -147,7 +196,11 @@ namespace gdjs {
|
||||
* @returns The current instance for chaining.
|
||||
*/
|
||||
stop(): this {
|
||||
if (this._id !== null) this._howl.stop(this._id);
|
||||
try {
|
||||
if (this._id !== null) this._howl.stop(this._id);
|
||||
} catch (error) {
|
||||
handleHowlerSoundMethodError(error, 'stop');
|
||||
}
|
||||
return this;
|
||||
}
|
||||
|
||||
@@ -158,9 +211,10 @@ namespace gdjs {
|
||||
* to preload the sounds.
|
||||
*/
|
||||
playing(): boolean {
|
||||
const isSoundPlaying =
|
||||
this._id !== null ? this._howl.playing(this._id) : true;
|
||||
return (
|
||||
(this._id !== null ? this._howl.playing(this._id) : true) ||
|
||||
!this.isLoaded() // Loading is considered playing
|
||||
isSoundPlaying || !this.isLoaded() // Loading is considered playing
|
||||
);
|
||||
}
|
||||
|
||||
@@ -196,11 +250,15 @@ namespace gdjs {
|
||||
* @returns The current instance for chaining.
|
||||
*/
|
||||
setRate(rate: float): this {
|
||||
this._rate = rate;
|
||||
// If the sound has already started playing, then change the value directly.
|
||||
if (this._id !== null) {
|
||||
rate = gdjs.HowlerSoundManager.clampRate(rate);
|
||||
this._howl.rate(rate, this._id);
|
||||
try {
|
||||
this._rate = rate;
|
||||
// If the sound has already started playing, then change the value directly.
|
||||
if (this._id !== null) {
|
||||
rate = gdjs.HowlerSoundManager.clampRate(rate);
|
||||
this._howl.rate(rate, this._id);
|
||||
}
|
||||
} catch (error) {
|
||||
handleHowlerSoundMethodError(error, 'rate');
|
||||
}
|
||||
return this;
|
||||
}
|
||||
@@ -217,9 +275,13 @@ namespace gdjs {
|
||||
* @returns The current instance for chaining.
|
||||
*/
|
||||
setLoop(loop: boolean): this {
|
||||
this._loop = loop;
|
||||
// If the sound has already started playing, then change the value directly.
|
||||
if (this._id !== null) this._howl.loop(loop, this._id);
|
||||
try {
|
||||
this._loop = loop;
|
||||
// If the sound has already started playing, then change the value directly.
|
||||
if (this._id !== null) this._howl.loop(loop, this._id);
|
||||
} catch (error) {
|
||||
handleHowlerSoundMethodError(error, 'loop');
|
||||
}
|
||||
return this;
|
||||
}
|
||||
|
||||
@@ -239,10 +301,14 @@ namespace gdjs {
|
||||
* @returns The current instance for chaining.
|
||||
*/
|
||||
setVolume(volume: float): this {
|
||||
this._initialVolume = clampVolume(volume);
|
||||
try {
|
||||
this._initialVolume = clampVolume(volume);
|
||||
|
||||
// If the sound has already started playing, then change the value directly.
|
||||
if (this._id !== null) this._howl.volume(this._initialVolume, this._id);
|
||||
// If the sound has already started playing, then change the value directly.
|
||||
if (this._id !== null) this._howl.volume(this._initialVolume, this._id);
|
||||
} catch (error) {
|
||||
handleHowlerSoundMethodError(error, 'volume');
|
||||
}
|
||||
return this;
|
||||
}
|
||||
|
||||
@@ -259,7 +325,11 @@ namespace gdjs {
|
||||
* @returns The current instance for chaining.
|
||||
*/
|
||||
setMute(mute: boolean): this {
|
||||
if (this._id !== null) this._howl.mute(mute, this._id);
|
||||
try {
|
||||
if (this._id !== null) this._howl.mute(mute, this._id);
|
||||
} catch (error) {
|
||||
handleHowlerSoundMethodError(error, 'mute');
|
||||
}
|
||||
return this;
|
||||
}
|
||||
|
||||
@@ -276,7 +346,11 @@ namespace gdjs {
|
||||
* @returns The current instance for chaining.
|
||||
*/
|
||||
setSeek(seek: float): this {
|
||||
if (this._id !== null) this._howl.seek(seek, this._id);
|
||||
try {
|
||||
if (this._id !== null) this._howl.seek(seek, this._id);
|
||||
} catch (error) {
|
||||
handleHowlerSoundMethodError(error, 'seek');
|
||||
}
|
||||
return this;
|
||||
}
|
||||
|
||||
@@ -302,8 +376,17 @@ namespace gdjs {
|
||||
* @returns The current instance for chaining.
|
||||
*/
|
||||
fade(from: float, to: float, duration: float): this {
|
||||
if (this._id !== null)
|
||||
this._howl.fade(clampVolume(from), clampVolume(to), duration, this._id);
|
||||
try {
|
||||
if (this._id !== null)
|
||||
this._howl.fade(
|
||||
clampVolume(from),
|
||||
clampVolume(to),
|
||||
duration,
|
||||
this._id
|
||||
);
|
||||
} catch (error) {
|
||||
handleHowlerSoundMethodError(error, 'fade');
|
||||
}
|
||||
return this;
|
||||
}
|
||||
|
||||
@@ -357,10 +440,27 @@ namespace gdjs {
|
||||
if (this._id !== null) this._howl.off(event, handler, this._id);
|
||||
return this;
|
||||
}
|
||||
|
||||
getNetworkSyncData(): SoundSyncData | undefined {
|
||||
if (this.paused() || !this.isLoaded() || this.stopped()) return undefined;
|
||||
// Seek can sometimes return the Howl object in case it isn't loaded yet, in this case we default to 0.
|
||||
const seek = this.getSeek();
|
||||
const numberSeek = typeof seek !== 'number' ? 0 : seek;
|
||||
// If the Howl is still loading, we use the initialVolume, as the Howl
|
||||
// has been initialized with volume 0.
|
||||
const volume = this.isLoaded() ? this.getVolume() : this._initialVolume;
|
||||
return {
|
||||
resourceName: this._audioResourceName,
|
||||
loop: this._loop,
|
||||
volume,
|
||||
rate: this._rate,
|
||||
seek: numberSeek,
|
||||
};
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* HowlerSoundManager is used to manage the sounds and musics of a RuntimeScene.
|
||||
* HowlerSoundManager is used to manage the sounds and musics of a RuntimeGame.
|
||||
*
|
||||
* It is basically a container to associate channels to sounds and keep a list
|
||||
* of all sounds being played.
|
||||
@@ -609,8 +709,7 @@ namespace gdjs {
|
||||
);
|
||||
cacheContainer.set(resource, howl);
|
||||
}
|
||||
|
||||
return new gdjs.HowlerSound(howl, volume, loop, rate);
|
||||
return new gdjs.HowlerSound(howl, volume, loop, rate, soundName);
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -708,7 +807,13 @@ namespace gdjs {
|
||||
this._loadedSounds.clear();
|
||||
}
|
||||
|
||||
playSound(soundName: string, loop: boolean, volume: float, pitch: float) {
|
||||
playSound(
|
||||
soundName: string,
|
||||
loop: boolean,
|
||||
volume: float,
|
||||
pitch: float,
|
||||
seek?: float
|
||||
) {
|
||||
const sound = this.createHowlerSound(
|
||||
soundName,
|
||||
/* isMusic= */ false,
|
||||
@@ -724,6 +829,9 @@ namespace gdjs {
|
||||
}
|
||||
});
|
||||
sound.play();
|
||||
if (seek) {
|
||||
sound.setSeek(seek);
|
||||
}
|
||||
}
|
||||
|
||||
playSoundOnChannel(
|
||||
@@ -731,7 +839,8 @@ namespace gdjs {
|
||||
channel: integer,
|
||||
loop: boolean,
|
||||
volume: float,
|
||||
pitch: float
|
||||
pitch: float,
|
||||
seek?: float
|
||||
) {
|
||||
if (this._sounds[channel]) this._sounds[channel].stop();
|
||||
|
||||
@@ -756,13 +865,22 @@ namespace gdjs {
|
||||
}
|
||||
});
|
||||
sound.play();
|
||||
if (seek) {
|
||||
sound.setSeek(seek);
|
||||
}
|
||||
}
|
||||
|
||||
getSoundOnChannel(channel: integer): HowlerSound | null {
|
||||
return this._sounds[channel] || null;
|
||||
}
|
||||
|
||||
playMusic(soundName: string, loop: boolean, volume: float, pitch: float) {
|
||||
playMusic(
|
||||
soundName: string,
|
||||
loop: boolean,
|
||||
volume: float,
|
||||
pitch: float,
|
||||
seek?: float
|
||||
) {
|
||||
const music = this.createHowlerSound(
|
||||
soundName,
|
||||
/* isMusic= */ true,
|
||||
@@ -778,6 +896,9 @@ namespace gdjs {
|
||||
}
|
||||
});
|
||||
music.play();
|
||||
if (seek) {
|
||||
music.setSeek(seek);
|
||||
}
|
||||
}
|
||||
|
||||
playMusicOnChannel(
|
||||
@@ -785,7 +906,8 @@ namespace gdjs {
|
||||
channel: integer,
|
||||
loop: boolean,
|
||||
volume: float,
|
||||
pitch: float
|
||||
pitch: float,
|
||||
seek?: float
|
||||
) {
|
||||
if (this._musics[channel]) this._musics[channel].stop();
|
||||
|
||||
@@ -805,6 +927,9 @@ namespace gdjs {
|
||||
}
|
||||
});
|
||||
music.play();
|
||||
if (seek) {
|
||||
music.setSeek(seek);
|
||||
}
|
||||
}
|
||||
|
||||
getMusicOnChannel(channel: integer): HowlerSound | null {
|
||||
@@ -932,6 +1057,97 @@ namespace gdjs {
|
||||
}
|
||||
}
|
||||
|
||||
getNetworkSyncData(): SoundManagerSyncData {
|
||||
const freeMusicsNetworkSyncData: SoundSyncData[] = [];
|
||||
this._freeMusics.forEach((freeMusic) => {
|
||||
const musicSyncData = freeMusic.getNetworkSyncData();
|
||||
if (musicSyncData) freeMusicsNetworkSyncData.push(musicSyncData);
|
||||
});
|
||||
const freeSoundsNetworkSyncData: SoundSyncData[] = [];
|
||||
this._freeSounds.forEach((freeSound) => {
|
||||
const soundSyncData = freeSound.getNetworkSyncData();
|
||||
if (soundSyncData) freeSoundsNetworkSyncData.push(soundSyncData);
|
||||
});
|
||||
const musicsNetworkSyncData: ChannelsSoundSyncData = {};
|
||||
Object.entries(this._musics).forEach(([channel, music]) => {
|
||||
const musicSyncData = music.getNetworkSyncData();
|
||||
if (musicSyncData) {
|
||||
const channelNumber = parseInt(channel, 10);
|
||||
musicsNetworkSyncData[channelNumber] = musicSyncData;
|
||||
}
|
||||
});
|
||||
const soundsNetworkSyncData: ChannelsSoundSyncData = {};
|
||||
Object.entries(this._sounds).forEach(([channel, sound]) => {
|
||||
const soundSyncData = sound.getNetworkSyncData();
|
||||
if (soundSyncData) {
|
||||
const channelNumber = parseInt(channel, 10);
|
||||
soundsNetworkSyncData[channelNumber] = soundSyncData;
|
||||
}
|
||||
});
|
||||
|
||||
return {
|
||||
globalVolume: this._globalVolume,
|
||||
cachedSpatialPosition: this._cachedSpatialPosition,
|
||||
freeMusics: freeMusicsNetworkSyncData,
|
||||
freeSounds: freeSoundsNetworkSyncData,
|
||||
musics: musicsNetworkSyncData,
|
||||
sounds: soundsNetworkSyncData,
|
||||
};
|
||||
}
|
||||
|
||||
updateFromNetworkSyncData(syncData: SoundManagerSyncData): void {
|
||||
this.clearAll();
|
||||
this._globalVolume = syncData.globalVolume;
|
||||
this._cachedSpatialPosition = syncData.cachedSpatialPosition;
|
||||
|
||||
for (let i = 0; i < syncData.freeSounds.length; i++) {
|
||||
const freeSoundsSyncData: SoundSyncData = syncData.freeSounds[i];
|
||||
|
||||
this.playSound(
|
||||
freeSoundsSyncData.resourceName,
|
||||
freeSoundsSyncData.loop,
|
||||
freeSoundsSyncData.volume * 100,
|
||||
freeSoundsSyncData.rate,
|
||||
freeSoundsSyncData.seek
|
||||
);
|
||||
}
|
||||
|
||||
for (let i = 0; i < syncData.freeMusics.length; i++) {
|
||||
const freeMusicsSyncData: SoundSyncData = syncData.freeMusics[i];
|
||||
this.playMusic(
|
||||
freeMusicsSyncData.resourceName,
|
||||
freeMusicsSyncData.loop,
|
||||
freeMusicsSyncData.volume * 100,
|
||||
freeMusicsSyncData.rate,
|
||||
freeMusicsSyncData.seek
|
||||
);
|
||||
}
|
||||
|
||||
for (const [channel, soundSyncData] of Object.entries(syncData.sounds)) {
|
||||
const channelNumber = parseInt(channel, 10);
|
||||
this.playSoundOnChannel(
|
||||
soundSyncData.resourceName,
|
||||
channelNumber,
|
||||
soundSyncData.loop,
|
||||
soundSyncData.volume * 100,
|
||||
soundSyncData.rate,
|
||||
soundSyncData.seek
|
||||
);
|
||||
}
|
||||
|
||||
for (const [channel, musicSyncData] of Object.entries(syncData.musics)) {
|
||||
const channelNumber = parseInt(channel, 10);
|
||||
this.playMusicOnChannel(
|
||||
musicSyncData.resourceName,
|
||||
channelNumber,
|
||||
musicSyncData.loop,
|
||||
musicSyncData.volume * 100,
|
||||
musicSyncData.rate,
|
||||
musicSyncData.seek
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* To be called when the game is disposed.
|
||||
* Unloads all audio from memory, clear Howl cache and stop all audio.
|
||||
|
105
GDJS/Runtime/indexeddb.ts
Normal file
105
GDJS/Runtime/indexeddb.ts
Normal file
@@ -0,0 +1,105 @@
|
||||
/*
|
||||
* GDevelop JS Platform
|
||||
* Copyright 2013-2016 Florian Rival (Florian.Rival@gmail.com). All rights reserved.
|
||||
* This project is released under the MIT License.
|
||||
*/
|
||||
namespace gdjs {
|
||||
export namespace indexedDb {
|
||||
export const loadFromIndexedDB = async function (
|
||||
dbName: string,
|
||||
objectStoreName: string,
|
||||
key: string
|
||||
): Promise<any> {
|
||||
return new Promise((resolve, reject) => {
|
||||
try {
|
||||
const request = indexedDB.open(dbName, 1);
|
||||
request.onupgradeneeded = function () {
|
||||
const db = request.result;
|
||||
if (!db.objectStoreNames.contains(objectStoreName)) {
|
||||
db.createObjectStore(objectStoreName);
|
||||
}
|
||||
};
|
||||
|
||||
request.onsuccess = function () {
|
||||
const db = request.result;
|
||||
|
||||
const tx = db.transaction(objectStoreName, 'readonly');
|
||||
const store = tx.objectStore(objectStoreName);
|
||||
const getRequest = store.get(key);
|
||||
|
||||
getRequest.onsuccess = function () {
|
||||
if (getRequest.result !== undefined) {
|
||||
resolve(getRequest.result);
|
||||
} else {
|
||||
resolve(null);
|
||||
}
|
||||
};
|
||||
|
||||
getRequest.onerror = function () {
|
||||
console.error(
|
||||
'Error loading data from IndexedDB:',
|
||||
getRequest.error
|
||||
);
|
||||
reject(getRequest.error);
|
||||
};
|
||||
};
|
||||
|
||||
request.onerror = function () {
|
||||
console.error('Error opening IndexedDB:', request.error);
|
||||
reject(request.error);
|
||||
};
|
||||
} catch (err) {
|
||||
console.error('Exception thrown while opening IndexedDB:', err);
|
||||
reject(err);
|
||||
return;
|
||||
}
|
||||
});
|
||||
};
|
||||
|
||||
export const saveToIndexedDB = async function (
|
||||
dbName: string,
|
||||
objectStoreName: string,
|
||||
key: string,
|
||||
data: any
|
||||
): Promise<void> {
|
||||
return new Promise((resolve, reject) => {
|
||||
try {
|
||||
const request = indexedDB.open(dbName, 1);
|
||||
request.onupgradeneeded = function (event) {
|
||||
const db = request.result;
|
||||
if (!db.objectStoreNames.contains(objectStoreName)) {
|
||||
db.createObjectStore(objectStoreName);
|
||||
}
|
||||
};
|
||||
request.onsuccess = function () {
|
||||
const db = request.result;
|
||||
const tx = db.transaction(objectStoreName, 'readwrite');
|
||||
const store = tx.objectStore(objectStoreName);
|
||||
const putRequest = store.put(data, key);
|
||||
|
||||
putRequest.onsuccess = function () {
|
||||
resolve();
|
||||
};
|
||||
|
||||
putRequest.onerror = function () {
|
||||
console.error(
|
||||
'Error saving data to IndexedDB:',
|
||||
putRequest.error
|
||||
);
|
||||
reject(putRequest.error);
|
||||
};
|
||||
};
|
||||
|
||||
request.onerror = function () {
|
||||
console.error('Error opening IndexedDB:', request.error);
|
||||
reject(request.error);
|
||||
};
|
||||
} catch (err) {
|
||||
console.error('Exception thrown while opening IndexedDB:', err);
|
||||
reject(err);
|
||||
return;
|
||||
}
|
||||
});
|
||||
};
|
||||
}
|
||||
}
|
@@ -8,6 +8,11 @@ namespace gdjs {
|
||||
* OnceTriggers is used to store the status of the conditions "Trigger once",
|
||||
* that are used in events to have conditions that are only valid for one frame in a row.
|
||||
*/
|
||||
|
||||
type OnceTriggersSyncData = {
|
||||
onceTriggers: Record<integer, boolean>;
|
||||
lastFrameOnceTriggers: Record<integer, boolean>;
|
||||
};
|
||||
export class OnceTriggers {
|
||||
_onceTriggers: Record<integer, boolean> = {};
|
||||
_lastFrameOnceTrigger: Record<integer, boolean> = {};
|
||||
@@ -40,5 +45,17 @@ namespace gdjs {
|
||||
this._onceTriggers[triggerId] = true;
|
||||
return !this._lastFrameOnceTrigger.hasOwnProperty(triggerId);
|
||||
}
|
||||
|
||||
getNetworkSyncData(): OnceTriggersSyncData {
|
||||
return {
|
||||
onceTriggers: this._onceTriggers,
|
||||
lastFrameOnceTriggers: this._lastFrameOnceTrigger,
|
||||
};
|
||||
}
|
||||
|
||||
updateNetworkSyncData(data: OnceTriggersSyncData): void {
|
||||
this._onceTriggers = data.onceTriggers;
|
||||
this._lastFrameOnceTrigger = data.lastFrameOnceTriggers;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
@@ -56,6 +56,11 @@ namespace gdjs {
|
||||
*/
|
||||
private _loadedThreeTextures: Hashtable<THREE.Texture>;
|
||||
private _loadedThreeMaterials = new ThreeMaterialCache();
|
||||
private _loadedThreeCubeTextures = new Map<string, THREE.CubeTexture>();
|
||||
private _loadedThreeCubeTextureKeysByResourceName = new ArrayMap<
|
||||
string,
|
||||
string
|
||||
>();
|
||||
|
||||
private _diskTextures = new Map<float, PIXI.Texture>();
|
||||
private _rectangleTextures = new Map<string, PIXI.Texture>();
|
||||
@@ -181,7 +186,25 @@ namespace gdjs {
|
||||
if (loadedThreeTexture) {
|
||||
return loadedThreeTexture;
|
||||
}
|
||||
const image = this._getImageSource(resourceName);
|
||||
|
||||
const threeTexture = new THREE.Texture(image);
|
||||
threeTexture.magFilter = THREE.LinearFilter;
|
||||
threeTexture.minFilter = THREE.LinearFilter;
|
||||
threeTexture.wrapS = THREE.RepeatWrapping;
|
||||
threeTexture.wrapT = THREE.RepeatWrapping;
|
||||
threeTexture.colorSpace = THREE.SRGBColorSpace;
|
||||
threeTexture.needsUpdate = true;
|
||||
|
||||
const resource = this._getImageResource(resourceName);
|
||||
|
||||
applyThreeTextureSettings(threeTexture, resource);
|
||||
this._loadedThreeTextures.put(resourceName, threeTexture);
|
||||
|
||||
return threeTexture;
|
||||
}
|
||||
|
||||
private _getImageSource(resourceName: string): HTMLImageElement {
|
||||
// Texture is not loaded, load it now from the PixiJS texture.
|
||||
// TODO (3D) - optimization: don't load the PixiJS Texture if not used by PixiJS.
|
||||
// TODO (3D) - optimization: Ideally we could even share the same WebGL texture.
|
||||
@@ -198,21 +221,86 @@ namespace gdjs {
|
||||
`Can't load texture for resource "${resourceName}" as it's not an image.`
|
||||
);
|
||||
}
|
||||
return image;
|
||||
}
|
||||
|
||||
const threeTexture = new THREE.Texture(image);
|
||||
threeTexture.magFilter = THREE.LinearFilter;
|
||||
threeTexture.minFilter = THREE.LinearFilter;
|
||||
threeTexture.wrapS = THREE.RepeatWrapping;
|
||||
threeTexture.wrapT = THREE.RepeatWrapping;
|
||||
threeTexture.colorSpace = THREE.SRGBColorSpace;
|
||||
threeTexture.needsUpdate = true;
|
||||
/**
|
||||
* Return the three.js texture associated to the specified resource name.
|
||||
* Returns a placeholder texture if not found.
|
||||
* @param xPositiveResourceName The name of the resource
|
||||
* @returns The requested cube texture, or a placeholder if not found.
|
||||
*/
|
||||
getThreeCubeTexture(
|
||||
xPositiveResourceName: string,
|
||||
xNegativeResourceName: string,
|
||||
yPositiveResourceName: string,
|
||||
yNegativeResourceName: string,
|
||||
zPositiveResourceName: string,
|
||||
zNegativeResourceName: string
|
||||
): THREE.CubeTexture {
|
||||
const key =
|
||||
xPositiveResourceName +
|
||||
'|' +
|
||||
xNegativeResourceName +
|
||||
'|' +
|
||||
yPositiveResourceName +
|
||||
'|' +
|
||||
yNegativeResourceName +
|
||||
'|' +
|
||||
zPositiveResourceName +
|
||||
'|' +
|
||||
zNegativeResourceName;
|
||||
const loadedThreeTexture = this._loadedThreeCubeTextures.get(key);
|
||||
if (loadedThreeTexture) {
|
||||
return loadedThreeTexture;
|
||||
}
|
||||
|
||||
const resource = this._getImageResource(resourceName);
|
||||
const cubeTexture = new THREE.CubeTexture();
|
||||
// Faces on X axis need to be swapped.
|
||||
cubeTexture.images[0] = this._getImageSource(xNegativeResourceName);
|
||||
cubeTexture.images[1] = this._getImageSource(xPositiveResourceName);
|
||||
// Faces on Y keep the same order.
|
||||
cubeTexture.images[2] = this._getImageSource(yPositiveResourceName);
|
||||
cubeTexture.images[3] = this._getImageSource(yNegativeResourceName);
|
||||
// Faces on Z keep the same order.
|
||||
cubeTexture.images[4] = this._getImageSource(zPositiveResourceName);
|
||||
cubeTexture.images[5] = this._getImageSource(zNegativeResourceName);
|
||||
// The images also need to be mirrored horizontally by users.
|
||||
|
||||
applyThreeTextureSettings(threeTexture, resource);
|
||||
this._loadedThreeTextures.put(resourceName, threeTexture);
|
||||
cubeTexture.magFilter = THREE.LinearFilter;
|
||||
cubeTexture.minFilter = THREE.LinearFilter;
|
||||
cubeTexture.colorSpace = THREE.SRGBColorSpace;
|
||||
cubeTexture.needsUpdate = true;
|
||||
|
||||
return threeTexture;
|
||||
const resource = this._getImageResource(xPositiveResourceName);
|
||||
applyThreeTextureSettings(cubeTexture, resource);
|
||||
this._loadedThreeCubeTextures.set(key, cubeTexture);
|
||||
this._loadedThreeCubeTextureKeysByResourceName.add(
|
||||
xPositiveResourceName,
|
||||
key
|
||||
);
|
||||
this._loadedThreeCubeTextureKeysByResourceName.add(
|
||||
xNegativeResourceName,
|
||||
key
|
||||
);
|
||||
this._loadedThreeCubeTextureKeysByResourceName.add(
|
||||
yPositiveResourceName,
|
||||
key
|
||||
);
|
||||
this._loadedThreeCubeTextureKeysByResourceName.add(
|
||||
yNegativeResourceName,
|
||||
key
|
||||
);
|
||||
this._loadedThreeCubeTextureKeysByResourceName.add(
|
||||
zPositiveResourceName,
|
||||
key
|
||||
);
|
||||
this._loadedThreeCubeTextureKeysByResourceName.add(
|
||||
zNegativeResourceName,
|
||||
key
|
||||
);
|
||||
|
||||
return cubeTexture;
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -482,6 +570,11 @@ namespace gdjs {
|
||||
for (const threeTexture of threeTextures) {
|
||||
threeTexture.dispose();
|
||||
}
|
||||
for (const cubeTexture of this._loadedThreeCubeTextures.values()) {
|
||||
cubeTexture.dispose();
|
||||
}
|
||||
this._loadedThreeCubeTextures.clear();
|
||||
this._loadedThreeCubeTextureKeysByResourceName.clear();
|
||||
|
||||
this._loadedThreeMaterials.disposeAll();
|
||||
|
||||
@@ -528,12 +621,51 @@ namespace gdjs {
|
||||
}
|
||||
|
||||
this._loadedThreeMaterials.dispose(resourceName);
|
||||
|
||||
const cubeTextureKeys =
|
||||
this._loadedThreeCubeTextureKeysByResourceName.getValuesFor(
|
||||
resourceName
|
||||
);
|
||||
if (cubeTextureKeys) {
|
||||
for (const cubeTextureKey of cubeTextureKeys) {
|
||||
const cubeTexture = this._loadedThreeCubeTextures.get(cubeTextureKey);
|
||||
if (cubeTexture) {
|
||||
cubeTexture.dispose();
|
||||
this._loadedThreeCubeTextures.delete(cubeTextureKey);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
class ArrayMap<K, V> {
|
||||
map = new Map<K, Array<V>>();
|
||||
|
||||
getValuesFor(key: K): Array<V> | undefined {
|
||||
return this.map.get(key);
|
||||
}
|
||||
|
||||
add(key: K, value: V): void {
|
||||
let values = this.map.get(key);
|
||||
if (!values) {
|
||||
values = [];
|
||||
this.map.set(key, values);
|
||||
}
|
||||
values.push(value);
|
||||
}
|
||||
|
||||
deleteValuesFor(key: K): void {
|
||||
this.map.delete(key);
|
||||
}
|
||||
|
||||
clear(): void {
|
||||
this.map.clear();
|
||||
}
|
||||
}
|
||||
|
||||
class ThreeMaterialCache {
|
||||
private _flaggedMaterials = new Map<string, THREE.Material>();
|
||||
private _materialFlaggedKeys = new Map<string, Array<string>>();
|
||||
private _materialFlaggedKeys = new ArrayMap<string, string>();
|
||||
|
||||
/**
|
||||
* Return the three.js material associated to the specified resource name
|
||||
@@ -584,12 +716,7 @@ namespace gdjs {
|
||||
forceBasicMaterial ? 1 : 0
|
||||
}|${vertexColors ? 1 : 0}`;
|
||||
this._flaggedMaterials.set(cacheKey, material);
|
||||
let flaggedKeys = this._materialFlaggedKeys.get(resourceName);
|
||||
if (!flaggedKeys) {
|
||||
flaggedKeys = [];
|
||||
this._materialFlaggedKeys.set(resourceName, flaggedKeys);
|
||||
}
|
||||
flaggedKeys.push(cacheKey);
|
||||
this._materialFlaggedKeys.add(resourceName, cacheKey);
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -598,7 +725,7 @@ namespace gdjs {
|
||||
* @param resourceName The name of the resource
|
||||
*/
|
||||
dispose(resourceName: string): void {
|
||||
const flaggedKeys = this._materialFlaggedKeys.get(resourceName);
|
||||
const flaggedKeys = this._materialFlaggedKeys.getValuesFor(resourceName);
|
||||
if (flaggedKeys) {
|
||||
for (const flaggedKey of flaggedKeys) {
|
||||
const threeMaterial = this._flaggedMaterials.get(flaggedKey);
|
||||
@@ -608,7 +735,7 @@ namespace gdjs {
|
||||
this._flaggedMaterials.delete(flaggedKey);
|
||||
}
|
||||
}
|
||||
this._materialFlaggedKeys.delete(resourceName);
|
||||
this._materialFlaggedKeys.deleteValuesFor(resourceName);
|
||||
}
|
||||
|
||||
/**
|
||||
|
@@ -18,6 +18,7 @@ namespace gdjs {
|
||||
rendered2DLayersCount: 0,
|
||||
rendered3DLayersCount: 0,
|
||||
};
|
||||
private _backgroundColor: THREE.Color | null = null;
|
||||
|
||||
constructor(
|
||||
runtimeScene: gdjs.RuntimeScene,
|
||||
@@ -209,15 +210,23 @@ namespace gdjs {
|
||||
);
|
||||
threeRenderer.resetState();
|
||||
if (this._runtimeScene.getClearCanvas()) threeRenderer.clear();
|
||||
threeScene.background = new THREE.Color(
|
||||
if (!this._backgroundColor) {
|
||||
this._backgroundColor = new THREE.Color();
|
||||
}
|
||||
this._backgroundColor.set(
|
||||
this._runtimeScene.getBackgroundColor()
|
||||
);
|
||||
if (!threeScene.background) {
|
||||
threeScene.background = this._backgroundColor;
|
||||
}
|
||||
|
||||
isFirstRender = false;
|
||||
} else {
|
||||
// It's important to set the background to null, as maybe the first rendered
|
||||
// layer has changed and so the Three.js scene background must be reset.
|
||||
threeScene.background = null;
|
||||
if (threeScene.background === this._backgroundColor) {
|
||||
threeScene.background = null;
|
||||
}
|
||||
}
|
||||
|
||||
// Clear the depth as each layer is independent and display on top of the previous one,
|
||||
|
@@ -77,7 +77,9 @@ namespace gdjs {
|
||||
return false;
|
||||
}
|
||||
|
||||
getNetworkSyncData(): BehaviorNetworkSyncData {
|
||||
getNetworkSyncData(
|
||||
syncOptions: GetNetworkSyncDataOptions
|
||||
): BehaviorNetworkSyncData {
|
||||
// To be redefined by behaviors that need to synchronize properties
|
||||
// while calling super() to get the common properties.
|
||||
return {
|
||||
@@ -90,7 +92,10 @@ namespace gdjs {
|
||||
* Update the behavior properties using the provided data.
|
||||
* @param networkSyncData The new properties of the behavior.
|
||||
*/
|
||||
updateFromNetworkSyncData(networkSyncData: BehaviorNetworkSyncData): void {
|
||||
updateFromNetworkSyncData(
|
||||
networkSyncData: BehaviorNetworkSyncData,
|
||||
options: UpdateFromNetworkSyncDataOptions
|
||||
): void {
|
||||
// Must be redefined by behaviors that need to synchronize properties
|
||||
// while calling super() to get the common properties.
|
||||
if (networkSyncData.act !== this._activated) {
|
||||
|
@@ -1384,21 +1384,29 @@ namespace gdjs {
|
||||
syncOptions: GetNetworkSyncDataOptions
|
||||
): GameNetworkSyncData | null {
|
||||
const syncData: GameNetworkSyncData = {
|
||||
var: this._variables.getNetworkSyncData(syncOptions),
|
||||
var:
|
||||
syncOptions.syncGameVariables === false
|
||||
? undefined
|
||||
: this._variables.getNetworkSyncData(syncOptions),
|
||||
sm: syncOptions.syncSounds
|
||||
? this.getSoundManager().getNetworkSyncData()
|
||||
: undefined,
|
||||
ss: this._sceneStack.getNetworkSyncData(syncOptions) || undefined,
|
||||
};
|
||||
|
||||
const extensionsVariablesSyncData = {};
|
||||
this._variablesByExtensionName.forEach((variables, extensionName) => {
|
||||
const extensionVariablesSyncData =
|
||||
variables.getNetworkSyncData(syncOptions);
|
||||
// If there is no variables to sync, don't include the extension in the sync data.
|
||||
if (extensionVariablesSyncData.length) {
|
||||
extensionsVariablesSyncData[extensionName] =
|
||||
extensionVariablesSyncData;
|
||||
}
|
||||
});
|
||||
syncData.extVar = extensionsVariablesSyncData;
|
||||
if (syncOptions.syncGameVariables !== false) {
|
||||
const extensionsVariablesSyncData = {};
|
||||
this._variablesByExtensionName.forEach((variables, extensionName) => {
|
||||
const extensionVariablesSyncData =
|
||||
variables.getNetworkSyncData(syncOptions);
|
||||
// If there is no variables to sync, don't include the extension in the sync data.
|
||||
if (extensionVariablesSyncData.length) {
|
||||
extensionsVariablesSyncData[extensionName] =
|
||||
extensionVariablesSyncData;
|
||||
}
|
||||
});
|
||||
syncData.extVar = extensionsVariablesSyncData;
|
||||
}
|
||||
|
||||
if (
|
||||
(!syncData.var || syncData.var.length === 0) &&
|
||||
@@ -1412,10 +1420,16 @@ namespace gdjs {
|
||||
return syncData;
|
||||
}
|
||||
|
||||
updateFromNetworkSyncData(syncData: GameNetworkSyncData) {
|
||||
updateFromNetworkSyncData(
|
||||
syncData: GameNetworkSyncData,
|
||||
options: UpdateFromNetworkSyncDataOptions
|
||||
) {
|
||||
this._throwIfDisposed();
|
||||
if (syncData.var) {
|
||||
this._variables.updateFromNetworkSyncData(syncData.var);
|
||||
this._variables.updateFromNetworkSyncData(syncData.var, options);
|
||||
}
|
||||
if (syncData.sm) {
|
||||
this.getSoundManager().updateFromNetworkSyncData(syncData.sm);
|
||||
}
|
||||
if (syncData.ss) {
|
||||
this._sceneStack.updateFromNetworkSyncData(syncData.ss);
|
||||
@@ -1430,7 +1444,8 @@ namespace gdjs {
|
||||
this.getVariablesForExtension(extensionName);
|
||||
if (extensionVariables) {
|
||||
extensionVariables.updateFromNetworkSyncData(
|
||||
extensionVariablesData
|
||||
extensionVariablesData,
|
||||
options
|
||||
);
|
||||
}
|
||||
}
|
||||
|
@@ -422,7 +422,8 @@ namespace gdjs {
|
||||
updatePreRender(instanceContainer: gdjs.RuntimeInstanceContainer): void {}
|
||||
|
||||
/**
|
||||
* Called when the object is created from an initial instance at the startup of the scene.<br>
|
||||
* Called when the object is created from an initial instance at the startup of the scene.
|
||||
*
|
||||
* Note that common properties (position, angle, z order...) have already been setup.
|
||||
*
|
||||
* @param initialInstanceData The data of the initial instance.
|
||||
@@ -452,17 +453,17 @@ namespace gdjs {
|
||||
* This can be redefined by objects to send more information.
|
||||
* @returns The full network sync data.
|
||||
*/
|
||||
getNetworkSyncData(): ObjectNetworkSyncData {
|
||||
getNetworkSyncData(
|
||||
syncOptions: GetNetworkSyncDataOptions
|
||||
): ObjectNetworkSyncData {
|
||||
const behaviorNetworkSyncData = {};
|
||||
this._behaviors.forEach((behavior) => {
|
||||
if (!behavior.isSyncedOverNetwork()) {
|
||||
if (!behavior.isSyncedOverNetwork() && !syncOptions.syncAllBehaviors) {
|
||||
return;
|
||||
}
|
||||
|
||||
const networkSyncData = behavior.getNetworkSyncData();
|
||||
if (networkSyncData) {
|
||||
behaviorNetworkSyncData[behavior.getName()] = networkSyncData;
|
||||
}
|
||||
const networkSyncData = behavior.getNetworkSyncData(syncOptions);
|
||||
behaviorNetworkSyncData[behavior.getName()] = networkSyncData;
|
||||
});
|
||||
|
||||
const variablesNetworkSyncData = this._variables.getNetworkSyncData({
|
||||
@@ -481,7 +482,7 @@ namespace gdjs {
|
||||
this._timers.items[timerName].getNetworkSyncData();
|
||||
}
|
||||
|
||||
return {
|
||||
const networkSyncData: ObjectNetworkSyncData = {
|
||||
x: this.x,
|
||||
y: this.y,
|
||||
w: this.getWidth(),
|
||||
@@ -498,6 +499,19 @@ namespace gdjs {
|
||||
eff: effectsNetworkSyncData,
|
||||
tim: timersNetworkSyncData,
|
||||
};
|
||||
|
||||
if (syncOptions.syncObjectIdentifiers) {
|
||||
networkSyncData.n = this.name;
|
||||
if (!this.networkId) {
|
||||
// If this is the first time the object is synced
|
||||
// with identifier, then generate a networkId,
|
||||
// so it can be re-used for future syncs.
|
||||
this.networkId = gdjs.makeUuid().substring(0, 8);
|
||||
}
|
||||
networkSyncData.networkId = this.networkId;
|
||||
}
|
||||
|
||||
return networkSyncData;
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -507,7 +521,10 @@ namespace gdjs {
|
||||
* @param networkSyncData The new data for the object.
|
||||
* @returns true if the object was updated, false if it could not (i.e: network sync is not supported).
|
||||
*/
|
||||
updateFromNetworkSyncData(networkSyncData: ObjectNetworkSyncData) {
|
||||
updateFromNetworkSyncData(
|
||||
networkSyncData: ObjectNetworkSyncData,
|
||||
options: UpdateFromNetworkSyncDataOptions
|
||||
) {
|
||||
if (networkSyncData.x !== undefined) {
|
||||
this.setX(networkSyncData.x);
|
||||
}
|
||||
@@ -562,20 +579,21 @@ namespace gdjs {
|
||||
this._permanentForceY = networkSyncData.pfy;
|
||||
}
|
||||
|
||||
// If variables are synchronized, update them first,
|
||||
// as behaviors may depend on them. (Like tweens)
|
||||
if (networkSyncData.var) {
|
||||
this._variables.updateFromNetworkSyncData(networkSyncData.var, options);
|
||||
}
|
||||
|
||||
// Loop through all behaviors and update them.
|
||||
for (const behaviorName in networkSyncData.beh) {
|
||||
const behaviorNetworkSyncData = networkSyncData.beh[behaviorName];
|
||||
const behavior = this.getBehavior(behaviorName);
|
||||
if (behavior) {
|
||||
behavior.updateFromNetworkSyncData(behaviorNetworkSyncData);
|
||||
behavior.updateFromNetworkSyncData(behaviorNetworkSyncData, options);
|
||||
}
|
||||
}
|
||||
|
||||
// If variables are synchronized, update them.
|
||||
if (networkSyncData.var) {
|
||||
this._variables.updateFromNetworkSyncData(networkSyncData.var);
|
||||
}
|
||||
|
||||
// If effects are synchronized, update them.
|
||||
if (networkSyncData.eff) {
|
||||
// Loop through all effects and update them.
|
||||
@@ -589,16 +607,19 @@ namespace gdjs {
|
||||
}
|
||||
|
||||
// If timers are synchronized, update them.
|
||||
// TODO: If a timer is removed, also remove it from the object?
|
||||
if (networkSyncData.tim) {
|
||||
this._timers.clear();
|
||||
for (const timerName in networkSyncData.tim) {
|
||||
const timerNetworkSyncData = networkSyncData.tim[timerName];
|
||||
const timer = this._timers.get(timerName);
|
||||
if (timer) {
|
||||
timer.updateFromNetworkSyncData(timerNetworkSyncData);
|
||||
}
|
||||
const timerData = networkSyncData.tim[timerName];
|
||||
const newTimer = new gdjs.Timer(timerData.name);
|
||||
newTimer.updateFromNetworkSyncData(timerData);
|
||||
this._timers.put(timerName, newTimer);
|
||||
}
|
||||
}
|
||||
|
||||
if (networkSyncData.networkId !== undefined) {
|
||||
this.networkId = networkSyncData.networkId;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -677,7 +698,7 @@ namespace gdjs {
|
||||
}
|
||||
|
||||
/**
|
||||
* @return The internal object for a 3D rendering (PIXI.DisplayObject...)
|
||||
* @return The internal object for a 3D rendering (THREE.Object3D...)
|
||||
*/
|
||||
get3DRendererObject(): THREE.Object3D | null | undefined {
|
||||
return undefined;
|
||||
@@ -701,8 +722,10 @@ namespace gdjs {
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the unique identifier of the object.<br>
|
||||
* The identifier is set by the runtimeScene owning the object.<br>
|
||||
* Get the unique identifier of the object.
|
||||
*
|
||||
* The identifier is set by the runtimeScene owning the object.
|
||||
*
|
||||
* You can also use the id property (this._object.id) for increased efficiency instead of
|
||||
* calling this method.
|
||||
*
|
||||
@@ -712,6 +735,18 @@ namespace gdjs {
|
||||
return this.id;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the network ID of the object.
|
||||
*
|
||||
* The network ID is used to identify the object in a networked game.
|
||||
* Or, for Save/Load purposes.
|
||||
*
|
||||
* @return The network ID of the object.
|
||||
*/
|
||||
getNetworkId(): string | null {
|
||||
return this.networkId;
|
||||
}
|
||||
|
||||
/**
|
||||
* Set the position of the object.
|
||||
*
|
||||
@@ -807,6 +842,12 @@ namespace gdjs {
|
||||
return this.getY();
|
||||
}
|
||||
|
||||
/**
|
||||
* Rotate the object towards another object position.
|
||||
* @param x The target x position
|
||||
* @param y The target y position
|
||||
* @param speed The rotation speed. 0 for an immediate rotation to the target position.
|
||||
*/
|
||||
rotateTowardPosition(x: float, y: float, speed: float): void {
|
||||
this.rotateTowardAngle(
|
||||
gdjs.toDegrees(
|
||||
@@ -820,8 +861,24 @@ namespace gdjs {
|
||||
}
|
||||
|
||||
/**
|
||||
* @param angle The targeted direction angle.
|
||||
* @param speed The rotation speed.
|
||||
* Rotate the object towards another object position (aiming at the center of the object).
|
||||
* @param target The target object
|
||||
* @param speed The rotation speed. 0 for an immediate rotation to the target object.
|
||||
*/
|
||||
rotateTowardObject(target: gdjs.RuntimeObject | null, speed: float): void {
|
||||
if (target === null) {
|
||||
return;
|
||||
}
|
||||
this.rotateTowardPosition(
|
||||
target.getDrawableX() + target.getCenterX(),
|
||||
target.getDrawableY() + target.getCenterY(),
|
||||
speed
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param angle The targeted angle.
|
||||
* @param speed The rotation speed. 0 for an immediate rotation to the target angle.
|
||||
*/
|
||||
rotateTowardAngle(angle: float, speed: float): void {
|
||||
if (speed === 0) {
|
||||
@@ -1472,7 +1529,8 @@ namespace gdjs {
|
||||
|
||||
//Forces :
|
||||
/**
|
||||
* Get a force from the garbage, or create a new force is garbage is empty.<br>
|
||||
* Get a force from the garbage, or create a new force is garbage is empty.
|
||||
*
|
||||
* To be used each time a force is created so as to avoid temporaries objects.
|
||||
*
|
||||
* @param x The x coordinates of the force
|
||||
@@ -1557,7 +1615,8 @@ namespace gdjs {
|
||||
}
|
||||
|
||||
/**
|
||||
* Add a force oriented toward another object.<br>
|
||||
* Add a force oriented toward another object.
|
||||
*
|
||||
* (Shortcut for addForceTowardPosition)
|
||||
* @param object The target object
|
||||
* @param len The force length, in pixels.
|
||||
|
@@ -12,7 +12,13 @@ namespace gdjs {
|
||||
*/
|
||||
export class RuntimeScene extends gdjs.RuntimeInstanceContainer {
|
||||
_eventsFunction: null | ((runtimeScene: RuntimeScene) => void) = null;
|
||||
|
||||
_idToCallbackMap: null | Map<
|
||||
string,
|
||||
(
|
||||
runtimeScene: gdjs.RuntimeScene,
|
||||
asyncObjectsList: gdjs.LongLivedObjectsList
|
||||
) => void
|
||||
> = null;
|
||||
_renderer: RuntimeSceneRenderer;
|
||||
_debuggerRenderer: gdjs.DebuggerRenderer;
|
||||
_variables: gdjs.VariablesContainer;
|
||||
@@ -125,7 +131,13 @@ namespace gdjs {
|
||||
* @param sceneAndExtensionsData An object containing the scene data.
|
||||
* @see gdjs.RuntimeGame#getSceneAndExtensionsData
|
||||
*/
|
||||
loadFromScene(sceneAndExtensionsData: SceneAndExtensionsData | null) {
|
||||
loadFromScene(
|
||||
sceneAndExtensionsData: SceneAndExtensionsData | null,
|
||||
options?: {
|
||||
excludedObjectNames?: Set<string>;
|
||||
skipStoppingSoundsOnStartup?: boolean;
|
||||
}
|
||||
) {
|
||||
if (!sceneAndExtensionsData) {
|
||||
logger.error('loadFromScene was called without a scene');
|
||||
return;
|
||||
@@ -183,14 +195,17 @@ namespace gdjs {
|
||||
this.registerObject(sceneData.objects[i]);
|
||||
}
|
||||
|
||||
//Create initial instances of objects
|
||||
// Create initial instances of objects.
|
||||
this.createObjectsFrom(
|
||||
sceneData.instances,
|
||||
0,
|
||||
0,
|
||||
0,
|
||||
/*trackByPersistentUuid=*/
|
||||
true
|
||||
true,
|
||||
{
|
||||
excludedObjectNames: options?.excludedObjectNames,
|
||||
}
|
||||
);
|
||||
|
||||
// Set up the default z order (for objects created from events)
|
||||
@@ -209,7 +224,11 @@ namespace gdjs {
|
||||
for (let i = 0; i < gdjs.callbacksRuntimeSceneLoaded.length; ++i) {
|
||||
gdjs.callbacksRuntimeSceneLoaded[i](this);
|
||||
}
|
||||
if (sceneData.stopSoundsOnStartup && this._runtimeGame) {
|
||||
if (
|
||||
sceneData.stopSoundsOnStartup &&
|
||||
(!options || !options.skipStoppingSoundsOnStartup) &&
|
||||
this._runtimeGame
|
||||
) {
|
||||
this._runtimeGame.getSoundManager().clearAll();
|
||||
}
|
||||
this._isLoaded = true;
|
||||
@@ -336,6 +355,8 @@ namespace gdjs {
|
||||
const module = gdjs[sceneData.mangledName + 'Code'];
|
||||
if (module && module.func) {
|
||||
this._eventsFunction = module.func;
|
||||
this._idToCallbackMap =
|
||||
gdjs[sceneData.mangledName + 'Code'].idToCallbackMap;
|
||||
} else {
|
||||
setupWarningLogger.warn(
|
||||
'No function found for running logic of scene ' + this._name
|
||||
@@ -830,27 +851,69 @@ namespace gdjs {
|
||||
if (
|
||||
syncedPlayerNumber !== undefined &&
|
||||
syncedPlayerNumber !== 1 &&
|
||||
(!this.networkId ||
|
||||
(variablesNetworkSyncData.length === 0 &&
|
||||
!Object.keys(extensionsVariablesSyncData).length))
|
||||
!this.networkId
|
||||
) {
|
||||
// If we are getting sync data for a specific player,
|
||||
// and they are not the host, there is no sync data to send if:
|
||||
// - The scene has no networkId (it's either not a multiplayer scene or the scene is not yet networked).
|
||||
// - There are no variables to sync in the scene or extensions.
|
||||
// and they are not the host, there is no sync data to send if
|
||||
// the scene has no networkId (it's either not a multiplayer scene or the scene is not yet networked).
|
||||
return null;
|
||||
}
|
||||
|
||||
return {
|
||||
const networkSyncData: LayoutNetworkSyncData = {
|
||||
var: variablesNetworkSyncData,
|
||||
extVar: extensionsVariablesSyncData,
|
||||
id: this.getOrCreateNetworkId(),
|
||||
};
|
||||
if (syncOptions.syncSceneVisualProps) {
|
||||
networkSyncData.color = this._backgroundColor;
|
||||
}
|
||||
if (syncOptions.syncLayers) {
|
||||
const layersSyncData = {};
|
||||
for (const layerName in this._layers.items) {
|
||||
layersSyncData[layerName] =
|
||||
this._layers.items[layerName].getNetworkSyncData();
|
||||
}
|
||||
networkSyncData.layers = layersSyncData;
|
||||
}
|
||||
if (syncOptions.syncSceneTimers) {
|
||||
networkSyncData.time = this._timeManager.getNetworkSyncData();
|
||||
}
|
||||
if (syncOptions.syncOnceTriggers) {
|
||||
networkSyncData.once = this._onceTriggers.getNetworkSyncData();
|
||||
}
|
||||
|
||||
gdjs.callbacksRuntimeSceneGetSyncData.forEach((callback) => {
|
||||
callback(this, networkSyncData, syncOptions);
|
||||
});
|
||||
|
||||
if (syncOptions.syncAsyncTasks) {
|
||||
networkSyncData.async =
|
||||
this._asyncTasksManager.getNetworkSyncData(syncOptions);
|
||||
}
|
||||
|
||||
return networkSyncData;
|
||||
}
|
||||
|
||||
updateFromNetworkSyncData(syncData: LayoutNetworkSyncData) {
|
||||
updateFromNetworkSyncData(
|
||||
syncData: LayoutNetworkSyncData,
|
||||
options: UpdateFromNetworkSyncDataOptions
|
||||
) {
|
||||
if (syncData.color !== undefined) {
|
||||
this._backgroundColor = syncData.color;
|
||||
}
|
||||
if (syncData.layers) {
|
||||
for (const layerName in syncData.layers) {
|
||||
const layerData = syncData.layers[layerName];
|
||||
if (this.hasLayer(layerName)) {
|
||||
const layer = this.getLayer(layerName);
|
||||
layer.updateFromNetworkSyncData(layerData);
|
||||
}
|
||||
}
|
||||
}
|
||||
// Update variables before anything else, as they might be used
|
||||
// in other sync data (for instance in tweens).
|
||||
if (syncData.var) {
|
||||
this._variables.updateFromNetworkSyncData(syncData.var);
|
||||
this._variables.updateFromNetworkSyncData(syncData.var, options);
|
||||
}
|
||||
if (syncData.extVar) {
|
||||
for (const extensionName in syncData.extVar) {
|
||||
@@ -862,11 +925,32 @@ namespace gdjs {
|
||||
this._variablesByExtensionName.get(extensionName);
|
||||
if (extensionVariables) {
|
||||
extensionVariables.updateFromNetworkSyncData(
|
||||
extensionVariablesData
|
||||
extensionVariablesData,
|
||||
options
|
||||
);
|
||||
}
|
||||
}
|
||||
}
|
||||
if (syncData.time) {
|
||||
this._timeManager.updateFromNetworkSyncData(syncData.time);
|
||||
}
|
||||
if (syncData.once) {
|
||||
this._onceTriggers.updateNetworkSyncData(syncData.once);
|
||||
}
|
||||
|
||||
gdjs.callbacksRuntimeSceneUpdateFromSyncData.forEach((callback) => {
|
||||
callback(this, syncData, options);
|
||||
});
|
||||
|
||||
// Sync Async last, as it might depend on other data.
|
||||
if (syncData.async && this._idToCallbackMap) {
|
||||
this._asyncTasksManager.updateFromNetworkSyncData(
|
||||
syncData.async,
|
||||
this._idToCallbackMap,
|
||||
this,
|
||||
options
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
getOrCreateNetworkId(): string {
|
||||
|
@@ -1,6 +1,21 @@
|
||||
namespace gdjs {
|
||||
const logger = new gdjs.Logger('Scene stack');
|
||||
const debugLogger = new gdjs.Logger('Multiplayer - Debug');
|
||||
const debugLogger = new gdjs.Logger('Scene stack - Debug');
|
||||
// Comment this to see message logs and ease debugging:
|
||||
gdjs.Logger.getDefaultConsoleLoggerOutput().discardGroup(
|
||||
'Scene stack - Debug'
|
||||
);
|
||||
|
||||
interface PushSceneOptions {
|
||||
sceneName: string;
|
||||
externalLayoutName?: string;
|
||||
getExcludedObjectNames?: (runtimeScene: RuntimeScene) => Set<string>;
|
||||
skipStoppingSoundsOnStartup?: boolean;
|
||||
}
|
||||
|
||||
interface ReplaceSceneOptions extends PushSceneOptions {
|
||||
clear: boolean;
|
||||
}
|
||||
|
||||
/**
|
||||
* Hold the stack of scenes ({@link gdjs.RuntimeScene}) being played.
|
||||
@@ -121,15 +136,32 @@ namespace gdjs {
|
||||
}
|
||||
|
||||
/**
|
||||
* Pause the scene currently being played and start the new scene that is specified.
|
||||
* If `externalLayoutName` is set, also instantiate the objects from this external layout.
|
||||
* Pause the scene currently being played and start the new scene that is specified in `options.sceneName`.
|
||||
* If `options.externalLayoutName` is set, also instantiate the objects from this external layout.
|
||||
*
|
||||
* @param options Contains the scene name and optional external layout name to instantiate.
|
||||
* @param deprecatedExternalLayoutName Deprecated, use `options.externalLayoutName` instead.
|
||||
*/
|
||||
push(
|
||||
newSceneName: string,
|
||||
externalLayoutName?: string
|
||||
options: PushSceneOptions | string,
|
||||
deprecatedExternalLayoutName?: string
|
||||
): gdjs.RuntimeScene | null {
|
||||
this._throwIfDisposed();
|
||||
|
||||
const sceneName =
|
||||
typeof options === 'string' ? options : options.sceneName;
|
||||
const getExcludedObjectNames =
|
||||
typeof options === 'string'
|
||||
? undefined
|
||||
: options.getExcludedObjectNames;
|
||||
const skipStoppingSoundsOnStartup =
|
||||
typeof options === 'string'
|
||||
? false
|
||||
: options.skipStoppingSoundsOnStartup;
|
||||
const externalLayoutName =
|
||||
deprecatedExternalLayoutName ||
|
||||
(typeof options === 'string' ? undefined : options.externalLayoutName);
|
||||
|
||||
// Tell the scene it's being paused
|
||||
const currentScene = this._stack[this._stack.length - 1];
|
||||
if (currentScene) {
|
||||
@@ -138,36 +170,50 @@ namespace gdjs {
|
||||
|
||||
// Avoid a risk of displaying an intermediate loading screen
|
||||
// during 1 frame.
|
||||
if (this._runtimeGame.areSceneAssetsReady(newSceneName)) {
|
||||
return this._loadNewScene(newSceneName, externalLayoutName);
|
||||
if (this._runtimeGame.areSceneAssetsReady(sceneName)) {
|
||||
return this._loadNewScene({
|
||||
sceneName,
|
||||
externalLayoutName,
|
||||
getExcludedObjectNames,
|
||||
skipStoppingSoundsOnStartup,
|
||||
});
|
||||
}
|
||||
|
||||
this._isNextLayoutLoading = true;
|
||||
this._runtimeGame.loadSceneAssets(newSceneName).then(() => {
|
||||
this._loadNewScene(newSceneName);
|
||||
this._runtimeGame.loadSceneAssets(sceneName).then(() => {
|
||||
this._loadNewScene({
|
||||
sceneName,
|
||||
externalLayoutName,
|
||||
getExcludedObjectNames,
|
||||
skipStoppingSoundsOnStartup,
|
||||
});
|
||||
this._isNextLayoutLoading = false;
|
||||
});
|
||||
|
||||
return null;
|
||||
}
|
||||
|
||||
private _loadNewScene(
|
||||
newSceneName: string,
|
||||
externalLayoutName?: string
|
||||
): gdjs.RuntimeScene {
|
||||
private _loadNewScene(options: PushSceneOptions): gdjs.RuntimeScene {
|
||||
this._throwIfDisposed();
|
||||
|
||||
// Load the new one
|
||||
const newScene = new gdjs.RuntimeScene(this._runtimeGame);
|
||||
newScene.loadFromScene(
|
||||
this._runtimeGame.getSceneAndExtensionsData(newSceneName)
|
||||
this._runtimeGame.getSceneAndExtensionsData(options.sceneName),
|
||||
{
|
||||
excludedObjectNames: options.getExcludedObjectNames
|
||||
? options.getExcludedObjectNames(newScene)
|
||||
: undefined,
|
||||
skipStoppingSoundsOnStartup: options.skipStoppingSoundsOnStartup,
|
||||
}
|
||||
);
|
||||
this._wasFirstSceneLoaded = true;
|
||||
|
||||
// Optionally create the objects from an external layout.
|
||||
if (externalLayoutName) {
|
||||
const externalLayoutData =
|
||||
this._runtimeGame.getExternalLayoutData(externalLayoutName);
|
||||
if (options.externalLayoutName) {
|
||||
const externalLayoutData = this._runtimeGame.getExternalLayoutData(
|
||||
options.externalLayoutName
|
||||
);
|
||||
if (externalLayoutData) {
|
||||
newScene.createObjectsFrom(
|
||||
externalLayoutData.instances,
|
||||
@@ -184,10 +230,21 @@ namespace gdjs {
|
||||
}
|
||||
|
||||
/**
|
||||
* Start the specified scene, replacing the one currently being played.
|
||||
* If `clear` is set to true, all running scenes are also removed from the stack of scenes.
|
||||
* Start the scene in `options.sceneName`, replacing the one currently being played.
|
||||
* If `options.clear` is set to true, all running scenes are also removed from the stack of scenes.
|
||||
*
|
||||
* @param options Contains the scene name and optional external layout name to instantiate.
|
||||
* @param deprecatedClear Deprecated, use `options.clear` instead.
|
||||
*/
|
||||
replace(newSceneName: string, clear?: boolean): gdjs.RuntimeScene | null {
|
||||
replace(
|
||||
options: ReplaceSceneOptions | string,
|
||||
deprecatedClear?: boolean
|
||||
): gdjs.RuntimeScene | null {
|
||||
const clear =
|
||||
deprecatedClear || typeof options === 'string' ? false : options.clear;
|
||||
const newSceneName =
|
||||
typeof options === 'string' ? options : options.sceneName;
|
||||
|
||||
this._throwIfDisposed();
|
||||
if (!!clear) {
|
||||
// Unload all the scenes
|
||||
@@ -206,7 +263,7 @@ namespace gdjs {
|
||||
}
|
||||
}
|
||||
}
|
||||
return this.push(newSceneName);
|
||||
return this.push(options);
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -227,6 +284,11 @@ namespace gdjs {
|
||||
return this._wasFirstSceneLoaded;
|
||||
}
|
||||
|
||||
getAllScenes(): Array<gdjs.RuntimeScene> {
|
||||
this._throwIfDisposed();
|
||||
return this._stack;
|
||||
}
|
||||
|
||||
getAllSceneNames(): Array<string> {
|
||||
this._throwIfDisposed();
|
||||
return this._stack.map((scene) => scene.getName());
|
||||
@@ -267,7 +329,9 @@ namespace gdjs {
|
||||
this._sceneStackSyncDataToApply = sceneStackSyncData;
|
||||
}
|
||||
|
||||
applyUpdateFromNetworkSyncDataIfAny(): boolean {
|
||||
applyUpdateFromNetworkSyncDataIfAny(
|
||||
options?: UpdateFromNetworkSyncDataOptions
|
||||
): boolean {
|
||||
this._throwIfDisposed();
|
||||
const sceneStackSyncData = this._sceneStackSyncDataToApply;
|
||||
let hasMadeChangeToStack = false;
|
||||
@@ -275,6 +339,32 @@ namespace gdjs {
|
||||
|
||||
this._sceneStackSyncDataToApply = null;
|
||||
|
||||
const getExcludedObjectNames = options && options.getExcludedObjectNames;
|
||||
const skipStoppingSoundsOnStartup =
|
||||
!!options && !!options.preventSoundsStoppingOnStartup;
|
||||
|
||||
if (options && options.clearSceneStack) {
|
||||
while (this._stack.length !== 0) {
|
||||
let scene = this._stack.pop();
|
||||
if (scene) {
|
||||
scene.unloadScene();
|
||||
}
|
||||
}
|
||||
for (let i = 0; i < sceneStackSyncData.length; ++i) {
|
||||
const sceneSyncData = sceneStackSyncData[i];
|
||||
const newScene = this.push({
|
||||
sceneName: sceneSyncData.name,
|
||||
getExcludedObjectNames,
|
||||
skipStoppingSoundsOnStartup,
|
||||
});
|
||||
if (newScene) {
|
||||
newScene.networkId = sceneSyncData.networkId;
|
||||
}
|
||||
}
|
||||
hasMadeChangeToStack = true;
|
||||
return hasMadeChangeToStack;
|
||||
}
|
||||
|
||||
// If this method is called, we are a client.
|
||||
// We trust the host to be the source of truth for the scene stack.
|
||||
// So we loop through the scenes in the stack given by the host and either:
|
||||
@@ -284,12 +374,17 @@ namespace gdjs {
|
||||
for (let i = 0; i < sceneStackSyncData.length; ++i) {
|
||||
const sceneSyncData = sceneStackSyncData[i];
|
||||
const sceneAtThisPositionInOurStack = this._stack[i];
|
||||
|
||||
if (!sceneAtThisPositionInOurStack) {
|
||||
debugLogger.info(
|
||||
`Scene at position ${i} with name ${sceneSyncData.name} is missing from the stack, adding it.`
|
||||
);
|
||||
// We have fewer scenes in the stack than the host, let's add the scene.
|
||||
const newScene = this.push(sceneSyncData.name);
|
||||
// By definition, there is nothing to clear because we're already at the top of the stack.
|
||||
const newScene = this.push({
|
||||
sceneName: sceneSyncData.name,
|
||||
getExcludedObjectNames,
|
||||
});
|
||||
if (newScene) {
|
||||
newScene.networkId = sceneSyncData.networkId;
|
||||
}
|
||||
@@ -302,14 +397,23 @@ namespace gdjs {
|
||||
debugLogger.info(
|
||||
`Scene at position ${i} and name ${sceneAtThisPositionInOurStack.getName()} is not the same as the expected ${
|
||||
sceneSyncData.name
|
||||
}, replacing.`
|
||||
}, replacing it.`
|
||||
);
|
||||
// The scene does not correspond to the scene at this position in our stack
|
||||
// Let's unload everything after this position to recreate the stack.
|
||||
const newScene = this.replace(
|
||||
sceneSyncData.name,
|
||||
true // Clear the stack
|
||||
);
|
||||
// Let's unload everything after this position to reconstruct the stack.
|
||||
if (this._stack.length > i + 1) {
|
||||
debugLogger.info(
|
||||
`Unloading ${this._stack.length - (i + 1)} scenes after position ${i}.`
|
||||
);
|
||||
this.pop(this._stack.length - (i + 1));
|
||||
}
|
||||
|
||||
const newScene = this.replace({
|
||||
sceneName: sceneSyncData.name,
|
||||
clear: false,
|
||||
getExcludedObjectNames,
|
||||
});
|
||||
|
||||
if (newScene) {
|
||||
newScene.networkId = sceneSyncData.networkId;
|
||||
}
|
||||
@@ -343,16 +447,27 @@ namespace gdjs {
|
||||
debugLogger.info(
|
||||
`Scene at position ${i} and name ${sceneAtThisPositionInOurStack.getName()} has a different networkId ${
|
||||
sceneAtThisPositionInOurStack.networkId
|
||||
} than the expected ${sceneSyncData.networkId}, replacing.`
|
||||
} than the expected ${sceneSyncData.networkId}, replacing it.`
|
||||
);
|
||||
// The scene is in the stack but has a different networkId
|
||||
// This can happen if the host has restarted the scene
|
||||
// We can't just update the networkId of the scene in the stack
|
||||
// We need to replace it with a new scene
|
||||
const newScene = this.replace(
|
||||
sceneSyncData.name,
|
||||
false // Don't clear the stack
|
||||
);
|
||||
// We need to replace it with a new scene.
|
||||
|
||||
// Like for the case where it's a totally different scene,
|
||||
// we need to unload everything after this position to reconstruct the stack.
|
||||
if (this._stack.length > i + 1) {
|
||||
debugLogger.info(
|
||||
`Unloading ${this._stack.length - (i + 1)} scenes after position ${i}.`
|
||||
);
|
||||
this.pop(this._stack.length - (i + 1));
|
||||
}
|
||||
|
||||
const newScene = this.replace({
|
||||
sceneName: sceneSyncData.name,
|
||||
clear: false,
|
||||
getExcludedObjectNames,
|
||||
});
|
||||
if (newScene) {
|
||||
newScene.networkId = sceneSyncData.networkId;
|
||||
}
|
||||
|
@@ -115,9 +115,11 @@ namespace gdjs {
|
||||
return true;
|
||||
}
|
||||
|
||||
getNetworkSyncData(): SpriteNetworkSyncData {
|
||||
getNetworkSyncData(
|
||||
syncOptions: GetNetworkSyncDataOptions
|
||||
): SpriteNetworkSyncData {
|
||||
return {
|
||||
...super.getNetworkSyncData(),
|
||||
...super.getNetworkSyncData(syncOptions),
|
||||
anim: this._animator.getNetworkSyncData(),
|
||||
ifx: this.isFlippedX(),
|
||||
ify: this.isFlippedY(),
|
||||
@@ -128,8 +130,11 @@ namespace gdjs {
|
||||
};
|
||||
}
|
||||
|
||||
updateFromNetworkSyncData(newNetworkSyncData: SpriteNetworkSyncData) {
|
||||
super.updateFromNetworkSyncData(newNetworkSyncData);
|
||||
updateFromNetworkSyncData(
|
||||
newNetworkSyncData: SpriteNetworkSyncData,
|
||||
options: UpdateFromNetworkSyncDataOptions
|
||||
) {
|
||||
super.updateFromNetworkSyncData(newNetworkSyncData, options);
|
||||
if (newNetworkSyncData.ifx !== undefined) {
|
||||
this.flipX(newNetworkSyncData.ifx);
|
||||
}
|
||||
@@ -948,14 +953,7 @@ namespace gdjs {
|
||||
* @deprecated
|
||||
*/
|
||||
turnTowardObject(obj: gdjs.RuntimeObject | null) {
|
||||
if (obj === null) {
|
||||
return;
|
||||
}
|
||||
this.rotateTowardPosition(
|
||||
obj.getDrawableX() + obj.getCenterX(),
|
||||
obj.getDrawableY() + obj.getCenterY(),
|
||||
0
|
||||
);
|
||||
return this.rotateTowardObject(obj, 0);
|
||||
}
|
||||
}
|
||||
gdjs.registerObject(
|
||||
|
@@ -9,6 +9,15 @@ namespace gdjs {
|
||||
* frame, since the beginning of the scene and other time related values.
|
||||
* All durations are expressed in milliseconds.
|
||||
*/
|
||||
|
||||
declare interface TimeManagerSyncData {
|
||||
elapsedTime: float;
|
||||
timeScale: float;
|
||||
timeFromStart: float;
|
||||
firstFrame: boolean;
|
||||
timers: Hashtable<TimerNetworkSyncData>;
|
||||
firstUpdateDone: boolean;
|
||||
}
|
||||
export class TimeManager {
|
||||
_elapsedTime: float = 0;
|
||||
_timeScale: float = 1;
|
||||
@@ -59,6 +68,48 @@ namespace gdjs {
|
||||
}
|
||||
}
|
||||
|
||||
getNetworkSyncData(): TimeManagerSyncData {
|
||||
const timerNetworkSyncDatas = new Hashtable<TimerNetworkSyncData>();
|
||||
Object.entries(this._timers.items).forEach(([key, timer]) => {
|
||||
timerNetworkSyncDatas.put(key, timer.getNetworkSyncData());
|
||||
});
|
||||
|
||||
return {
|
||||
elapsedTime: this._elapsedTime,
|
||||
timeScale: this._timeScale,
|
||||
timeFromStart: this._timeFromStart,
|
||||
firstFrame: this._firstFrame,
|
||||
timers: timerNetworkSyncDatas,
|
||||
firstUpdateDone: this._firstUpdateDone,
|
||||
};
|
||||
}
|
||||
|
||||
updateFromNetworkSyncData(syncData: TimeManagerSyncData): void {
|
||||
if (syncData.elapsedTime !== undefined) {
|
||||
this._elapsedTime = syncData.elapsedTime;
|
||||
}
|
||||
if (syncData.timeScale !== undefined) {
|
||||
this._timeScale = syncData.timeScale;
|
||||
}
|
||||
if (syncData.timeFromStart !== undefined) {
|
||||
this._timeFromStart = syncData.timeFromStart;
|
||||
}
|
||||
if (syncData.firstFrame !== undefined) {
|
||||
this._firstFrame = syncData.firstFrame;
|
||||
}
|
||||
if (syncData.timers !== undefined) {
|
||||
this._timers.clear();
|
||||
Object.entries(syncData.timers.items).forEach(([key, timerData]) => {
|
||||
const newTimer = new gdjs.Timer(timerData.name);
|
||||
newTimer.updateFromNetworkSyncData(timerData);
|
||||
this._timers.put(key, newTimer);
|
||||
});
|
||||
}
|
||||
|
||||
if (syncData.firstUpdateDone !== undefined) {
|
||||
this._firstUpdateDone = syncData.firstUpdateDone;
|
||||
}
|
||||
}
|
||||
/**
|
||||
* Get the time scale.
|
||||
* @return The time scale (positive, 1 is normal speed).
|
||||
|
@@ -77,6 +77,7 @@ namespace gdjs {
|
||||
|
||||
getNetworkSyncData(): TimerNetworkSyncData {
|
||||
return {
|
||||
name: this._name,
|
||||
time: this._time,
|
||||
paused: this._paused,
|
||||
};
|
||||
|
29
GDJS/Runtime/types/global-types.d.ts
vendored
29
GDJS/Runtime/types/global-types.d.ts
vendored
@@ -76,3 +76,32 @@ declare namespace gdjs {
|
||||
|
||||
/** The global cc object from Cocos2D-Js. */
|
||||
declare var cc: any;
|
||||
|
||||
/**
|
||||
* Fixes https://github.com/microsoft/TypeScript/issues/16655 for `Array.prototype.filter()`
|
||||
* For example, using the fix the type of `bar` is `string[]` in the below snippet as it should be.
|
||||
*
|
||||
* const foo: (string | null | undefined)[] = [];
|
||||
* const bar = foo.filter(Boolean);
|
||||
*
|
||||
* For related definitions, see https://github.com/microsoft/TypeScript/blob/master/src/lib/es5.d.ts
|
||||
*
|
||||
* Original licenses apply, see
|
||||
* - https://github.com/microsoft/TypeScript/blob/master/LICENSE.txt
|
||||
* - https://stackoverflow.com/help/licensing
|
||||
*/
|
||||
|
||||
/** See https://stackoverflow.com/a/51390763/1470607 */
|
||||
type Falsy = false | 0 | '' | null | undefined;
|
||||
|
||||
interface Array<T> {
|
||||
/**
|
||||
* Returns the elements of an array that meet the condition specified in a callback function.
|
||||
* @param predicate A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array.
|
||||
* @param thisArg An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.
|
||||
*/
|
||||
filter<S extends T>(
|
||||
predicate: BooleanConstructor,
|
||||
thisArg?: any
|
||||
): Exclude<S, Falsy>[];
|
||||
}
|
||||
|
147
GDJS/Runtime/types/project-data.d.ts
vendored
147
GDJS/Runtime/types/project-data.d.ts
vendored
@@ -42,6 +42,28 @@ declare type ObjectData = {
|
||||
declare type GetNetworkSyncDataOptions = {
|
||||
playerNumber?: number;
|
||||
isHost?: boolean;
|
||||
syncObjectIdentifiers?: boolean;
|
||||
shouldExcludeVariableFromData?: (variable: Variable) => boolean;
|
||||
syncAllBehaviors?: boolean;
|
||||
syncGameVariables?: boolean;
|
||||
syncSceneTimers?: boolean;
|
||||
syncOnceTriggers?: boolean;
|
||||
syncSounds?: boolean;
|
||||
syncTweens?: boolean;
|
||||
syncLayers?: boolean;
|
||||
syncAsyncTasks?: boolean;
|
||||
syncSceneVisualProps?: boolean;
|
||||
syncFullTileMaps?: boolean;
|
||||
};
|
||||
|
||||
declare type UpdateFromNetworkSyncDataOptions = {
|
||||
clearSceneStack?: boolean;
|
||||
getExcludedObjectNames?: (runtimeScene: RuntimeScene) => Set<string>;
|
||||
preventSoundsStoppingOnStartup?: boolean;
|
||||
clearInputs?: boolean;
|
||||
keepControl?: boolean;
|
||||
ignoreVariableOwnership?: boolean;
|
||||
shouldExcludeVariableFromUpdate?: (variable: Variable) => boolean;
|
||||
};
|
||||
|
||||
/** Object containing basic properties for all objects synchronizing over the network. */
|
||||
@@ -70,6 +92,10 @@ declare type BasicObjectNetworkSyncData = {
|
||||
pfx: number;
|
||||
/** Permanent force on Y */
|
||||
pfy: number;
|
||||
/** Name of the object */
|
||||
n?: string;
|
||||
/** The network ID of the instance. */
|
||||
networkId?: string;
|
||||
};
|
||||
|
||||
/**
|
||||
@@ -91,6 +117,8 @@ declare interface ObjectNetworkSyncData extends BasicObjectNetworkSyncData {
|
||||
tim?: {
|
||||
[timerName: string]: TimerNetworkSyncData;
|
||||
};
|
||||
/** Tweens */
|
||||
tween?: TweenManagerNetworkSyncData;
|
||||
}
|
||||
|
||||
declare type ForceNetworkSyncData = {
|
||||
@@ -102,6 +130,7 @@ declare type ForceNetworkSyncData = {
|
||||
};
|
||||
|
||||
declare type TimerNetworkSyncData = {
|
||||
name: string;
|
||||
time: float;
|
||||
paused: boolean;
|
||||
};
|
||||
@@ -128,12 +157,30 @@ declare type VariableData = Readonly<{
|
||||
/** A variable child of a container. Those always have a name. */
|
||||
declare type RootVariableData = Omit<VariableData, 'name'> & { name: string };
|
||||
|
||||
declare type VariableNetworkSyncData = {
|
||||
name: string;
|
||||
declare type UnnamedVariableNetworkSyncData = {
|
||||
value: string | float | boolean;
|
||||
children?: VariableNetworkSyncData[];
|
||||
type: VariableType;
|
||||
owner: number;
|
||||
owner: number | null;
|
||||
};
|
||||
declare type VariableNetworkSyncData = UnnamedVariableNetworkSyncData & {
|
||||
name: string;
|
||||
};
|
||||
|
||||
declare type LayerNetworkSyncData = {
|
||||
timeScale: float;
|
||||
defaultZOrder: integer;
|
||||
hidden: boolean;
|
||||
effects: {
|
||||
[effectName: string]: EffectNetworkSyncData;
|
||||
};
|
||||
followBaseLayerCamera: boolean;
|
||||
clearColor: Array<integer>;
|
||||
cameraX: float;
|
||||
cameraY: float;
|
||||
cameraZ: float;
|
||||
cameraRotation: float;
|
||||
cameraZoom: float;
|
||||
};
|
||||
|
||||
/** Properties to set up a behavior. */
|
||||
@@ -149,6 +196,74 @@ declare type BehaviorNetworkSyncData = {
|
||||
props: any;
|
||||
};
|
||||
|
||||
declare type SceneTweenType =
|
||||
| 'layoutValue'
|
||||
| 'layerValue'
|
||||
| 'variable'
|
||||
| 'cameraZoom'
|
||||
| 'cameraRotation'
|
||||
| 'cameraPosition'
|
||||
| 'colorEffectProperty'
|
||||
| 'numberEffectProperty';
|
||||
declare type ObjectTweenType =
|
||||
| 'variable'
|
||||
| 'position'
|
||||
| 'positionX'
|
||||
| 'positionY'
|
||||
| 'positionZ'
|
||||
| 'width'
|
||||
| 'height'
|
||||
| 'depth'
|
||||
| 'angle'
|
||||
| 'rotationX'
|
||||
| 'rotationY'
|
||||
| 'scale'
|
||||
| 'scaleXY'
|
||||
| 'scaleX'
|
||||
| 'scaleY'
|
||||
| 'opacity'
|
||||
| 'characterSize'
|
||||
| 'numberEffectProperty'
|
||||
| 'colorEffectProperty'
|
||||
| 'objectColor'
|
||||
| 'objectColorHSL'
|
||||
| 'objectValue';
|
||||
|
||||
declare type TweenInformation = {
|
||||
type: SceneTweenType | ObjectTweenType;
|
||||
layerName?: string;
|
||||
variable?: Variable;
|
||||
effectName?: string;
|
||||
propertyName?: string;
|
||||
scaleFromCenterOfObject?: boolean;
|
||||
useHSLColorTransition?: boolean;
|
||||
destroyObjectWhenFinished?: boolean;
|
||||
};
|
||||
|
||||
declare type TweenInformationNetworkSyncData = Omit<
|
||||
TweenInformation,
|
||||
'variable' // When synced, a variable is replaced by its path
|
||||
> & { variablePath?: string[] };
|
||||
|
||||
declare type TweenInstanceNetworkSyncData<T> = {
|
||||
initialValue: T;
|
||||
targetedValue: T;
|
||||
elapsedTime: float;
|
||||
totalDuration: float;
|
||||
easingIdentifier: string;
|
||||
interpolationString: 'linear' | 'exponential';
|
||||
isPaused: boolean;
|
||||
tweenInformation: TweenInformationNetworkSyncData;
|
||||
};
|
||||
|
||||
declare type TweenManagerNetworkSyncData = {
|
||||
tweens: Record<
|
||||
string,
|
||||
| TweenInstanceNetworkSyncData<float>
|
||||
| TweenInstanceNetworkSyncData<Array<float>>
|
||||
>;
|
||||
};
|
||||
|
||||
declare interface GdVersionData {
|
||||
build: number;
|
||||
major: number;
|
||||
@@ -183,6 +298,14 @@ declare interface LayoutNetworkSyncData {
|
||||
extVar?: {
|
||||
[extensionName: string]: VariableNetworkSyncData[];
|
||||
};
|
||||
time?: TimeManagerSyncData;
|
||||
tween?: TweenManagerNetworkSyncData;
|
||||
once?: OnceTriggersSyncData;
|
||||
layers?: {
|
||||
[layerName: string]: LayerNetworkSyncData;
|
||||
};
|
||||
async?: AsyncTasksManagerNetworkSyncData;
|
||||
color?: integer;
|
||||
}
|
||||
|
||||
declare interface SceneStackSceneNetworkSyncData {
|
||||
@@ -192,12 +315,30 @@ declare interface SceneStackSceneNetworkSyncData {
|
||||
|
||||
declare type SceneStackNetworkSyncData = SceneStackSceneNetworkSyncData[];
|
||||
|
||||
declare type SoundSyncData = {
|
||||
loop: boolean;
|
||||
volume: float;
|
||||
rate: float;
|
||||
resourceName: string;
|
||||
seek: float;
|
||||
};
|
||||
declare type ChannelsSoundSyncData = Record<integer, SoundSyncData>;
|
||||
declare type SoundManagerSyncData = {
|
||||
globalVolume: float;
|
||||
cachedSpatialPosition: Record<number, [number, number, number]>;
|
||||
freeSounds: SoundSyncData[];
|
||||
freeMusics: SoundSyncData[];
|
||||
musics: ChannelsSoundSyncData;
|
||||
sounds: ChannelsSoundSyncData;
|
||||
};
|
||||
|
||||
declare interface GameNetworkSyncData {
|
||||
var?: VariableNetworkSyncData[];
|
||||
ss?: SceneStackNetworkSyncData;
|
||||
extVar?: {
|
||||
[extensionName: string]: VariableNetworkSyncData[];
|
||||
};
|
||||
sm?: SoundManagerSyncData;
|
||||
}
|
||||
|
||||
declare interface EventsFunctionsExtensionData {
|
||||
|
9
GDJS/Runtime/types/save-state.d.ts
vendored
Normal file
9
GDJS/Runtime/types/save-state.d.ts
vendored
Normal file
@@ -0,0 +1,9 @@
|
||||
declare type SceneSaveState = {
|
||||
sceneData: LayoutNetworkSyncData;
|
||||
objectDatas: { [objectId: integer]: ObjectNetworkSyncData };
|
||||
};
|
||||
|
||||
declare type GameSaveState = {
|
||||
gameNetworkSyncData: GameNetworkSyncData | null;
|
||||
layoutNetworkSyncDatas: SceneSaveState[];
|
||||
};
|
@@ -9,7 +9,7 @@ namespace gdjs {
|
||||
/**
|
||||
* Children of a structure.
|
||||
*/
|
||||
type Children = Record<string, gdjs.Variable>;
|
||||
export type Children = Record<string, gdjs.Variable>;
|
||||
|
||||
/**
|
||||
* A Variable is an object storing a value (number or a string) or children variables.
|
||||
@@ -108,6 +108,190 @@ namespace gdjs {
|
||||
return target;
|
||||
}
|
||||
|
||||
static getVariableDataFromNetworkSyncData = (
|
||||
syncData: VariableNetworkSyncData
|
||||
): VariableData => {
|
||||
return {
|
||||
name: syncData.name,
|
||||
value: syncData.value,
|
||||
type: syncData.type,
|
||||
children: syncData.children
|
||||
? syncData.children.map((childSyncData) =>
|
||||
gdjs.Variable.getVariableDataFromNetworkSyncData(childSyncData)
|
||||
)
|
||||
: undefined,
|
||||
};
|
||||
};
|
||||
|
||||
getNetworkSyncData(
|
||||
syncOptions: GetNetworkSyncDataOptions
|
||||
): UnnamedVariableNetworkSyncData | undefined {
|
||||
if (
|
||||
// Variable undefined.
|
||||
this.isUndefinedInContainer()
|
||||
)
|
||||
return;
|
||||
|
||||
const variableOwner = this.getPlayerOwnership();
|
||||
|
||||
if (syncOptions.shouldExcludeVariableFromData) {
|
||||
// Saving for "save state": serialize all variables unless excluded.
|
||||
if (syncOptions.shouldExcludeVariableFromData(this)) {
|
||||
return;
|
||||
}
|
||||
} else {
|
||||
// Saving for "multiplayer": only serialize the variable if owned by the player.
|
||||
const syncedPlayerNumber = syncOptions.playerNumber;
|
||||
const isHost = syncOptions.isHost;
|
||||
|
||||
if (
|
||||
// Variable marked as not to be synchronized.
|
||||
variableOwner === null ||
|
||||
// Getting sync data for a specific player:
|
||||
(syncedPlayerNumber !== undefined &&
|
||||
// Variable is owned by host but this player number is not the host.
|
||||
variableOwner === 0 &&
|
||||
!isHost) ||
|
||||
// Variable is owned by a player but not getting sync data for this player number.
|
||||
(variableOwner !== 0 && syncedPlayerNumber !== variableOwner)
|
||||
) {
|
||||
// In those cases, the variable should not be synchronized.
|
||||
return;
|
||||
}
|
||||
}
|
||||
|
||||
const variableType = this.getType();
|
||||
const variableValue =
|
||||
variableType === 'structure' || variableType === 'array'
|
||||
? ''
|
||||
: this.getValue();
|
||||
|
||||
return {
|
||||
value: variableValue,
|
||||
type: variableType,
|
||||
children: this.getStructureNetworkSyncData(this),
|
||||
owner: variableOwner,
|
||||
};
|
||||
}
|
||||
|
||||
// Structure variables can contain other variables, so we need to recursively
|
||||
// get the sync data for each child variable.
|
||||
getStructureNetworkSyncData(
|
||||
variable: gdjs.Variable
|
||||
): VariableNetworkSyncData[] | undefined {
|
||||
if (variable.getType() === 'array') {
|
||||
const allVariableNetworkSyncData: VariableNetworkSyncData[] = [];
|
||||
variable.getAllChildrenArray().forEach((childVariable) => {
|
||||
const childVariableType = childVariable.getType();
|
||||
const childVariableValue =
|
||||
childVariableType === 'structure' || childVariableType === 'array'
|
||||
? ''
|
||||
: childVariable.getValue();
|
||||
|
||||
const childVariableOwner = childVariable.getPlayerOwnership();
|
||||
if (
|
||||
// Variable undefined.
|
||||
childVariable.isUndefinedInContainer() ||
|
||||
// Variable marked as not to be synchronized.
|
||||
childVariableOwner === null
|
||||
) {
|
||||
// In those cases, the variable should not be synchronized.
|
||||
return;
|
||||
}
|
||||
|
||||
allVariableNetworkSyncData.push({
|
||||
name: '',
|
||||
value: childVariableValue,
|
||||
type: childVariableType,
|
||||
children: this.getStructureNetworkSyncData(childVariable),
|
||||
owner: childVariableOwner,
|
||||
});
|
||||
});
|
||||
|
||||
return allVariableNetworkSyncData;
|
||||
}
|
||||
|
||||
if (variable.getType() === 'structure') {
|
||||
const variableChildren = variable.getAllChildren();
|
||||
if (!variableChildren) return undefined;
|
||||
const allVariableNetworkSyncData: VariableNetworkSyncData[] = [];
|
||||
|
||||
Object.entries(variableChildren).forEach(
|
||||
([childVariableName, childVariable]) => {
|
||||
const childVariableType = childVariable.getType();
|
||||
const childVariableValue =
|
||||
childVariableType === 'structure' || childVariableType === 'array'
|
||||
? ''
|
||||
: childVariable.getValue();
|
||||
const childVariableOwner = childVariable.getPlayerOwnership();
|
||||
if (
|
||||
// Variable undefined.
|
||||
childVariable.isUndefinedInContainer() ||
|
||||
// Variable marked as not to be synchronized.
|
||||
childVariableOwner === null
|
||||
) {
|
||||
// In those cases, the variable should not be synchronized.
|
||||
return;
|
||||
}
|
||||
|
||||
allVariableNetworkSyncData.push({
|
||||
name: childVariableName,
|
||||
value: childVariableValue,
|
||||
type: childVariableType,
|
||||
children: this.getStructureNetworkSyncData(childVariable),
|
||||
owner: childVariableOwner,
|
||||
});
|
||||
}
|
||||
);
|
||||
|
||||
return allVariableNetworkSyncData;
|
||||
}
|
||||
|
||||
return undefined;
|
||||
}
|
||||
|
||||
updateFromNetworkSyncData(
|
||||
networkSyncData: VariableNetworkSyncData,
|
||||
options: UpdateFromNetworkSyncDataOptions
|
||||
) {
|
||||
// // If we receive an update for this variable for a different owner than the one we know about,
|
||||
// then 2 cases:
|
||||
// - If we are the owner of the variable, then ignore the message, we assume it's a late update message or a wrong one,
|
||||
// we are confident that we own this variable. (it may be reverted if we don't receive an acknowledgment in time)
|
||||
// - If we are not the owner of the variable, then assume that we missed the ownership change message, so update the variable's
|
||||
// ownership and then update the variable.
|
||||
const syncedVariableOwner = networkSyncData.owner;
|
||||
const variableData =
|
||||
gdjs.Variable.getVariableDataFromNetworkSyncData(networkSyncData);
|
||||
|
||||
if (
|
||||
options.shouldExcludeVariableFromUpdate &&
|
||||
options.shouldExcludeVariableFromUpdate(this)
|
||||
) {
|
||||
return;
|
||||
}
|
||||
|
||||
if (!options.ignoreVariableOwnership) {
|
||||
const currentPlayerNumber = gdjs.multiplayer.getCurrentPlayerNumber();
|
||||
|
||||
const currentVariableOwner = this.getPlayerOwnership();
|
||||
if (currentPlayerNumber === currentVariableOwner) {
|
||||
// Variable owned by us, ignoring update message.
|
||||
return;
|
||||
}
|
||||
|
||||
if (
|
||||
syncedVariableOwner &&
|
||||
syncedVariableOwner !== currentVariableOwner
|
||||
) {
|
||||
/// Variable owned by someone else on our game, changing ownership as part of the update event.
|
||||
this.setPlayerOwnership(syncedVariableOwner);
|
||||
}
|
||||
}
|
||||
|
||||
this.reinitialize(variableData);
|
||||
}
|
||||
|
||||
/**
|
||||
* Converts a JavaScript object into a value compatible
|
||||
* with GDevelop variables and store it inside this variable.
|
||||
@@ -148,7 +332,7 @@ namespace gdjs {
|
||||
" aren't supported by GDevelop variables, it will be reduced to that size."
|
||||
);
|
||||
// @ts-ignore
|
||||
variable.setNumber(parseInt(obj, 10));
|
||||
this.setNumber(parseInt(obj, 10));
|
||||
} else if (typeof obj === 'function') {
|
||||
logger.error(
|
||||
'Error while converting JS variable to GDevelop variable: Impossible to set variable value to a function.'
|
||||
|
@@ -228,183 +228,89 @@ namespace gdjs {
|
||||
return null;
|
||||
}
|
||||
|
||||
getVariablePathInContainerByLoopingThroughAllVariables(
|
||||
variable: gdjs.Variable,
|
||||
childrenToLookIn: Children | null = null
|
||||
): string[] | null {
|
||||
const variables = childrenToLookIn || this._variables.items;
|
||||
for (const variableName in variables) {
|
||||
if (variables.hasOwnProperty(variableName)) {
|
||||
const variableItem = variables[variableName];
|
||||
if (variableItem === variable) {
|
||||
return [variableName];
|
||||
} else if (variableItem.getType() === 'structure') {
|
||||
const variableItemChildren = variableItem.getAllChildren();
|
||||
const childPath =
|
||||
this.getVariablePathInContainerByLoopingThroughAllVariables(
|
||||
variable,
|
||||
variableItemChildren
|
||||
);
|
||||
if (childPath) {
|
||||
return [variableName, ...childPath];
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return null;
|
||||
}
|
||||
|
||||
getVariableFromPath(variablePath: string[]): gdjs.Variable | null {
|
||||
let variableItems = this._variables.items;
|
||||
for (let i = 0; i < variablePath.length; i++) {
|
||||
const part = variablePath[i];
|
||||
const nextVariable = variableItems[part];
|
||||
if (!nextVariable) {
|
||||
return null;
|
||||
}
|
||||
if (i === variablePath.length - 1) {
|
||||
return nextVariable;
|
||||
}
|
||||
variableItems = nextVariable.getAllChildren();
|
||||
}
|
||||
|
||||
return null;
|
||||
}
|
||||
|
||||
static _deletedVars: Array<string | undefined> = [];
|
||||
|
||||
getNetworkSyncData(
|
||||
syncOptions: GetNetworkSyncDataOptions
|
||||
): VariableNetworkSyncData[] {
|
||||
const syncedPlayerNumber = syncOptions.playerNumber;
|
||||
const isHost = syncOptions.isHost;
|
||||
const networkSyncData: VariableNetworkSyncData[] = [];
|
||||
const variableNames = [];
|
||||
this._variables.keys(variableNames);
|
||||
variableNames.forEach((variableName) => {
|
||||
const variable = this._variables.get(variableName);
|
||||
const variableOwner = variable.getPlayerOwnership();
|
||||
if (
|
||||
// Variable undefined.
|
||||
variable.isUndefinedInContainer() ||
|
||||
// Variable marked as not to be synchronized.
|
||||
variableOwner === null ||
|
||||
// Getting sync data for a specific player:
|
||||
(syncedPlayerNumber !== undefined &&
|
||||
// Variable is owned by host but this player number is not the host.
|
||||
variableOwner === 0 &&
|
||||
!isHost) ||
|
||||
// Variable is owned by a player but not getting sync data for this player number.
|
||||
(variableOwner !== 0 && syncedPlayerNumber !== variableOwner)
|
||||
) {
|
||||
// In those cases, the variable should not be synchronized.
|
||||
return;
|
||||
const variableSyncData = variable.getNetworkSyncData(syncOptions);
|
||||
if (variableSyncData) {
|
||||
networkSyncData.push({
|
||||
name: variableName,
|
||||
...variableSyncData,
|
||||
});
|
||||
}
|
||||
|
||||
const variableType = variable.getType();
|
||||
const variableValue =
|
||||
variableType === 'structure' || variableType === 'array'
|
||||
? ''
|
||||
: variable.getValue();
|
||||
|
||||
networkSyncData.push({
|
||||
name: variableName,
|
||||
value: variableValue,
|
||||
type: variableType,
|
||||
children: this.getStructureNetworkSyncData(variable),
|
||||
owner: variableOwner,
|
||||
});
|
||||
});
|
||||
|
||||
return networkSyncData;
|
||||
}
|
||||
|
||||
// Structure variables can contain other variables, so we need to recursively
|
||||
// get the sync data for each child variable.
|
||||
getStructureNetworkSyncData(
|
||||
variable: gdjs.Variable
|
||||
): VariableNetworkSyncData[] | undefined {
|
||||
if (variable.getType() === 'array') {
|
||||
const allVariableNetworkSyncData: VariableNetworkSyncData[] = [];
|
||||
variable.getAllChildrenArray().forEach((childVariable) => {
|
||||
const childVariableType = childVariable.getType();
|
||||
const childVariableValue =
|
||||
childVariableType === 'structure' || childVariableType === 'array'
|
||||
? ''
|
||||
: childVariable.getValue();
|
||||
|
||||
const childVariableOwner = childVariable.getPlayerOwnership();
|
||||
if (
|
||||
// Variable undefined.
|
||||
childVariable.isUndefinedInContainer() ||
|
||||
// Variable marked as not to be synchronized.
|
||||
childVariableOwner === null
|
||||
) {
|
||||
// In those cases, the variable should not be synchronized.
|
||||
return;
|
||||
}
|
||||
|
||||
allVariableNetworkSyncData.push({
|
||||
name: '',
|
||||
value: childVariableValue,
|
||||
type: childVariableType,
|
||||
children: this.getStructureNetworkSyncData(childVariable),
|
||||
owner: childVariableOwner,
|
||||
});
|
||||
});
|
||||
|
||||
return allVariableNetworkSyncData;
|
||||
}
|
||||
|
||||
if (variable.getType() === 'structure') {
|
||||
const variableChildren = variable.getAllChildren();
|
||||
if (!variableChildren) return undefined;
|
||||
const allVariableNetworkSyncData: VariableNetworkSyncData[] = [];
|
||||
|
||||
Object.entries(variableChildren).forEach(
|
||||
([childVariableName, childVariable]) => {
|
||||
const childVariableType = childVariable.getType();
|
||||
const childVariableValue =
|
||||
childVariableType === 'structure' || childVariableType === 'array'
|
||||
? ''
|
||||
: childVariable.getValue();
|
||||
const childVariableOwner = childVariable.getPlayerOwnership();
|
||||
if (
|
||||
// Variable undefined.
|
||||
childVariable.isUndefinedInContainer() ||
|
||||
// Variable marked as not to be synchronized.
|
||||
childVariableOwner === null
|
||||
) {
|
||||
// In those cases, the variable should not be synchronized.
|
||||
return;
|
||||
}
|
||||
|
||||
allVariableNetworkSyncData.push({
|
||||
name: childVariableName,
|
||||
value: childVariableValue,
|
||||
type: childVariableType,
|
||||
children: this.getStructureNetworkSyncData(childVariable),
|
||||
owner: childVariableOwner,
|
||||
});
|
||||
}
|
||||
);
|
||||
|
||||
return allVariableNetworkSyncData;
|
||||
}
|
||||
|
||||
return undefined;
|
||||
}
|
||||
|
||||
updateFromNetworkSyncData(networkSyncData: VariableNetworkSyncData[]) {
|
||||
updateFromNetworkSyncData(
|
||||
networkSyncData: VariableNetworkSyncData[],
|
||||
options: UpdateFromNetworkSyncDataOptions
|
||||
) {
|
||||
const that = this;
|
||||
for (let j = 0; j < networkSyncData.length; ++j) {
|
||||
const variableSyncData = networkSyncData[j];
|
||||
const variableData =
|
||||
that._getVariableDataFromNetworkSyncData(variableSyncData);
|
||||
gdjs.Variable.getVariableDataFromNetworkSyncData(variableSyncData);
|
||||
const variableName = variableData.name;
|
||||
if (!variableName) continue;
|
||||
|
||||
const variable = that.get(variableName);
|
||||
|
||||
// // If we receive an update for this variable for a different owner than the one we know about,
|
||||
// then 2 cases:
|
||||
// - If we are the owner of the variable, then ignore the message, we assume it's a late update message or a wrong one,
|
||||
// we are confident that we own this variable. (it may be reverted if we don't receive an acknowledgment in time)
|
||||
// - If we are not the owner of the variable, then assume that we missed the ownership change message, so update the variable's
|
||||
// ownership and then update the variable.
|
||||
const syncedVariableOwner = variableSyncData.owner;
|
||||
const currentPlayerNumber = gdjs.multiplayer.getCurrentPlayerNumber();
|
||||
const currentVariableOwner = variable.getPlayerOwnership();
|
||||
if (currentPlayerNumber === currentVariableOwner) {
|
||||
console.info(
|
||||
`Variable ${variableName} is owned by us ${gdjs.multiplayer.playerNumber}, ignoring update message from ${syncedVariableOwner}.`
|
||||
);
|
||||
return;
|
||||
}
|
||||
|
||||
if (syncedVariableOwner !== currentVariableOwner) {
|
||||
console.info(
|
||||
`Variable ${variableName} is owned by ${currentVariableOwner} on our game, changing ownership to ${syncedVariableOwner} as part of the update event.`
|
||||
);
|
||||
variable.setPlayerOwnership(syncedVariableOwner);
|
||||
}
|
||||
|
||||
variable.reinitialize(variableData);
|
||||
variable.updateFromNetworkSyncData(variableSyncData, options);
|
||||
}
|
||||
}
|
||||
|
||||
_getVariableDataFromNetworkSyncData(
|
||||
syncData: VariableNetworkSyncData
|
||||
): VariableData {
|
||||
return {
|
||||
name: syncData.name,
|
||||
value: syncData.value,
|
||||
type: syncData.type,
|
||||
children: syncData.children
|
||||
? syncData.children.map((childSyncData) =>
|
||||
this._getVariableDataFromNetworkSyncData(childSyncData)
|
||||
)
|
||||
: undefined,
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* "Bad" variable container, used by events when no other valid container can be found.
|
||||
* This container has no state and always returns the bad variable ( see VariablesContainer.badVariable ).
|
||||
@@ -440,18 +346,18 @@ namespace gdjs {
|
||||
updateFromNetworkSyncData: function () {
|
||||
return;
|
||||
},
|
||||
getStructureNetworkSyncData: function () {
|
||||
return undefined;
|
||||
},
|
||||
_getVariableDataFromNetworkSyncData: function () {
|
||||
return {};
|
||||
},
|
||||
hasVariable: function () {
|
||||
return false;
|
||||
},
|
||||
getVariableNameInContainerByLoopingThroughAllVariables: function () {
|
||||
return '';
|
||||
},
|
||||
getVariablePathInContainerByLoopingThroughAllVariables: function () {
|
||||
return [];
|
||||
},
|
||||
getVariableFromPath: function () {
|
||||
return null;
|
||||
},
|
||||
rebuildIndexFrom: function () {
|
||||
return;
|
||||
},
|
||||
@@ -572,6 +478,15 @@ namespace gdjs {
|
||||
disableSynchronization: function () {
|
||||
return;
|
||||
},
|
||||
getNetworkSyncData: function () {
|
||||
return undefined;
|
||||
},
|
||||
getStructureNetworkSyncData: function () {
|
||||
return [];
|
||||
},
|
||||
updateFromNetworkSyncData: function () {
|
||||
return;
|
||||
},
|
||||
};
|
||||
}
|
||||
}
|
||||
|
19962
GDJS/tests/games/SaveLoadExample/Save & load example.json
Normal file
19962
GDJS/tests/games/SaveLoadExample/Save & load example.json
Normal file
File diff suppressed because it is too large
Load Diff
Binary file not shown.
BIN
GDJS/tests/games/SaveLoadExample/assets/Background.png
Normal file
BIN
GDJS/tests/games/SaveLoadExample/assets/Background.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 277 B |
Binary file not shown.
After Width: | Height: | Size: 322 B |
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user