星火 2.0 开发文档

主题

GameCore.ClientSettings ​

AudioChannel 仅客户端 ​

命名空间 GameCore.ClientSettings

csharp
public enum AudioChannel

Player-facing audio group. Each group writes one or more native sound type gains; it is not the same concept as GameDataSound.Category.

枚举值 ​

  • Music — Background, ambient, and cutscene music.
  • Effects — Game effect sounds, including UI, movement, foley, combat, alerts, and messages.
  • Voice — Voice playback, including in-game dialogue/voice categories and voice chat output.
  • Microphone — Microphone input volume for voice chat.

ClientAudioChannelSettings 仅客户端 ​

命名空间 GameCore.ClientSettings

csharp
public sealed class ClientAudioChannelSettings

Settings for one audio channel.

备注

PIE 暂未完整支持保存与读回，通道修改可能影响编辑器进程；请使用独立客户端调试验证。

属性 ​

Volume 仅客户端 ​

csharp
public int Volume { get; set; }

Channel volume in the range 0 to 100.

Enabled 仅客户端 ​

csharp
public bool Enabled { get; set; }

Whether the channel is enabled. Disabling mutes the channel without changing its stored volume.

ClientAudioSettings 仅客户端 ​

命名空间 GameCore.ClientSettings

csharp
public sealed class ClientAudioSettings

Audio settings persisted on the current device.

备注

PIE 暂未完整支持保存与读回，音量修改可能影响编辑器进程；请使用独立客户端调试验证。

属性 ​

Music 仅客户端 ​

csharp
public ClientAudioChannelSettings Music { get; }

Effects 仅客户端 ​

csharp
public ClientAudioChannelSettings Effects { get; }

Voice 仅客户端 ​

csharp
public ClientAudioChannelSettings Voice { get; }

Microphone 仅客户端 ​

csharp
public ClientAudioChannelSettings Microphone { get; }

索引器 ​

this[] 仅客户端 ​

csharp

ClientGraphicsSettings 仅客户端 ​

命名空间 GameCore.ClientSettings

csharp
public sealed class ClientGraphicsSettings

Graphics and rendering settings persisted on the current device.

备注

PIE 暂未完整支持保存与读回，部分选项可能影响编辑器进程；请使用独立客户端调试验证。

属性 ​

Preset 仅客户端 ​

csharp
public GraphicsPreset Preset { get; set; }

MaxFrameRate 仅客户端 ​

csharp
public int? MaxFrameRate { get; set; }

Explicit frame-rate cap, or null when no cap is configured.

RenderResolution 仅客户端 ​

csharp
public RenderResolutionLevel RenderResolution { get; set; }

Render resolution preset, not the window or UI design size.

SceneQuality 仅客户端 ​

csharp
public SceneQuality SceneQuality { get; set; }

ParticleQuality 仅客户端 ​

csharp
public ParticleQuality ParticleQuality { get; set; }

DynamicLightsEnabled 仅客户端 ​

csharp
public bool DynamicLightsEnabled { get; set; }

HdrEnabled 仅客户端 ​

csharp
public bool HdrEnabled { get; set; }

AntiAliasingEnabled 仅客户端 ​

csharp
public bool AntiAliasingEnabled { get; set; }

CharacterOcclusionSilhouetteEnabled 仅客户端 ​

csharp
public bool CharacterOcclusionSilhouetteEnabled { get; set; }

方法 ​

ClearMaxFrameRate 仅客户端 ​

csharp
public void ClearMaxFrameRate()

Removes the explicit frame-rate cap.

ClientPreferenceStore 仅客户端 ​

命名空间 GameCore.ClientSettings

csharp
public sealed class ClientPreferenceStore

Namespaced custom client preferences for lightweight local game options.

备注

PIE 暂未完整支持 Game 和 Device 作用域的保存与读回；请使用独立客户端调试验证。

方法 ​

GetBool 仅客户端 ​

csharp
public bool GetBool(string key, bool defaultValue = false, ClientSettingScope scope = ClientSettingScope.Game)

SetBool 仅客户端 ​

csharp
public void SetBool(string key, bool value, ClientSettingScope scope = ClientSettingScope.Game)

GetFloat 仅客户端 ​

csharp
public float GetFloat(string key, float defaultValue = 0f, ClientSettingScope scope = ClientSettingScope.Game)

SetFloat 仅客户端 ​

csharp
public void SetFloat(string key, float value, ClientSettingScope scope = ClientSettingScope.Game)

GetString 仅客户端 ​

csharp
public string? GetString(string key, string? defaultValue = null, ClientSettingScope scope = ClientSettingScope.Game)

SetString 仅客户端 ​

csharp
public void SetString(string key, string value, ClientSettingScope scope = ClientSettingScope.Game)

ClientSettings 仅客户端 ​

命名空间 GameCore.ClientSettings

csharp
public static class ClientSettings

Client-only access to persisted local game options.

备注

PIE 暂未完整支持设置的保存与读回，部分设置可能影响编辑器进程。 请使用独立客户端调试验证设置功能，包括无头编辑器启动的独立调试客户端。

属性 ​

Graphics 仅客户端 ​

csharp
public static ClientGraphicsSettings Graphics { get; }

Graphics and rendering options.

备注

PIE 的保存与读回支持不完整，部分选项可能影响编辑器进程；请在独立客户端中验证。

Audio 仅客户端 ​

csharp
public static ClientAudioSettings Audio { get; }

Audio and voice options.

备注

PIE 的保存与读回支持不完整，音量修改可能影响编辑器进程；请在独立客户端中验证。

Preferences 仅客户端 ​

csharp
public static ClientPreferenceStore Preferences { get; }

Custom preferences for game code.

备注

PIE 暂未完整支持 Game 和 Device 作用域的保存与读回；请在独立客户端中验证。

ClientSettingScope 仅客户端 ​

命名空间 GameCore.ClientSettings

csharp
public enum ClientSettingScope

Selects where a custom client preference is stored.

枚举值 ​

  • Game — Stored for the current game/map.
  • Device — Stored as a device-wide client option.

GraphicsPreset 仅客户端 ​

命名空间 GameCore.ClientSettings

csharp
public enum GraphicsPreset

Built-in graphics preset.

枚举值 ​

  • BatterySaver
  • Smooth
  • Balanced
  • High
  • Custom

ParticleQuality 仅客户端 ​

命名空间 GameCore.ClientSettings

csharp
public enum ParticleQuality

Particle effect quality.

枚举值 ​

  • Low
  • Medium
  • High

RenderResolutionLevel 仅客户端 ​

命名空间 GameCore.ClientSettings

csharp
public enum RenderResolutionLevel

Render resolution level used by the platform settings panel.

枚举值 ​

  • Low
  • Medium
  • High

SceneQuality 仅客户端 ​

命名空间 GameCore.ClientSettings

csharp
public enum SceneQuality

Scene rendering quality.

枚举值 ​

  • Low
  • Medium
  • High
  • Ultra