Difference between revisions of "Sims 3:Catalog Resource"

Latest revision as of 05:32, 30 March 2012

[edit] Overview

The following resource types are used for catalog entries.

[edit] Format

[edit] Common

This block appears in all Catalog Resources. The name and description GUIDs can be looked up in the STBL.

DWORD Version		// Earliest seen is 0x0000000C
QWORD Name GUID		// Key into STBL for localised value to display
QWORD Desc GUID		// Key into STBL for localised value to display
7BITSTR			// "Internal" Catalog Name
7BITSTR			// "Internal" Catalog Description
FLOAT price
FLOAT NicenessMultiplier	// always 1.0
FLOAT CrapScore		// binary zeros
BYTE (BuildBuyProductStatusFlags)
QWORD IID of PNG icon	// When not zero, this is the catalogue thumbnail;
			// otherwise image is found by IID matching (see below)
BYTE //0x00
FLOAT EnvironmentScore
DWORD FireType //0=DoesNotBurn,1=Chars,2=AshPile
BYTE IsStealable //boolean
BYTE IsReposessable //boolean
DWORD UISortIndex
--if Version >= 0x0000000D
	BYTE isPlaceableOnRoof //boolean
	--if Version >= 0x0000000E
		BYTE isVisibleInWorldbuilder //boolean
		--if Version >= 0x0000000F
			DWORD ProductName //hashed

[edit] Common Flags

[edit] Thumbnail

There are two ways of finding the thumbnails for a catalogue resource, depending on if IID of PNG icon is zero or not. The Resource Type is always one of three values (representing small, medium or large). Medium is the type of small plus 1; large is the type of small plus 2. There can be multiple thumbnails, differing only in their group, representing the different default appearances for the catalogue resource.

When non-zero

Thumbnail Types
0x2E75C764, 0x2E75C765, 0x2E75C766

The IID of the thumbnail is IID of PNG icon.

When zero

The thumbnail resource type type depends on the catalogue resource type:

Catalogue Type[4]	Thumbnail Types
Object Proxy Product Terrain Geometry Brush Terrain Water Brush Foundation[1] Roof Style Roof Pattern	0x0580A2B4, 0x0580A2B5, 0x0580A2B6
Fence	0x2653E3C8, 0x2653E3C9, 0x2653E3CA
Stairs	0x5DE9DBA0, 0x5DE9DBA1, 0x5DE9DBA2
Railing	0x2D4284F0, 0x2D4284F1, 0x2D4284F2
Terrain Paint Brush	0x05B1B524, 0x05B1B525, 0x05B1B526
Fireplace[2]	0x05B17698, 0x05B17699, 0x05B1769A
Wall/Floor Pattern[3]	0x0589DC44, 0x0589DC45, 0x0589DC46

The IID of the thumbnail is the IID of the catalog resource.

Notes

^[1] I'm not sure this has been verified. (PLJ: seems to work...)

^[2] s3oc shows the thumbnail for the first OBJD rather than this.

^[3] For all catalogue resources apart from Wall/Floor Pattern, a thumb with a Resource Group of zero is acceptable; for Wall/Floor Patterns, however, a non-zero Resource Group is needed.

^[4] Walls do not have thumbnails.

[edit] Material List

ObjectMaterialList

This section is only present in Objects, Fences (EP1+), Railings (EP1+) and Wall/Floor Patterns; it differs slightly for Wall/Floor Patterns, as annotated below.

[edit] Purpose

This is a list of all preset color options that a Catalog Resource has. Each preset has different settings for patterns used and colors applied. They are listed in the order that they appear in game. You can safely delete them. (The screen shot shows how they are presented in s3pe.)

[edit] Format

DWORD Count1
--repetition Count1 Material:
	BYTE type
	if (type != 1) DWORD
	DWORD offset		// from here to after TGI Block List
	WORD
	DWORD tgi offset	// see Sims 3:Key table
	DWORD tgi size		// see Sims 3:Key table
	--insert Material Block
	--insert TGI Block List	// see Sims 3:Key table
	DWORD ID
	--if Wall/Floor Style:
		DWORD Category //varies on type(wall or floor)
		DWORD GroupName // hashed 
		DWORD GroupSort

[edit] Common Values

Not all values are present in all catalog resources.

[edit] Notes

1. Walls - Changing to 0x00 - Entire wall disappears from catalog with all presets
2. Present for Walls/Floors
3. Values must be non-zero and unique. Changing the value does not re-order them in catalog but walls will show the thumb/catalog in new order but does not move the actual wall preset order.

[edit] Material Block

This block holds the variables used in the complate to render a texture. TGI Block List indexes refer to the TGI Block List following this Material Block.

BYTE index     // TGI Block List entry for Complate XML to which these variables should be applied
Complate String Name
Complate String Pattern
DWORD count1
--repetition count1 Complate Variable List:
	Complate String variableName
	BYTE   typecode
	--insert data for typecode	// see below
DWORD count2
--repeat(count2)
	Material Block		// sub-blocks used for pattern definitions

[edit] Complate Variables

Complate variables are referenced by the same strings as they are in the Complate XML. All the standard complate elements are indexed via the string table so are not typically included as a literal string.

To read the string

1. First read a byte(A).
2. If A & 0x80 != 0, it is a literal string, otherwise it is an index into the string table.
3. If A & 0x40 == 0, The index will be (A), or the length will be (B&0x7F).
4. If A & 0x40 != 0, read a second byte(B). The index will be (A+B), or the length will be (B).

ex. in C#

static string ReadString(BinaryReader br)
{
	int a = br.ReadByte();
	if (a == 0) return string.Empty;
	if ((a & 0x80) != 0)
	{
               return Encoding.ASCII.GetString(br.ReadBytes((a & 0x40) != 0 ? br.ReadByte() : a & 0x3F));
	}
	if ((a & 0x40) != 0) a = (a & 0x3F) + br.ReadByte(); 	
	return StringDb[a];
}

[edit] Typecodes

[edit] Brush Common

The basis for the brush type catalog resources

[edit] Format

DWORD Version
--Insert CommonBlock
DWORD NormalOperation
DWORD OppositeOperation

//ProfileTexture PNG TGI
DWORD Type
DWORD Group
QWORD Instance

DWORD Orientation
FLOAT BrushWidth
FLOAT BrushStrength
BYTE  BaseTextureValue
FLOAT WiggleAmount

[edit] Brush Operations

[edit] Brush Orientations