-
Notifications
You must be signed in to change notification settings - Fork 32
File Structure
Important to note: the current CFrame of the part is not included, it is included by it's parent or calculated from the parent (using attachments and the CFrame of the parent for example)
| Meaning | Type | Size (bytes) |
|---|---|---|
| Shape of part | Shape | 28 |
| Properties | PartProperties | 48 |
| User defined fields | ... | ? |
| Meaning | Type | Size (bytes) |
|---|---|---|
| shape class ID | uint32_t | 4 |
| shape width | double | 8 |
| shape height | double | 8 |
| shape depth | double | 8 |
The shapeClass IDs are managed with a SharedObjectSerializer, so builtin ShapeClasses such as boxClass, sphereClass, cylinderClass
| ID | Name |
|---|---|
| 0 | boxClass |
| 1 | sphereClass |
| 2 | cylinderClass |
Custom builtin ShapeClasses, such as polyhedra known to the reader of the file, will receive ids starting at the end of this list.
Shapeclasses that are embedded in the file, such as polyhedra receive ids based on their order in the header, counting down from UINT_MAX. So the first ShapeClass in the list will get ID 0xFFFFFFFF, the second 0xFFFFFFFE etc.
| Meaning | Type | Size (bytes) |
|---|---|---|
| density | double | 8 |
| friction | double | 8 |
| bouncyness | double | 8 |
| conveyorEffect | Vec3 | 24 |
| Meaning | Type | Size (bytes) |
|---|---|---|
| cframe of part | GlobalCFrame | 96 |
| part | Part | 76+? |
| Meaning | Type | Size (bytes) |
|---|---|---|
| motion of global Center Of Mass | Motion | 96 |
| CFrame of main part | GlobalCFrame | 96 |
| Main Physical | Physical | PhysicalSize |
| Meaning | Type | Size (bytes) |
|---|---|---|
| rigidBody of Physical | RigidBody | 4 + PartSize + (N-1) * (96 + PartSize) |
| number of attached physicals | uint32_t | 4 |
| List of Connected Physicals | ConnectedPhysical[C] | sum(ConnectedPhysicalSize) |
N is the total Number of parts in the RigidBody
| Meaning | Type | Size (bytes) |
|---|---|---|
| Main Part | Part* | PartSize |
| number of attached parts | uint32_t | 4 |
| attached parts | AttachedPart[N-1] | (N-1) * (96 + PartSize) |
| Meaning | Type | Size (bytes) |
|---|---|---|
| Attachment to main | CFrame | 96 |
| Attached Part | Part* | PartSize |
| Meaning | Type | Size (bytes) |
|---|---|---|
| constraint attach to this | CFrame | 96 |
| constraint attach to parent | CFrame | 96 |
| constraint itself | HardConstraint | 4 + ConstraintSize |
| information on this Physical | Physical | PhysicalSize |
This is a dynamically serialized type
| Identifier | Name | Extra Data | Size (bytes) |
|---|---|---|---|
| 0 | FixedConstraint | / | 0 |
| 1 | MotorConstraint | Vec3 angularVelocity double currentAngle |
32 |
| Meaning | Type | Size (bytes) |
|---|---|---|
| version ID | uint32_t | 4 |
| number of serialized ShapeClasses | uint32_t | 4 |
| shared shapeClasses | ShapeClass[ShapeClassCount] | sum(ShapeClassSize) |
The latest version ID is 0
| Meaning | Type | Size (bytes) |
|---|---|---|
| externalForceCount | uint64_t | 8 |
| External Forces | ExternalForce[externalForceCount] | / |
| Age of world | uint64_t | 8 |
| Shared File Header | * | / |
| number of Physicals | uint64_t | 8 |
| number of terrain Parts | uint64_t | 8 |
| physicals | MotorizedPhysical[PhysicalCount] | sum(MotorizedPhysicalSize) |
| terrain Parts | PartWithCFrame[TerrainPartCount] | TerrainPartCount * PartWithCFrameSize |
This is a dynamically serialized type
| Identifier | Name | Extra Data | Size (bytes) |
|---|---|---|---|
| 0 | DirectionalGravity | Vec3 gravity | 24 |
This is a dynamically serialized type
| Identifier | Name | Extra Data | Size (bytes) |
|---|---|---|---|
| 0 | NormalizedPolyhedron | uint32_t vertexCount uint32_t triangleCount Vec3f[] vertices Triangle[] triangles |
8 + vertexCount * 12 + triangleCount * 12 |
Dynamically serializable types must be registered in a DynamicSerializerRegistry
When serialized using the dynamic serializer, the resulting byte stream will be an integer denoting the type, and then any information needed to deserialize the type. When deserializing, the dynamic deserializer reads the type int, and then hands off deserialization to the appropriate deserializer.
When objects are shared among different objects, a registry of these objects first has to be constructed, where an ID is assigned to each shared object. The IDs are then stored instead
This can be done using a SharedObjectSerializer.