🔖

Unity 属性の一覧と概要

に公開

参照情報

はじめに

一覧+概要のサイトを探したけどうまく見つからなかったので自分のために作成。

属性の基本的な構文などを勉強するためのチュートリアルはここ。https://learn.unity.com/tutorial/attributes#

Unity Engine の属性

属性名 概要
AddComponentMenu Componentメニュー以下の自由な場所にスクリプトコンポーネントを配置
AssemblyIsEditorAssembly この属性を持つアセンブリ内のクラスは、エディター クラスと見なされます。
BeforeRenderOrderAttribute Application.onBeforeRender のカスタムコールバック順序を指定する必要がある場合に使用します。
ColorUsageAttribute カラー フィールドとカラー ピッカーの色の扱いを設定する。
ContextMenu インスペクターから関数を実行できるようにする。
ContextMenuItemAttribute 特定の関数を実行するコンテキストを追加する。
CreateAssetMenuAttribute ScriptableObjectをAssets > Createから作成できるようコンテキストメニューの追加
CustomGridBrushAttribute クラスをグリッドブラシとして定義し、パレットウィンドウで使用できるようにする属性。
DefaultExecutionOrder MonoBehaviour 派生クラスのスクリプト実行順序を指定します。
DelayedAttribute 実行中に値を書き換えるとき、Enterキーを押すまで値を書き換えない。
DisallowMultipleComponent 同じコンポーネントをアタッチさせないようにする
EnumButtonsAttribute ToggleButtonGroup を使用して列挙型を編集できるようにする属性。
ExcludeFromObjectFactoryAttribute ObjectFactory メソッドで作成されなくなります。
ExcludeFromPresetAttribute プリセットが作成されないようにする。
ExecuteAlways 編集モードとプレハブ編集モードでも実行する。
ExecuteInEditMode 編集モードでも実行する。
GradientUsageAttribute 「グラデーション」インスペクタエディタでカラー値を処理する方法を制御します。
GUITargetAttribute OnGUIが呼び出されるディスプレイを制御できます。
HeaderAttribute インスペクターのフィールドの上にヘッダーを追加します。
HelpURLAttribute ドキュメント用の URL を指定します。
HideInCallstackAttribute コンソールウィンドウのコールスタックから非表示にするメソッドをマークする
HideInInspector インスペクタに表示されないように変数にフラグを立てる
IconAttribute アイコンを指定する属性。
ImageEffectAfterScale このアトリビュートを持つイメージエフェクトは、ダイナミック解像度ステージの後にレンダリングされます。
ImageEffectAllowedInSceneView このアトリビュートを持つイメージ エフェクトは、シーン ビュー カメラにレンダリングできます。
ImageEffectOpaque このアトリビュートを持つイメージ エフェクトは、不透明なジオメトリの後、透明なジオメトリの前にレンダリングされます。
ImageEffectTransformsToLDR 画像エフェクトでこのアトリビュートを使用すると、デスティネーションバッファがLDRバッファになり、 画像効果パイプラインの残りの部分を LDR モードにします
ImageEffectUsesCommandBuffer コマンド バッファを使用してイメージ エフェクトを実装する場合に使用します。
InspectorNameAttribute 列挙値のインスペクター表示名を変更します。
InspectorOrderAttribute 列挙値をソートして表示します。
MinAttribute インスペクター上で入力可能なfloatまたはint変数の最小値を制限する。
MultilineAttribute 文字列を複数行のテキストフィールドで編集する属性。
NonReorderableAttribute インスペクターウィンドウでの配列またはリストの並べ替えを無効にする。
PreferBinarySerialization 性能のためにScriptableObjectをバイナリ化する
PropertyAttribute カスタム プロパティ属性の派生元となる基本クラス。
PropertyCollectionAttribute <<廃止されました>>
RangeAttribute インスペクターでのfloat変数またはint変数を特定の範囲に制限するために使用される属性
RequireComponent 必要なコンポーネントを依存関係として自動的に追加します。
RuntimeInitializeOnLoadMethodAttribute ランタイムが起動して最初のシーンをロードするときにコールバックを取得します。
SelectionBaseAttribute エディターでオブジェクトをクリック時に選択される。
SerializeField プライベートフィールドをインスペクターに表示する
SerializeReference 値としてではなく参照としてシリアル化するように Unity に指示するスクリプト属性。
SharedBetweenAnimatorsAttribute メモリ最適化のため、StateMachineBehaviour が一度だけインスタンス化され、すべての Animator インスタンスで共有されることを指定します。
SpaceAttribute インスペクターに間隔を追加します。
TextAreaAttribute 文字列を高さが柔軟でスクロール可能なテキスト領域で編集できるようにする属性。
TooltipAttribute 説明を追加する
UnityAPICompatibilityVersionAttribute アセンブリが特定の Unity API と互換性があるように (API ベースで) 宣言する。

Unity Editor の属性

属性名 概要
AssetPostprocessorStaticVariableIgnoreAttribute Unity のアセットインポート処理における静的変数(static 変数)に対する警告を抑制するための属性
CallbackOrderAttribute コールバックインデックスを必要とする属性の基本クラス。
CanEditMultipleObjects カスタム エディタでマルチオブジェクト編集をサポートするために使用されるアトリビュート。
CustomEditor エディタークラスに、エディターの実行時型を指示します。
CustomEditorForRenderPipelineAttribute <<廃止です>>
CustomPreviewAttribute 指定したタイプのインスペクターにプレビューを追加します。
CustomPropertyDrawer カスタム PropertyDrawer または DecoratorDrawer に、どの実行時の Serializable クラスまたは PropertyAttribute がドロワーであるかを指示します。
DrawGizmo DrawGizmo アトリビュートを使用すると、任意のコンポーネントにギズモ レンダラーを指定できます。
EditorWindowTitleAttribute エディターウィンドウのタイトルテキストとアイコンを設定します。
FilePathAttribute Project フォルダーまたは Unity の環境設定フォルダーを基準にしたファイルの場所を指定する属性。その他のリソース: 場所。
InitializeOnEnterPlayModeAttribute Unity がプレイモードに入ったときにエディタークラスメソッドを初期化できるようにします。
InitializeOnLoadAttribute Unity のロード時、およびスクリプトの再コンパイル時に Editor クラスを初期化できます。
InitializeOnLoadMethodAttribute ユーザーからのアクションなしで Unity がロードされたときに、エディタークラスメソッドを初期化できるようにします。
LightingExplorerExtensionAttribute <<廃止です>>
LocalizationAttribute ローカライズのアセンブリの属性。
MenuItem この属性を使用すると、メインメニューとインスペクターウィンドウのコンテキストメニューにメニュー項目を追加できます。
PreferenceItem <<廃止です>>
SettingsProviderAttribute 新しい SettingsProvider を登録するために使用される属性。この属性を使用して、SettingsProvider のインスタンスを返す関数を装飾します。
SettingsProviderGroupAttribute 複数のSettingsProvider項目を登録する属性です。
ShaderIncludePathAttribute <<廃止です>>

Discussion