Scriban

Updated 2 days ago

1 - How to use the properties

By default, properties of the Crate for the Spawnable being spawned are imported. What that means is you can access any property of that crate just by writing the properties name.

For example:

{{ tags | array.contains `NPC` }}

2 - Types

2.1 - Crate

Crates hold the actual spawnable.

Type (type: CrateType)

This property provides what kind of Crate is it. Available values: Spawnable, Avatar, Level, VFX

Barcode (type: string)

This is a unique identifier for the Crate, no other Crate can have the same one

Title (type: string)

This is the title of the Crate. This is intended to be shown in for example the Spawn Gun

Description (type: string)

This is the description of the Crate. This is intended to be shown in for example the Spawn Gun

Redacted (type: boolean)

Whether or not the Crate should be accessible to the player.

Unlockable (type: boolean)

Whether or not the Crate can be unlocked by the player. (using the Gacha Machine)

Tags (type: array<string>)

This is a list of tags (strings/text). Tags are usually intended to mark their core functionality. For example NPCs usually have the tag NPC.

BoneTags (type: array<BoneTag>)

This is a list of Bone Tags. BoneTags provide references to things like the Player.

Pallet (type: Pallet)

This is the Pallet that contains the crate.

2.2 - Pallet

Pallets contain the information about the mod, they also hold all of the crates

Barcode (type: string)

This is a unique identifier for the Pallet, no other Pallet can have the same one

Title (type: string)

This is the title of the Pallet. This is intended to be shown in for example the Spawn Gun

Description (type: string)

This is the description of the Pallet. This is intended to be shown in for example the Spawn Gun

Author (type: string)

This property has the author of the Pallet. This can be used to filter pallets by author in the Spawn Gun

Redacted (type: boolean)

Whether or not the Pallet should be accessible to the player.

Unlockable (type: boolean)

Whether or not the Pallet can be unlocked by the player.

Tags (type: array<string>)

This is a list of tags (strings/text). Tags are usually intended to mark their core functionality. For example NPCs usually have the tag NPC.

Version (type: string)

This is the version of the Pallet.

SDKVersion (type: string)

This is the version of the MarrowSDK.

Crates (type: array<Crate>)

This is a list of Crates that the Pallet contains.

ChangeLogs (type: array<ChangeLog>)

This is a list of ChangeLogs. The array contains a ChangeLog for each version, if provided by the mod creator.

DataCards (type: array<DataCard>)

This is a list of DataCards. DataCards contain music and ambience tracks and/or BoneTags (BoneTag = DataCard)

Dependencies (type: array<string>)

This is a list of dependencies.

2.3 - ChangeLog

A ChangeLog provides details about what was changed in a provided version

Title (type: string)

This is the title of the ChangeLog.

Version (type: string)

This is the version that the ChangeLog is for

Text (type: string)

This is the text. It contains the actual list of changes in the version, if provided by the mod creator

2.4 - DataCard/BoneTag

DataCard and BoneTag are basically the same. DataCards contain music and ambience tracks and/or BoneTags

Barcode (type: string)

This is a unique identifier for the DataCard, no other DataCard can have the same one

Title (type: string)

This is the title of the DataCard.

Description (type: string)

This is the description of the DataCard.

Redacted (type: boolean)

Whether or not the DataCard should be accessible to the player.

Unlockable (type: boolean)

Whether or not the DataCard can be unlocked by the player.