動作確認環境

Unity 2023.2.13f1 (※画像は一部で2020.3.20f1を使用しているものがあります)
VisualStudio 2017

UnityのSerializeFieldで上限・下限を設定する

SerializeFieldで上限下限を設定する方法はおそらくご存知の方も多いはず。

[SerializeField]
[Range( 0, 100 )]
private int hoge = 0;

これは下限0, 上限100の設定です。
下限は0で上限は数値の型の範囲なんでもいいなんて場合もあると思います。
intの最大値はint.MaxValueだからこれを設定したら最大値はintの範囲内で好きなところにできるだろうと思い、設定してみました。

[SerializeField]
[Range( 0, int.MaxValue )]
private int hoge = 0;

上記を記述し、エディタを設定してみるとなぜか負の数になります。

公式ドキュメントを見ても特に記載はありませんでした。
https://docs.unity3d.com/ja/2020.3/ScriptReference/RangeAttribute.html

エディタで切れている部分を実際に見てみると

[SerializeField]
[Range( 0, int.MaxValue )]
private int hoge = 0;

void Awake()
{
    Debug.Log( $"hoge={hoge}" );
}

となっており、「int.MaxValue=2,147,483,647」をオーバーフローしているようです。

int.MaxValueがバグってるのか？と思って確認してみました。

定義は問題なさそうなので、実際に表示してみました。

[SerializeField]
[Range( 0, int.MaxValue )]
private int hoge = 0;

void Awake()
{
    Debug.Log( $"hoge={hoge} int.MaxValue={int.MaxValue}" );
}

int.MaxValueは正常なようです。
どうやらRangeを経由するとおかしくなるようです。

どこまでなら正常な値が表示されるか調べてみた

下記のように記載して、地道に調べてみました。

[SerializeField]
[Range( 0, int.MaxValue - 10 )]
private int hoge = 0;

[SerializeField]
[Range( 0, int.MaxValue - 50 )]
private int fuga = 0;

その結果、正常に表示される範囲を特定しました。

[SerializeField]
[Range( 0, int.MaxValue - 63 )]
private int hoge = 0;

[SerializeField]
[Range( 0, int.MaxValue - 64 )]
private int fuga = 0;

どうやら「in.MaxValue - 64」までが正常に出せる正常値のようです。

エディタ上で表示が切れていますが、値を確認してみると、

int.MaxValue - 64 = 2,147,483,520

となっていました。

int(符号付き32ビット整数)の範囲は -2,147,483,648 ～ 2,147,483,647 のはずなので、2,147,483,520 に 64 を足すと 2,147,483,584 となり、intの範囲内ですが、元の2,147,483,647には戻りません。

どうしてこんな結果になったのか調べてみた

Rangeの実装を見たところ、floatにキャストされてました。

つまり「int.MaxValueをfloatにキャストするとおかしくなるということでは？」と疑い、下記のコードで確認してみました。

[SerializeField]
[Range( 0, int.MaxValue )]
private int hoge = 0;

void Awake()
{
    Debug.Log( $"hoge={hoge} int.MaxValue={int.MaxValue} (float)int.MaxValue={(float)int.MaxValue}" );
}

これだと下の桁が見えないので、桁数指定を入れてちょっと書き換えてみました。

[SerializeField]
[Range( 0, int.MaxValue )]
private int hoge = 0;

void Awake()
{
    Debug.Log( $"hoge={hoge} int.MaxValue={int.MaxValue} (float)int.MaxValue={(( float )int.MaxValue):0000000000}" );
}

この結果からキャストでオーバーフローしてることは確定みたいですね。

floatにキャストしたまま使うと思うので、大体の場合は問題ないのだと思いますが、Rangeはintにキャストし直すために問題が起きているのだと思われます。

63 と 64 の境界について調べてみた

int.MaxValue-63 と int.MaxValue-64をfloatにキャストした値をそれぞれ確認してみました。
こちらも確認しやすいように桁数指定を入れています。

void Awake()
{
    Debug.Log( $"(float)( int.MaxValue - 63 )={( float ) ( int.MaxValue - 63 ):0000000000} (float)( int.MaxValue - 64 )={( float ) ( int.MaxValue - 64 ):0000000000}" );
}

表示上は同じように見えます。

intにキャストし直す時に起きるようなので下記のように書き直してみました。

void Awake()
{
    Debug.Log( $"(int)(( float ) ( int.MaxValue - 63 ))={(int)(( float ) ( int.MaxValue - 63 ))} ( int ) (( float ) ( int.MaxValue - 64 ))={( int ) (( float ) ( int.MaxValue - 64 ))}" );
}

63の時はエラーが出てしまいました…

C++で試してみた

C++とC#でキャストの結果は同じだと思いますが、念のため確認。
お試しでこんな感じで書いてみました。

int main()
{
    printf( "INT_MAX(%d)をfloatキャスト(%10f)してintに戻す(%d)\n", INT_MAX, ( float ) INT_MAX, ( int )( ( float ) INT_MAX ) );
    printf( "64引いてみると…→%10f\n", ( ( float ) ( INT_MAX - 64 ) ) );
    printf( "63引いてみると…→%10f\n", ( ( float ) ( INT_MAX - 63 ) ) );
    printf( "64引いてみると…→%d\n", ( int ) ( ( float )( INT_MAX - 64 ) ) );
    printf( "63引いてみると…→%d\n", ( int ) ( ( float )( INT_MAX - 63 ) ) );

    return 0;
}

出力結果↓

C++もC#もキャストの計算は一緒なので、同じ結果になると思っていましたが、予想通りの結果でした。

つまりRangeに限らず、int.MaxValueをfloatにキャストして再度intにキャストしようとしたときに必ず起きる問題です。

これはそれぞれの型の有効桁数がintは9～10桁(-2,147,483,647～2,147,483,647)、floatはC++の場合は6～7桁、C#の場合は6～9桁なので実はfloatの方が精度が低いから起きる現象です。
(下記参考リンク参照)
キャストについてはまた記事を書くとして、今回は他の型はちゃんと使えるのか調べてみたいと思います。

参考リンク
https://learn.microsoft.com/ja-jp/cpp/cpp/data-type-ranges?view=msvc-170
https://learn.microsoft.com/ja-jp/cpp/c-language/type-float?view=msvc-170
https://learn.microsoft.com/ja-jp/dotnet/csharp/language-reference/builtin-types/floating-point-numeric-types

他の型も調べてみる

調べてみました。

float

2種類の書き方を試してみました(変わらないと思うけど)

[SerializeField]
[Range( 0, float.MaxValue )]
private float hoge = 0;

[SerializeField]
[Range( 0, Mathf.Infinity )]
private float fuga = 0;

正しく表示されました。

byte

[SerializeField]
[Range( 0, byte.MaxValue )]
private byte hoge = 0;

正しく表示されました。

uint

ここまで調べた感じだと int がダメダメっぽいので、それなら uint ならどうだ？と思い、確認しました。

[SerializeField]
[Range( 0, uint.MaxValue )]
private uint hoge = 0;

0から動かせなくなりました。

型違いはどうなるのか？

こんな感じで試してみました。

[SerializeField]
[Range( 0, int.MaxValue )]
private float hoge = 0;

[SerializeField]
[Range( 0, int.MaxValue )]
private double fuga = 0;

[SerializeField]
[Range( 0, byte.MaxValue )]
private float hogehoge = 0;

[SerializeField]
[Range( 0, byte.MaxValue )]
private double fugafuga = 0;

エディタの表示が切れてしまっていてint.MaxValueの方の値がおかしなようにみえますが、設定されている値は「2.147484e+09」なので問題なさそうです。
(ここまで調べた結果ではint.MaxValueにはなっていなさそうなので問題があるといえばありますが…)

負の数はどうなるのか？

負の数はどうなるか試してみました。

int

[SerializeField]
[Range( int.MinValue, 0 )]
private int hoge = 0;

正常に表示されました。
エディタの表示で見えない部分も-2,147,483,648と表示されていて正常です。

float

[SerializeField]
[Range( float.MinValue, 0 )]
private float hoge = 0;

[SerializeField]
[Range( Mathf.NegativeInfinity, 0 )]
private float fuga = 0;

正常に表示されました。

int.MinValue vs int.MaxValue

int.MaxValueが負になるなら下限をint.MinValue、上限をint.MaxValueにしたらどうなるのか試してみました。

[SerializeField]
[Range( int.MinValue, int.MaxValue )]
private int hoge = 0;

ハンドルが消失しました。
動かすことすらできません。

まとめ

キャストの影響でおかしくなるのはint.MaxValueだけなようです。
Rangeでint.MaxValueを使いたいのであれば-64して使うか、他の方法の検討が必要になりそうです。