class ProjectConfig

book_4_sparkGenerated
code_blocksInput

Description

The ProjectConfig class provides configuration settings for a Sandbox Project. It includes properties and methods to manage metadata, directories, and other project-specific settings.

Members

Instance Members

Member NameSummary
ToJsonSerialize the entire config to a JSON string.
TryGetMetaAttempts to retrieve metadata by key name.
GetMetaOrDefaultGets metadata by key name or returns a default value if not found.
SetMetaSets metadata for a given key name.
DirectoryThe directory housing this addon (TODO).
AssetsDirectoryThe directory housing this addon (TODO).
TitleThe human readable title, for example "Sandbox", "Counter-Strike".
TypeThe type of addon. Current valid values are "game".
OrgThe ident of the org that owns this addon. For example "facepunch", "valve".
IdentThe ident of this addon. For example "sandbox", "cs" or "dm98".
PackageTypeType of the package.
FullIdentReturns a combination of Org and Ident - for example "facepunch.sandbox" or "valve.cs".
SchemaThe version of the addon file. Allows us to upgrade internally.
IncludeSourceFilesIf true then we'll include all the source files.
ResourcesA list of paths in which to look for extra assets to upload with the addon. Note that compiled asset files are automatically included.
PackageReferencesA list of packages that this package depends on. These should be installed alongside this package.
EditorReferencesA list of packages that this package uses but there is no need to install. For example, a map package might use a model package - but there is no need to download that model package because any usage will organically be included in the manifest. However, when loading this item in the editor, it'd make sense to install these 'cloud' packages.
IsWhitelistDisabledWhether or not this project has the whitelist disabled. If this is the case, it can only be exported, and cannot be uploaded to sbox.game.
MetadataCustom key-value storage for this project.