Class TinyProjectSettings

Placeholder implementation.

This class should be used as the root entry point for all project and platform settings.

Currently this is used as a place to dump all settings for all platforms.

Inheritance

System.Object

TinyProjectSettings

Namespace: Unity.Tiny

Syntax

public sealed class TinyProjectSettings : IPropertyContainer, IPropertyContainer

Constructors

TinyProjectSettings(IVersionStorage)

Declaration

public TinyProjectSettings(IVersionStorage versionStorage)

Parameters

Type	Name	Description
IVersionStorage	versionStorage

Properties

CanvasAutoResize

Whether or not the rendered output should resize according to the host canvas element size.

Declaration

public bool CanvasAutoResize { get; set; }

Property Value

Type	Description
System.Boolean

CanvasAutoResizeProperty

CanvasAutoResize property.

Declaration

public static ValueClassProperty<TinyProjectSettings, bool> CanvasAutoResizeProperty { get; }

Property Value

Type	Description
ValueClassProperty<TinyProjectSettings, System.Boolean>

CanvasHeight

Rendered output height, in pixels.

Declaration

public int CanvasHeight { get; set; }

Property Value

Type	Description
System.Int32

CanvasHeightProperty

CanvasHeight property.

Declaration

public static ValueClassProperty<TinyProjectSettings, int> CanvasHeightProperty { get; }

Property Value

Type	Description
ValueClassProperty<TinyProjectSettings, System.Int32>

CanvasWidth

Rendered output width, in pixels.

Declaration

public int CanvasWidth { get; set; }

Property Value

Type	Description
System.Int32

CanvasWidthProperty

CanvasWidth property.

Declaration

public static ValueClassProperty<TinyProjectSettings, int> CanvasWidthProperty { get; }

Property Value

Type	Description
ValueClassProperty<TinyProjectSettings, System.Int32>

DefaultAnimationClipSettings

Default animation clip export settings.

Declaration

public TinyAnimationClipSettings DefaultAnimationClipSettings { get; set; }

Property Value

Type	Description
TinyAnimationClipSettings

DefaultAnimationClipSettingsProperty

DefaultAnimationClipSettings property.

Declaration

public static ClassValueClassProperty<TinyProjectSettings, TinyAnimationClipSettings> DefaultAnimationClipSettingsProperty { get; }

Property Value

Type	Description
ClassValueClassProperty<TinyProjectSettings, TinyAnimationClipSettings>

DefaultAudioClipSettings

Default audio clip export settings.

Declaration

public TinyAudioClipSettings DefaultAudioClipSettings { get; set; }

Property Value

Type	Description
TinyAudioClipSettings

DefaultAudioClipSettingsProperty

DefaultAudioClipSettings property.

Declaration

public static ClassValueClassProperty<TinyProjectSettings, TinyAudioClipSettings> DefaultAudioClipSettingsProperty { get; }

Property Value

Type	Description
ClassValueClassProperty<TinyProjectSettings, TinyAudioClipSettings>

DefaultTextureSettings

Default texture export settings.

Declaration

public TinyTextureSettings DefaultTextureSettings { get; set; }

Property Value

Type	Description
TinyTextureSettings

DefaultTextureSettingsProperty

DefaultTextureSettings property.

Declaration

public static ClassValueClassProperty<TinyProjectSettings, TinyTextureSettings> DefaultTextureSettingsProperty { get; }

Property Value

Type	Description
ClassValueClassProperty<TinyProjectSettings, TinyTextureSettings>

EmbedAssets

Whether or not to embed (inline as data URLs) assets in the generated output by default. Each asset can override this setting.

Declaration

public bool EmbedAssets { get; set; }

Property Value

Type	Description
System.Boolean

EmbedAssetsProperty

EmbedAssets property.

Declaration

public static ValueClassProperty<TinyProjectSettings, bool> EmbedAssetsProperty { get; }

Property Value

Type	Description
ValueClassProperty<TinyProjectSettings, System.Boolean>

IncludeWebPDecompressor

Ensure that WebP textures can be decompressed on any platform. This impacts code size.

Declaration

public bool IncludeWebPDecompressor { get; set; }

Property Value

Type	Description
System.Boolean

IncludeWebPDecompressorProperty

IncludeWebPDecompressor property.

Declaration

public static ValueClassProperty<TinyProjectSettings, bool> IncludeWebPDecompressorProperty { get; }

Property Value

Type	Description
ValueClassProperty<TinyProjectSettings, System.Boolean>

LinkToSource

Reference the generated JavaScript output file directly for faster iterations. Development configurations only.

Declaration

public bool LinkToSource { get; set; }

Property Value

Type	Description
System.Boolean

LinkToSourceProperty

LinkToSource property.

Declaration

public static ValueClassProperty<TinyProjectSettings, bool> LinkToSourceProperty { get; }

Property Value

Type	Description
ValueClassProperty<TinyProjectSettings, System.Boolean>

LocalHTTPServerPort

Port used to serve Tiny content over HTTP.

Declaration

public int LocalHTTPServerPort { get; set; }

Property Value

Type	Description
System.Int32

LocalHTTPServerPortProperty

LocalHTTPServerPort property.

Declaration

public static ValueClassProperty<TinyProjectSettings, int> LocalHTTPServerPortProperty { get; }

Property Value

Type	Description
ValueClassProperty<TinyProjectSettings, System.Int32>

LocalWSServerPort

Port used to establish a connection between the Editor and Tiny players.

Declaration

public int LocalWSServerPort { get; set; }

Property Value

Type	Description
System.Int32

LocalWSServerPortProperty

LocalWSServerPort property.

Declaration

public static ValueClassProperty<TinyProjectSettings, int> LocalWSServerPortProperty { get; }

Property Value

Type	Description
ValueClassProperty<TinyProjectSettings, System.Int32>

MemorySize

Fixed Emscripten heap memory size, in MBs.

Declaration

public int MemorySize { get; set; }

Property Value

Type	Description
System.Int32

MemorySizeProperty

MemorySize property.

Declaration

public static ValueClassProperty<TinyProjectSettings, int> MemorySizeProperty { get; }

Property Value

Type	Description
ValueClassProperty<TinyProjectSettings, System.Int32>

MinifyJavaScript

Minify JavaScript game code. Release configuration only.

Declaration

public bool MinifyJavaScript { get; set; }

Property Value

Type	Description
System.Boolean

MinifyJavaScriptProperty

MinifyJavaScript property.

Declaration

public static ValueClassProperty<TinyProjectSettings, bool> MinifyJavaScriptProperty { get; }

Property Value

Type	Description
ValueClassProperty<TinyProjectSettings, System.Boolean>

PropertyBag

Declaration

public IPropertyBag PropertyBag { get; }

Property Value

Type	Description
IPropertyBag

RenderMode

Initial player rendering mode.

Declaration

public RenderingMode RenderMode { get; set; }

Property Value

Type	Description
RenderingMode

RenderModeProperty

RenderMode property.

Declaration

public static ValueClassProperty<TinyProjectSettings, RenderingMode> RenderModeProperty { get; }

Property Value

Type	Description
ValueClassProperty<TinyProjectSettings, RenderingMode>

RunBabel

Transpile the JavaScript game code to portable ECMA5.

Declaration

public bool RunBabel { get; set; }

Property Value

Type	Description
System.Boolean

RunBabelProperty

RunBabel property.

Declaration

public static ValueClassProperty<TinyProjectSettings, bool> RunBabelProperty { get; }

Property Value

Type	Description
ValueClassProperty<TinyProjectSettings, System.Boolean>

SingleFileHtml

Inline all JavaScript code in the output HTML file. Release configuration only.

Declaration

public bool SingleFileHtml { get; set; }

Property Value

Type	Description
System.Boolean

SingleFileHtmlProperty

SingleFileHtml property.

Declaration

public static ValueClassProperty<TinyProjectSettings, bool> SingleFileHtmlProperty { get; }

Property Value

Type	Description
ValueClassProperty<TinyProjectSettings, System.Boolean>

SymbolsInReleaseBuild

Whether release builds should include symbols or not. If they do not, they will also be stripped.

Declaration

public bool SymbolsInReleaseBuild { get; set; }

Property Value

Type	Description
System.Boolean

SymbolsInReleaseBuildProperty

SymbolsInReleaseBuild property.

Declaration

public static ValueClassProperty<TinyProjectSettings, bool> SymbolsInReleaseBuildProperty { get; }

Property Value

Type	Description
ValueClassProperty<TinyProjectSettings, System.Boolean>

VersionStorage

Declaration

public IVersionStorage VersionStorage { get; }

Property Value

Type	Description
IVersionStorage

Methods

GetDefaultAssetExportSettings(Type)

Declaration

public TinyAssetExportSettings GetDefaultAssetExportSettings(Type type)

Parameters

Type	Name	Description
Type	type

Returns

Type	Description
TinyAssetExportSettings