Seaurchin Wiki

The Ground Slider Simulator

ユーザ用ツール

サイト用ツール


wiki:api:settinglist

SettingList.tomlについて

0.30.0でSettingList.txtはSettingList.tomlに変更になりました。

概要

SettingListはSeaurchin内で操作する設定項目を記述するためのものです。 幾つかのタイプがあり、デフォルト値や範囲を指定することが出来ます。

0.30.0以降はスキンディレクトリ直下(~/Data/Skins/SkinName/SettingList.toml)にファイルを置くとそれも読み込むようになりました。つまりスキンで設定項目を追加するときにシステムのSettingList.tomlを上書きする必要がなくなりました。

記法

# 例 その1
# 範囲のある整数値
[[SettingItems]]
Type = "Integer"
Group = "SettingGroup"
Key = "SettingKey"
Description = "設定項目の説明"
Range = [ -10, 10 ]
Step = 1
Default = 0
 
# 例 その2
# 文字列(直接編集は出来ないけどconfig.tomlに記録される)
[[SettingItems]]
Type = "String"
Group = "SettingGroup"
Key = "AnotherKey"
Description = "設定項目の説明"
Default = "デフォルト値"

ファイル直下でSettingItemsがテーブルの配列になるようにします。

詳細

各アイテムのTypeに種類を設定します(文字列)。 指定できるのは以下の通りです。必要なパラメーターも列記します。

なお以下のものは必須です。

  • Group
    • 設定グループ
  • Key
    • 設定キー
  • Description
    • 設定の説明

Integer

整数値。

  • Range
    • [ -100, 100 ]のように最小値と最大値を配列で指定。
  • Step
    • ステップ値。デフォルトは1
  • Default
    • デフォルト値。デフォルトは0

Float

実数値。 値に小数点を付けないとエラーになるので注意してください。

  • Range
    • [ -100.0, 100.0 ]のように最小値と最大値を配列で指定。
  • Step
    • ステップ値。デフォルトは1.0
  • Default
    • デフォルト値。デフォルトは0.0

Boolean

真偽値。

  • Values
    • [ “trueのときの文字列”, “falseのときの文字列” ]という感じで指定。
  • Default
    • デフォルト値。デフォルトはfalse

String

文字列。直接設定できないけど存在することは示せるのでそういう用途で。

  • Default
    • デフォルト値

IntegerSelect

選択肢つき整数値。

  • Values
    • [ 1, 2, … ]という感じで選ばせたい値を指定。
  • Default
    • デフォルト値。Values内の値である必要はありません。

FloatSelect

選択肢つき実数値。説明略

StringSelect

選択肢つき文字列。説明略

こっちはゲーム内で設定可能です。

IntegerList, IntegerVector

整数値の一次元配列、二次元配列。挙動はStringに準じます。

FloatList, FloatVector

実数値の一次元配列、二次元配列。挙動はStringに準じます。

BooleanList, BooleanVector

真偽値の一次元配列、二次元配列。挙動はStringに準じます。

wiki/api/settinglist.txt · 最終更新: 2019/01/10 12:09 by kb10uy