Class SerenityRecipe

Root data-transfer object for a .serenity-recipe.json file. This is a plain JsonUtility-serializable description of the Serenity content a project wants; it is read by the importer and turned into real ScriptableObjects through the Unity Editor API.
External tools (including AI assistants) should emit this format instead of authoring Unity .asset/.meta files, GUIDs, or serialized YAML directly.

Inheritance

object

SerenityRecipe

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Namespace: Serenity.ProjectRecipe.Infrastructure.Editor.Model

Assembly: Serenity.UnityProjectRecipe.Infrastructure.Editor.dll

Syntax

public class SerenityRecipe

Remarks

Every section modelled here has an exporter and an importer. The sections older recipes declared and no handler ever filled are gone from the schema; RecipeRetiredSectionReporter still reports a recipe that carries one, because UnityEngine.JsonUtility drops unknown JSON keys without warning.

Constructors

SerenityRecipe()

Declaration

public SerenityRecipe()

Fields

achievements

Declaration

public RecipeAchievementDto[] achievements

Field Value

Type	Description
RecipeAchievementDto[]	Achievement definitions to create or update, unlock condition tree included. Each entry may optionally generate a companion UnityEventDispatcherSignalDefinition trigger that unlocks it (set generateTrigger: true).

assets

Declaration

public RecipeGenericAssetDto[] assets

Field Value

Type	Description
RecipeGenericAssetDto[]	Generic Serenity ScriptableObjects captured field-by-field — composite views, UI themes, action definitions, and every settings/config asset that has no dedicated typed section above. Includes polymorphic [SerializeReference] signal graphs.

audioClips

Declaration

public RecipeAudioClipDto[] audioClips

Field Value

Type	Description
RecipeAudioClipDto[]	AudioPlayer clip definitions to create or update.

cutscenes

Declaration

public RecipeCutsceneDto[] cutscenes

Field Value

Type	Description
RecipeCutsceneDto[]	Cutscene definitions to create or update (ordered stages + optional rig prefab).

feedbacks

Declaration

public RecipeFeedbackDto[] feedbacks

Field Value

Type	Description
RecipeFeedbackDto[]	Feedback definitions to create or update. Each entry may optionally generate a companion UnityEventDispatcherSignalDefinition trigger (set generateTrigger: true).

importOptions

Declaration

public RecipeImportOptionsDto importOptions

Field Value

Type	Description
RecipeImportOptionsDto	Optional import behaviour overrides. May be null, in which case defaults apply.

localization

Declaration

public RecipeLocalizationDto[] localization

Field Value

Type	Description
RecipeLocalizationDto[]	Unity Localization String Table Collections to create or update — locales and per-key translations. Generated by LocalizationRecipeImporter (which ships in the localization assembly).

menus

Declaration

public RecipeMenuDto[] menus

Field Value

Type	Description
RecipeMenuDto[]	Menu definitions to create or update: layout, options with their bindings, signal wiring.

modals

Declaration

public RecipeModalDto[] modals

Field Value

Type	Description
RecipeModalDto[]	Modal definitions to create or update: content, layout, options with their bindings and signals.

musicTracks

Declaration

public RecipeMusicTrackDto[] musicTracks

Field Value

Type	Description
RecipeMusicTrackDto[]	Music track definitions to create or update.

outputRoot

Declaration

public string outputRoot

Field Value

Type	Description
string	Project-relative root folder (under Assets/) that all generated assets live beneath.

projectName

Declaration

public string projectName

Field Value

Type	Description
string	Human-readable name of the project the recipe describes. Informational only.

schemaVersion

Declaration

public string schemaVersion

Field Value

Type	Description
string	Schema version of this recipe document (e.g. "1.0.0").