Files
FlaxEngine/Source/Editor/Content/Proxy/SettingsProxy.cs

108 lines
3.7 KiB
C#

// Copyright (c) 2012-2022 Wojciech Figat. All rights reserved.
using System;
using FlaxEditor.Content.Create;
using FlaxEditor.Content.Settings;
using FlaxEngine;
namespace FlaxEditor.Content
{
/// <summary>
/// Content proxy for json settings assets (e.g <see cref="GameSettings"/> or <see cref="TimeSettings"/>).
/// </summary>
/// <seealso cref="FlaxEditor.Content.JsonAssetProxy" />
[ContentContextMenu("New/Settings")]
public class SettingsProxy : JsonAssetProxy
{
private readonly Type _type;
private readonly SpriteHandle _thumbnail;
/// <summary>
/// Gets the settings type.
/// </summary>
public Type Type => _type;
/// <summary>
/// Initializes a new instance of the <see cref="SettingsProxy"/> class.
/// </summary>
/// <param name="type">The settings asset type (must be subclass of SettingsBase type).</param>
/// <param name="thumbnail">Asset icon.</param>
public SettingsProxy(Type type, SpriteHandle thumbnail)
{
_type = type;
TypeName = type.FullName;
_thumbnail = thumbnail;
}
/// <inheritdoc />
public override string Name => "Settings";
//public override string Name { get; } = Utilities.Utils.GetPropertyNameUI(_type.Name);
/// <inheritdoc />
public override bool CanCreate(ContentFolder targetLocation)
{
// Use proxy only for GameSettings for creating
if (_type != typeof(GameSettings))
return false;
return targetLocation.CanHaveAssets;
}
/// <inheritdoc />
public override void Create(string outputPath, object arg)
{
Editor.Instance.ContentImporting.Create(new SettingsCreateEntry(outputPath));
}
/// <inheritdoc />
public override AssetItem ConstructItem(string path, string typeName, ref Guid id)
{
return new JsonAssetItem(path, id, typeName, _thumbnail);
}
/// <inheritdoc />
public override bool IsProxyFor<T>()
{
return typeof(T) == _type;
}
/// <inheritdoc />
public override string TypeName { get; }
}
/// <summary>
/// Content proxy for custom json settings assets.
/// </summary>
/// <seealso cref="FlaxEditor.Content.SettingsProxy" />
/// <seealso cref="FlaxEditor.Content.JsonAssetProxy" />
public class CustomSettingsProxy : SettingsProxy
{
/// <summary>
/// The custom settings name.
/// </summary>
public readonly string CustomName;
/// <summary>
/// Initializes a new instance of the <see cref="CustomSettingsProxy"/> class.
/// </summary>
/// <param name="type">The settings asset type (must be subclass of SettingsBase type).</param>
/// <param name="name">The name of the entry in the custom settings (via <see cref="Engine.GetCustomSettings"/>).</param>
public CustomSettingsProxy(Type type, string name)
: this(type, name, Editor.Instance.Icons.Document128)
{
}
/// <summary>
/// Initializes a new instance of the <see cref="CustomSettingsProxy"/> class.
/// </summary>
/// <param name="type">The settings asset type (must be subclass of SettingsBase type).</param>
/// <param name="name">The name of the entry in the custom settings (via <see cref="Engine.GetCustomSettings"/>).</param>
/// <param name="thumbnail">Asset icon.</param>
public CustomSettingsProxy(Type type, string name, SpriteHandle thumbnail)
: base(type, thumbnail)
{
CustomName = name;
}
}
}