dallasgroot/0ad
1
0
Fork 0
mirror of https://gitea.wildfiregames.com/0ad/0ad synced 2026-06-17 22:03:56 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

Always leave/reenter the top-most FSM state when SetNextState is called with the current FSM state.

Browse source 
When SetNextState is called with the current state, it will leave and
re-enter so that any relevant cleanup will get called and things work as
expected.
It will prevent possibly awkward code issues in UnitAI, which already
called SetNextStateAlwaysEntering in a number of places to work around
them.

This should most likely have been the default behaviour in the first
place.

Reviewed By: Itms
Differential Revision: https://code.wildfiregames.com/D1488
This was SVN commit r22023.
This commit is contained in:
wraitii 2019-01-05 09:01:51 +00:00
parent 2c167153e9
commit a16e7c0a56
2 changed files with 17 additions and 32 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

33
binaries/data/mods/public/simulation/components/UnitAI.js
View file

@ -210,7 +210,7 @@ UnitAI.prototype.UnitFsmSpec = {
var cmpUnitMotion = Engine.QueryInterface(this.entity, IID_UnitMotion);
cmpUnitMotion.MoveToFormationOffset(msg.data.target, msg.data.x, msg.data.z);
this.SetNextStateAlwaysEntering("FORMATIONMEMBER.WALKING");
this.SetNextState("FORMATIONMEMBER.WALKING");
},
// Special orders:
@ -457,9 +457,9 @@ UnitAI.prototype.UnitFsmSpec = {
else
{
if (this.IsAnimal())
this.SetNextStateAlwaysEntering("ANIMAL.COMBAT.ATTACKING");
this.SetNextState("ANIMAL.COMBAT.ATTACKING");
else
this.SetNextStateAlwaysEntering("INDIVIDUAL.COMBAT.ATTACKING");
this.SetNextState("INDIVIDUAL.COMBAT.ATTACKING");
}
return;
}
@ -603,7 +603,7 @@ UnitAI.prototype.UnitFsmSpec = {
// so try gathering it from here.
// TODO: need better handling of the can't-reach-target case
this.StopMoving();
this.SetNextStateAlwaysEntering("INDIVIDUAL.GATHER.GATHERING");
this.SetNextState("INDIVIDUAL.GATHER.GATHERING");
}
},
@ -680,7 +680,7 @@ UnitAI.prototype.UnitFsmSpec = {
// so try repairing it from here.
// TODO: need better handling of the can't-reach-target case
this.StopMoving();
this.SetNextStateAlwaysEntering("INDIVIDUAL.REPAIR.REPAIRING");
this.SetNextState("INDIVIDUAL.REPAIR.REPAIRING");
}
},
@ -920,7 +920,7 @@ UnitAI.prototype.UnitFsmSpec = {
this.CallMemberFunction("Gather", [msg.data.target, false]);
this.SetNextStateAlwaysEntering("MEMBER");
this.SetNextState("MEMBER");
},
"Order.GatherNearPosition": function(msg) {
@ -935,7 +935,7 @@ UnitAI.prototype.UnitFsmSpec = {
this.CallMemberFunction("GatherNearPosition", [msg.data.x, msg.data.z, msg.data.type, msg.data.template, false]);
this.SetNextStateAlwaysEntering("MEMBER");
this.SetNextState("MEMBER");
},
"Order.Heal": function(msg) {
@ -954,7 +954,7 @@ UnitAI.prototype.UnitFsmSpec = {
this.CallMemberFunction("Heal", [msg.data.target, false]);
this.SetNextStateAlwaysEntering("MEMBER");
this.SetNextState("MEMBER");
},
"Order.Repair": function(msg) {
@ -973,7 +973,7 @@ UnitAI.prototype.UnitFsmSpec = {
this.CallMemberFunction("Repair", [msg.data.target, msg.data.autocontinue, false]);
this.SetNextStateAlwaysEntering("MEMBER");
this.SetNextState("MEMBER");
},
"Order.ReturnResource": function(msg) {
@ -992,19 +992,19 @@ UnitAI.prototype.UnitFsmSpec = {
this.CallMemberFunction("ReturnResource", [msg.data.target, false]);
this.SetNextStateAlwaysEntering("MEMBER");
this.SetNextState("MEMBER");
},
"Order.Pack": function(msg) {
this.CallMemberFunction("Pack", [false]);
this.SetNextStateAlwaysEntering("MEMBER");
this.SetNextState("MEMBER");
},
"Order.Unpack": function(msg) {
this.CallMemberFunction("Unpack", [false]);
this.SetNextStateAlwaysEntering("MEMBER");
this.SetNextState("MEMBER");
},
"IDLE": {
@ -1155,7 +1155,7 @@ UnitAI.prototype.UnitFsmSpec = {
delete this.pickup;
}
this.CallMemberFunction("Garrison", [this.order.data.target, false]);
this.SetNextStateAlwaysEntering("MEMBER");
this.SetNextState("MEMBER");
},
},
},
@ -3530,17 +3530,12 @@ UnitAI.prototype.SetupHealRangeQuery = function(enable = true)
//// FSM linkage functions ////
// Setting the next state to the current state will leave/re-enter the top-most substate.
UnitAI.prototype.SetNextState = function(state)
{
this.UnitFsm.SetNextState(this, state);
};
// This will make sure that the state is always entered even if this means leaving it and reentering it
// This is so that a state can be reinitialized with new order data without having to switch to an intermediate state
UnitAI.prototype.SetNextStateAlwaysEntering = function(state)
{
this.UnitFsm.SetNextStateAlwaysEntering(this, state);
};
UnitAI.prototype.DeferMessage = function(msg)
{

16
binaries/data/mods/public/simulation/helpers/FSM.js
View file

@ -249,15 +249,6 @@ FSM.prototype.Init = function(obj, initialState)
FSM.prototype.SetNextState = function(obj, state)
{
obj.fsmNextState = state;
obj.fsmReenter = false;
};
FSM.prototype.SetNextStateAlwaysEntering = function(obj, state)
{
obj.fsmNextState = state;
// If reenter is true then the state will always be entered even if this means exiting it to re-enter
obj.fsmReenter = true;
};
FSM.prototype.ProcessMessage = function(obj, msg)
@ -280,8 +271,7 @@ FSM.prototype.ProcessMessage = function(obj, msg)
var nextStateName = this.LookupState(obj.fsmStateName, obj.fsmNextState);
obj.fsmNextState = undefined;
if (nextStateName != obj.fsmStateName || obj.fsmReenter)
this.SwitchToNextState(obj, nextStateName);
this.SwitchToNextState(obj, nextStateName);
}
return ret;
@ -349,8 +339,8 @@ FSM.prototype.SwitchToNextState = function(obj, nextStateName)
{
}
// Check if we should exit and enter the current state due to the reenter parameter. If so we go up 1 level
if (obj.fsmReenter && equalPrefix > 0 && equalPrefix === toState.length)
// If the next-state is the same as the current state, leave/enter up one level so cleanup gets triggered.
if (equalPrefix > 0 && equalPrefix === toState.length)
--equalPrefix;
for (var i = fromState.length-1; i >= equalPrefix; --i)