Differential D238 Diff 1618 binaries/data/mods/public/simulation/components/RangeVisualization.js

Changeset View

Standalone View

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

				function RangeVisualization() {}

				RangeVisualization.prototype.Schema = "<empty/>";

				RangeVisualization.prototype.Init = function()
				{
				SandaracAuthorUnsubmitted Done Inline Actions This should be removed. Sandarac: This should be removed.
				this.enabled = false;
				// Keep track of the enabled aura types for this entity
				this.enabledRangeTypes = {
				elexisUnsubmitted Done Inline Actions self-explanatory elexis: self-explanatory
				"Aura": false
				};

				elexisUnsubmitted Done Inline Actions `// Keep track of the enabled aura types for this entity`? (Since it doesn't strictly depend on config options but also on the selection and there might be other GUI checks and hotkeys added later) elexis: `// Keep track of the enabled aura types for this entity`? (Since it doesn't strictly depend on…
				this.rangeVisualizations = new Map();
				for (let type in this.enabledRangeTypes)
				this["GetVisual" + type + "Ranges"](type);
				};
				elexisUnsubmitted Not Done Inline Actions (Dunno if a Map has an advantage over objects) elexis: (Dunno if a Map has an advantage over objects)
				SandaracAuthorUnsubmitted Not Done Inline Actions A Map is used in a similar way to this in cmpStatusBars (which is what this new component is based on). Sandarac: A Map is used in a similar way to this in cmpStatusBars (which is what this new component is…

				elexisUnsubmitted Done Inline Actions for...in elexis: for...in
				// The GUI enables visualizations
				RangeVisualization.prototype.Serialize = null;

				RangeVisualization.prototype.Deserialize = function(data)
				elexisUnsubmitted Done Inline Actions Perhaps we should state that we do not serialize the properties because the GUI and selection enables the visualization elexis: Perhaps we should state that we do not serialize the properties because the GUI and selection…
				{
				this.Init();
				};

				elexisUnsubmitted Not Done Inline Actions iirc, first Init() was called, then Deserialize(), so it may or may not be redundant (depends on other deserialized components?) elexis: iirc, first Init() was called, then Deserialize(), so it may or may not be redundant (depends…
				SandaracAuthorUnsubmitted Not Done Inline Actions `Init()` is called in `Deserialize()` in components like StatusBars and Identity. Sandarac: `Init()` is called in `Deserialize()` in components like StatusBars and Identity.
				RangeVisualization.prototype.GetVisualAuraRanges = function(type)
				{
				let cmpAuras = Engine.QueryInterface(this.entity, IID_Auras);
				if (!cmpAuras)
				return;

				this.rangeVisualizations.set(type, []);

				for (let auraName of cmpAuras.GetVisualAuraRangeNames())
				this.rangeVisualizations.get(type).push({
				"radius": cmpAuras.GetRange(auraName),
				"texture": cmpAuras.GetLineTexture(auraName),
				"textureMask": cmpAuras.GetLineTextureMask(auraName),
				"thickness": cmpAuras.GetLineThickness(auraName),
				});
				};

				RangeVisualization.prototype.SetEnabled = function(enabled, enabledRangeTypes)
				{
				this.enabled = enabled;
				this.enabledRangeTypes = enabledRangeTypes;

				this.RegenerateRangeVisualizations();
				};

				RangeVisualization.prototype.RegenerateRangeVisualizations = function()
				{
				let cmpSelectable = Engine.QueryInterface(this.entity, IID_Selectable);
				if (!cmpSelectable)
				return;

				cmpSelectable.ResetRangeOverlays();

				if (!this.enabled)
				return;

				// Only render individual range types that have been enabled
				for (let rangeOverlayType of this.rangeVisualizations.keys())
				if (this.enabledRangeTypes[rangeOverlayType])
				for (let rangeOverlay of this.rangeVisualizations.get(rangeOverlayType))
				cmpSelectable.SetRangeOverlay(rangeOverlay.radius, rangeOverlay.texture,
				rangeOverlay.textureMask, rangeOverlay.thickness);
				elexisUnsubmitted Done Inline Actions better each argument on a separate line than 2 arguments on one line, 2 on another. Nice side effect of having them aligned elexis: better each argument on a separate line than 2 arguments on one line, 2 on another. Nice side…
				};

				RangeVisualization.prototype.OnOwnershipChanged = function(msg)
				{
				elexisUnsubmitted Not Done Inline Actions `thickness);`, at least the other code does it like this elexis: `thickness);`, at least the other code does it like this
				if (this.enabled && msg.to != -1)
				this.RegenerateRangeVisualizations();
				};

				Engine.RegisterComponentType(IID_RangeVisualization, "RangeVisualization", RangeVisualization);