commit for v.0.10.3

Author: dertseha

src/github.com/inkyblackness/res/data/gameobj/Animations.go

@@ -1,12 +1,17 @@
 package gameobj
 
 import (
+	"fmt"
+
 	"github.com/inkyblackness/res"
 	"github.com/inkyblackness/res/data/interpreters"
 )
 
 var animationGenerics = interpreters.New().
-	With("FrameTime", 0, 1).
+	With("FrameTime", 0, 1).As(interpreters.FormattedRangedValue(0, 255,
+	func(value int64) string {
+		return fmt.Sprintf("%3.0f millisec - raw: %d", (float64(value)*900)/255.0, value)
+	})).
 	With("EmitsLight", 1, 1).As(interpreters.EnumValue(map[uint32]string{0: "No", 1: "Yes"}))
 
 func initAnimations() {

src/github.com/inkyblackness/res/data/interpreters/Description_test.go

@@ -77,7 +77,7 @@ func (suite *DescriptionSuite) TestAsRegistersRangeFunctionForLastField(c *check
 	desc := New().With("fieldA", 0, 2).As(rangeFunc)
 
 	inst := desc.For([]byte{0x00, 0x01})
-	simplifier := NewSimplifier(func(minValue, maxValue int64) {})
+	simplifier := NewSimplifier(func(minValue, maxValue int64, formatter RawValueFormatter) {})
 	inst.Describe("fieldA", simplifier)
 
 	c.Check(rangeFuncCalled, check.Equals, true)

src/github.com/inkyblackness/res/data/interpreters/Simplifier.go

@@ -1,11 +1,15 @@
 package interpreters
 
 import (
+	"fmt"
 	"math"
 )
 
+// RawValueFormatter converts a raw value to a textual form.
+type RawValueFormatter func(value int64) string
+
 // RawValueHandler is for a simple value range.
-type RawValueHandler func(minValue, maxValue int64)
+type RawValueHandler func(minValue, maxValue int64, formatter RawValueFormatter)
 
 // EnumValueHandler is for enumerated (mapped) values.
 type EnumValueHandler func(values map[uint32]string)
@@ -19,10 +23,19 @@ type ObjectIndexHandler func()
 // SpecialHandler is for rare occasions.
 type SpecialHandler func()
 
+func basicToString(value int64) string {
+	return fmt.Sprintf("%v", value)
+}
+
 // RangedValue creates a field range for specific minimum and maximum values.
 func RangedValue(minValue, maxValue int64) FieldRange {
+	return FormattedRangedValue(minValue, maxValue, basicToString)
+}
+
+// FormattedRangedValue is similar to RangedValue, and adds a formatting function.
+func FormattedRangedValue(minValue, maxValue int64, formatter RawValueFormatter) FieldRange {
 	return func(simpl *Simplifier) bool {
-		return simpl.rangedValue(minValue, maxValue)
+		return simpl.rangedValue(minValue, maxValue, formatter)
 	}
 }
 
@@ -51,6 +64,7 @@ func ObjectIndex() FieldRange {
 // Currently known special values:
 // * BinaryCodedDecimal - for keypads storing their number as BCD
 // * LevelTexture - index value into level texture list
+// * MaterialOrLevelTexture - index value into level texture list, or material (bit 7 toggles)
 // * VariableKey - for actions
 // * VariableCondition - for action conditions
 // * ObjectType - for 0x00CCSSTT selection
@@ -85,15 +99,15 @@ func NewSimplifier(rawValueHandler RawValueHandler) *Simplifier {
 func (simpl *Simplifier) rawValue(e *entry) {
 	max := int64(math.Pow(2, float64(e.count*8)))
 	if max == 256 {
-		simpl.rawValueHandler(0, 255)
+		simpl.rawValueHandler(0, 255, basicToString)
 	} else {
 		half := max / 2
-		simpl.rawValueHandler(-1, half-1)
+		simpl.rawValueHandler(-1, half-1, basicToString)
 	}
 }
 
-func (simpl *Simplifier) rangedValue(minValue, maxValue int64) bool {
-	simpl.rawValueHandler(minValue, maxValue)
+func (simpl *Simplifier) rangedValue(minValue, maxValue int64, formatter RawValueFormatter) bool {
+	simpl.rawValueHandler(minValue, maxValue, formatter)
 	return true
 }
 

src/github.com/inkyblackness/res/data/interpreters/Simplifier_test.go

@@ -15,7 +15,7 @@ func (suite *SimplifierSuite) SetUpTest(c *check.C) {
 func (suite *SimplifierSuite) TestRawValueCallsHandler(c *check.C) {
 	var calledMinValue int64
 	var calledMaxValue int64
-	rawHandler := func(minValue, maxValue int64) {
+	rawHandler := func(minValue, maxValue int64, formatter RawValueFormatter) {
 		calledMinValue, calledMaxValue = minValue, maxValue
 	}
 	simpl := NewSimplifier(rawHandler)
@@ -27,7 +27,7 @@ func (suite *SimplifierSuite) TestRawValueCallsHandler(c *check.C) {
 }
 
 func (suite *SimplifierSuite) TestEnumValueReturnsFalseIfNoHandlerRegistered(c *check.C) {
-	simpl := NewSimplifier(func(minValue, maxValue int64) {})
+	simpl := NewSimplifier(func(minValue, maxValue int64, formatter RawValueFormatter) {})
 
 	result := simpl.enumValue(map[uint32]string{})
 
@@ -36,7 +36,7 @@ func (suite *SimplifierSuite) TestEnumValueReturnsFalseIfNoHandlerRegistered(c *
 
 func (suite *SimplifierSuite) TestEnumValueCallsRegisteredHandler(c *check.C) {
 	result := map[uint32]string{}
-	simpl := NewSimplifier(func(minValue, maxValue int64) {})
+	simpl := NewSimplifier(func(minValue, maxValue int64, formatter RawValueFormatter) {})
 	simpl.SetEnumValueHandler(func(values map[uint32]string) {
 		result = values
 	})

src/github.com/inkyblackness/res/data/levelobj/Barriers.go

@@ -1,15 +1,36 @@
 package levelobj
 
 import (
+	"fmt"
+
 	"github.com/inkyblackness/res/data/interpreters"
 )
 
 var baseBarrier = interpreters.New().
 	With("LockVariableIndex", 0, 2).As(interpreters.RangedValue(0, 0x1FF)).
 	With("LockMessageIndex", 2, 1).
-	With("ForceDoorColor", 3, 1).
-	With("RequiredAccessLevel", 4, 1).
-	With("AutoCloseTime", 5, 1).
+	With("ForceDoorColor", 3, 1).As(interpreters.FormattedRangedValue(0, 255,
+	func(value int64) (result string) {
+		if colorText, defined := forceColors[value]; defined {
+			result = fmt.Sprintf("%s  - raw: %d", colorText, value)
+		} else {
+			result = fmt.Sprintf("%d", value)
+		}
+		return result
+	})).
+	With("RequiredAccessLevel", 4, 1).As(interpreters.FormattedRangedValue(0, 30,
+	func(value int64) (result string) {
+		if accessLevel, known := accessLevelMasks[1<<uint32(value)]; known {
+			result = fmt.Sprintf("%s  - raw: %d", accessLevel, value)
+		} else {
+			result = fmt.Sprintf("Unknown  - raw: %d", value)
+		}
+		return
+	})).
+	With("AutoCloseTime", 5, 1).As(interpreters.FormattedRangedValue(0, 255,
+	func(value int64) string {
+		return fmt.Sprintf("%.2f sec  - raw: %d", float64(value)*0.5, value)
+	})).
 	With("OtherObjectIndex", 6, 2).As(interpreters.ObjectIndex())
 
 func initBarriers() interpreterRetriever {

src/github.com/inkyblackness/res/data/levelobj/ForceColors.go

@@ -0,0 +1,17 @@
+package levelobj
+
+var forceColors = map[int64]string{
+	0: "Default (red)",
+
+	247: "Gray, medium",
+	248: "Gray, light",
+
+	249: "Red, light",
+	250: "Green, light",
+	251: "Blue, light",
+
+	252: "Invisible",
+
+	253: "Blue, medium",
+	254: "Green, medium",
+	255: "Red, medium"}

src/github.com/inkyblackness/res/data/levelobj/Items.go

@@ -25,7 +25,7 @@ var corpseItem = baseItem.
 var severedHeadItem = baseItem.
 	With("ImageIndex", 2, 1)
 
-var accessMaskDescription = interpreters.Bitfield(map[uint32]string{
+var accessLevelMasks = map[uint32]string{
 	0x00000001: "None",
 	0x00000002: "Generic1",
 	0x00000004: "Generic2",
@@ -59,7 +59,9 @@ var accessMaskDescription = interpreters.Bitfield(map[uint32]string{
 	0x08000000: "Personal4",
 	0x10000000: "Personal5",
 	0x20000000: "Personal6",
-	0x40000000: "Personal7"})
+	0x40000000: "Personal7"}
+
+var accessMaskDescription = interpreters.Bitfield(accessLevelMasks)
 
 var accessCardItem = baseItem.
 	With("Ignored0000", 0, 2).As(interpreters.SpecialValue("Ignored")).

src/github.com/inkyblackness/res/data/levelobj/Panels.go

@@ -1,6 +1,8 @@
 package levelobj
 
 import (
+	"fmt"
+
 	"github.com/inkyblackness/res/data/interpreters"
 	"github.com/inkyblackness/res/data/levelobj/actions"
 	"github.com/inkyblackness/res/data/levelobj/conditions"
@@ -38,7 +40,10 @@ var cyberspaceTerminal = gameVariablePanel.
 
 var energyChargeStation = gameVariablePanel.
 	With("EnergyDelta", 6, 4).As(interpreters.RangedValue(0, 255)).
-	With("RechargeTime", 10, 4).As(interpreters.RangedValue(0, 3600)).
+	With("RechargeTime", 10, 4).As(interpreters.FormattedRangedValue(0, 3600,
+	func(value int64) string {
+		return fmt.Sprintf("%d sec", value)
+	})).
 	With("TriggerObjectIndex", 14, 4).As(interpreters.ObjectIndex()).
 	With("RechargedTimestamp", 18, 4)
 

src/github.com/inkyblackness/res/data/levelobj/Scenery.go

@@ -1,6 +1,8 @@
 package levelobj
 
 import (
+	"fmt"
+
 	"github.com/inkyblackness/res/data/interpreters"
 )
 
@@ -48,15 +50,23 @@ var securityCamera = baseScenery.
 	With("PanningSwitch", 2, 1).As(interpreters.EnumValue(map[uint32]string{0: "Stationary", 1: "Panning"}))
 
 var solidBridge = baseScenery.
-	With("Size", 2, 1).
-	With("Height", 3, 1).
-	With("TopBottomTexture", 4, 1).
-	With("SideTexture", 5, 1)
+	With("Size", 2, 1).As(interpreters.Bitfield(map[uint32]string{0x0F: "X", 0xF0: "Y"})).
+	With("Height", 3, 1).As(interpreters.SpecialValue("ObjectHeight")).
+	With("TopBottomTexture", 4, 1).As(interpreters.SpecialValue("MaterialOrLevelTexture")).
+	With("SideTexture", 5, 1).As(interpreters.SpecialValue("MaterialOrLevelTexture"))
 
 var forceBridge = baseScenery.
-	With("Size", 2, 1).
-	With("Height", 3, 1).
-	With("Color", 6, 1)
+	With("Size", 2, 1).As(interpreters.Bitfield(map[uint32]string{0x0F: "X", 0xF0: "Y"})).
+	With("Height", 3, 1).As(interpreters.SpecialValue("ObjectHeight")).
+	With("Color", 6, 1).As(interpreters.FormattedRangedValue(0, 255,
+	func(value int64) (result string) {
+		if colorText, defined := forceColors[value]; defined {
+			result = fmt.Sprintf("%s  - raw: %d", colorText, value)
+		} else {
+			result = fmt.Sprintf("%d", value)
+		}
+		return result
+	}))
 
 func initScenery() interpreterRetriever {
 	displays := newInterpreterLeaf(displayScenery)

src/github.com/inkyblackness/res/data/levelobj/actions/actions.go

@@ -1,6 +1,8 @@
 package actions
 
 import (
+	"fmt"
+
 	"github.com/inkyblackness/res/data/interpreters"
 )
 
@@ -50,15 +52,19 @@ var showCutsceneDetails = interpreters.New().
 	With("CutsceneIndex", 0, 4).As(interpreters.EnumValue(map[uint32]string{0: "Death", 1: "Intro", 2: "Ending"})).
 	With("EndGameFlag", 4, 4).As(interpreters.EnumValue(map[uint32]string{0: "No (not working)", 1: "Yes"}))
 
+func pointOneSecond(value int64) string {
+	return fmt.Sprintf("%.1f sec", float64(value)*0.1)
+}
+
 var triggerOtherObjectsDetails = interpreters.New().
 	With("Object1Index", 0, 2).As(interpreters.ObjectIndex()).
-	With("Object1Delay", 2, 2).As(interpreters.RangedValue(0, 6000)).
+	With("Object1Delay", 2, 2).As(interpreters.FormattedRangedValue(0, 6000, pointOneSecond)).
 	With("Object2Index", 4, 2).As(interpreters.ObjectIndex()).
-	With("Object2Delay", 6, 2).As(interpreters.RangedValue(0, 6000)).
+	With("Object2Delay", 6, 2).As(interpreters.FormattedRangedValue(0, 6000, pointOneSecond)).
 	With("Object3Index", 8, 2).As(interpreters.ObjectIndex()).
-	With("Object3Delay", 10, 2).As(interpreters.RangedValue(0, 6000)).
+	With("Object3Delay", 10, 2).As(interpreters.FormattedRangedValue(0, 6000, pointOneSecond)).
 	With("Object4Index", 12, 2).As(interpreters.ObjectIndex()).
-	With("Object4Delay", 14, 2).As(interpreters.RangedValue(0, 6000))
+	With("Object4Delay", 14, 2).As(interpreters.FormattedRangedValue(0, 6000, pointOneSecond))
 
 var changeLightingDetails = interpreters.New().
 	Refining("ObjectExtent", 0, 2, interpreters.New().With("Index", 0, 2).As(interpreters.ObjectIndex()), func(inst *interpreters.Instance) bool {