Prefab Package

A Prefab Package is essentially a ZIP file containing Prefabs and an index listing those prefabs and additional metadata.

Properties

Name	Type	Default	Access	Description
category	1i	0	🟩🟥	Category
copyrightInfoUrl	1s		🟩🟥	Metadata, link to copyright info
copyrightNotice	1s		🟩🟥	Metadata, copyright notice
copyrightStatus	1i	0	🟩🟥	Metadata, CopyrightStatus
creator	1s		🟩🟥	Metadata, creator of asset
description	1s		🟩🟥	Metadata, description
guid	1s		🟩❌	Globally unique identifier
headline	1s		🟩🟥	Metadata, headline
keywords	1s		🟩🟥	Metadata, keyword
title	1s		🟩🟥	Metadata, title
unitScale	1f	1.0	🟩🟥	Unit scale

Details

Type
1b: boolean
1c: color (integer)
1i: integer
1f: float
1s: string
2b: 2-component boolean vector
2i: 2-component integer vector
2f: 2-component float vector
3b: 3-component boolean vector
3i: 3-component integer vector
3f: 3-component float vector

Access
🟩 : Property value can be read with FxFile.Get
🟥 : Property value can be changed with FxFile.Set
❌ : Property value is read-only and can't be changed

Create

To create a new prefab package use FxFile.Create with FileType 445.

packageID = FxFile.Create(445);
packageID = FxFile.Rename(445, packageID, "MyPackage"); -- rename new package
FxFile.Open(445, packageID); -- open new package

Files

The default prefab package is located at Programs\Foxel Studio\default.fxlpkg. Other custom packages are stored as shared files in Shared\PrefabPackages\ with the extension .fxlpkg.