Page MenuHomeWildfire Games
Differential D3303 Diff 16165 binaries/data/mods/public/simulation/components/Treasure.js

Changeset View

Standalone View

View Options

binaries/data/mods/public/simulation/components/Treasure.js

  • This file was added.
function Treasure() {}
Treasure.prototype.Schema =
"<a:help>Provides a bonus when taken. E.g. a supply of resources.</a:help>" +
"<a:example>" +
"<CollectTime>1000</CollectTime>" +
"<Resources>" +
"<Food>1000</Food>" +
"</Resources>" +
"</a:example>" +
"<element name='CollectTime' a:help='Amount of milliseconds that it takes to collect this treasure.'>" +
"<ref name='nonNegativeDecimal'/>" +
"</element>" +
"<optional>" +
"<element name='Resources' a:help='Amount of resources that are in this.'>" +
Resources.BuildSchema("positiveDecimal") +
"</element>" +
"</optional>";
Treasure.prototype.Init = function()
{
};
Treasure.prototype.ComputeReward = function()
{
StanUnsubmitted
Done
Inline Actions

s/Calculate/Compute?

Stan: s/Calculate/Compute?
for (let resource in this.template.Resources)
{
let amount = ApplyValueModificationsToEntity("Treasure/Resources/" + resource, this.template.Resources[resource], this.entity);
if (!amount)
continue;
if (!this.resources)
this.resources = {};
this.resources[resource] = amount;
}
};
StanUnsubmitted
Done
Inline Actions
let amount = ApplyValueModificationsToEntity("Treasure/Resources/" + resource, this.template.Resources[resource], this.entity);
- if (amount)
- {
- if (!this.resources)
- this.resources = {};
- this.resources[resource] = amount;
- }
- }
+ if (!amount)
+ continue;
+
+ if (!this.resources)
+ this.resources = {};
+
+ this.resources[resource] = amount;
+ }
};

Maybe, not sure if more readable.

Stan: Maybe, not sure if more readable.
/**
* ToDo: generalise.
wraitiiUnsubmitted
Done
Inline Actions

generalise?

wraitii: generalise?
FreagarachAuthorUnsubmitted
Done
Inline Actions

I guess the ToDo can be removed, but the idea is that treasures should not need to be limited to giving resources.
It could very wel be that the enitity picking up a treasure receives a combat boost, or the player gets a trickle of some resource (e.g. StatusEffects). Or that the entity spawns an entity for your civ.

Freagarach: I guess the ToDo can be removed, but the idea is that treasures should not need to be limited…
* @return {Object} - The resources given by this treasure.
*/
Treasure.prototype.Resources = function()
{
return this.resources || {};
StanUnsubmitted
Done
Inline Actions

GetReward?

Stan: GetReward?
FreagarachAuthorUnsubmitted
Done
Inline Actions

I'm not sure what the Get adds?

Freagarach: I'm not sure what the `Get` adds?
};
/**
* @return {number} - The time in miliseconds it takes to collect this treasure.
*/
Treasure.prototype.CollectionTime = function()
{
return +this.template.CollectTime;
};
/**
* @param {number} entity - The entity collecting us.
* @return {boolean} - Whether the reward was granted.
wraitiiUnsubmitted
Done
Inline Actions

collecting from us

wraitii: `collecting from us`
*/
wraitiiUnsubmitted
Done
Inline Actions

the reward was granted?

wraitii: `the reward was granted`?
Treasure.prototype.Reward = function(entity)
wraitiiUnsubmitted
Done
Inline Actions

wouldn't it be better to pass the player directly here?

wraitii: wouldn't it be better to pass the player directly here?
FreagarachAuthorUnsubmitted
Done
Inline Actions

See comment above.

Freagarach: See comment above.
{
if (this.isTaken)
return false;
StanUnsubmitted
Done
Inline Actions

Should that be the responsibility of the caller?

Stan: Should that be the responsibility of the caller?
FreagarachAuthorUnsubmitted
Done
Inline Actions

Yeah, I was pondering that, probably right.

Freagarach: Yeah, I was pondering that, probably right.
let cmpPlayer = QueryOwnerInterface(entity);
if (!cmpPlayer)
return false;
let cmpFogging = Engine.QueryInterface(this.entity, IID_Fogging);
if (cmpFogging)
cmpFogging.Activate();
if (this.resources)
cmpPlayer.AddResources(this.resources);
StanUnsubmitted
Done
Inline Actions

Does it make sense to collect treasures without players in the current state? If not could early return false maybe.

Stan: Does it make sense to collect treasures without players in the current state? If not could…
FreagarachAuthorUnsubmitted
Done
Inline Actions

True, can be added later if deemed a necessity.

Freagarach: True, can be added later if deemed a necessity.
let cmpStatisticsTracker = QueryOwnerInterface(this.entity, IID_StatisticsTracker);
if (cmpStatisticsTracker)
cmpStatisticsTracker.IncreaseTreasuresCollectedCounter();
let cmpTrigger = Engine.QueryInterface(SYSTEM_ENTITY, IID_Trigger);
cmpTrigger.CallEvent("TreasureCollected", {
"player": cmpPlayer.GetPlayerID(),
StanUnsubmitted
Done
Inline Actions
let cmpPlayer = QueryOwnerInterface(entity);
- let cmpTrigger = Engine.QueryInterface(SYSTEM_ENTITY, IID_Trigger);
+
if (cmpPlayer)
{
if (this.resources)
cmpPlayer.AddResources(this.resources);
-
+ let cmpTrigger = Engine.QueryInterface(SYSTEM_ENTITY, IID_Trigger);
cmpTrigger.CallEvent("TreasureCollected", {
"player": cmpPlayer.GetPlayerID(),
Stan:
"treasure": this.entity
wraitiiUnsubmitted
Done
Inline Actions

I'd suggest moving out of the world - might make isTaken redundant.

wraitii: I'd suggest moving out of the world - might make isTaken redundant.
FreagarachAuthorUnsubmitted
Done
Inline Actions

Who says a treasure needs to be InWorld for it to be taken? ;)

Freagarach: Who says a treasure needs to be `InWorld` for it to be taken? ;)
});
this.isTaken = true;
Engine.DestroyEntity(this.entity);
return true;
};
/**
* We might live long enough for a collecting entity
StanUnsubmitted
Done
Inline Actions

probably need a msg param :)

Stan: probably need a msg param :)
* to find us again after taking us.
* @return {boolean} - Whether we are taken already.
*/
Treasure.prototype.IsAvailable = function()
{
return !this.isTaken;
};
Treasure.prototype.OnOwnershipChanged = function(msg)
{
if (msg.to != INVALID_PLAYER)
this.ComputeReward();
};
Treasure.prototype.OnValueModification = function(msg)
{
if (msg.component != "Treasure")
return;
this.ComputeReward();
};
Engine.RegisterComponentType(IID_Treasure, "Treasure", Treasure);
Wildfire Games · Phabricator