ローカルUIコントロール APIドキュメント

API特有の用語について、日本語と英語の対応関係を定義します。
※ここに記載されている名称は、実際のインターフェース名やフィールド名ではありません。
※Ver7.1時点での日本語名称との紐づけであり、日本語名称が変更になっている可能性もありますのでご注意ください。
日本語英語表記
スクリプトScript
信号ServerSignal
カスタム変数CustomVariable
パラメータParam
TweenTween
塗りつぶしfillAmount
基礎Basic
伸縮Stretch
ぼかしsoft edge
90度円軌道Radial90
180度円軌道Radial180
360度円軌道Radial360
クライアントコントロールIDClientControlID
クライアントコントロールIDリストClientControlIDList
ステージ時間停止LevelTimePaused
コンテナノードContainerControl
テキストボックスTextBoxControl
テキストウィンドウTextWindowControl
画像ImageControl
画面エフェクトUIAnimationControl
フルスクリーンエフェクトFullscreenUIAnimationControl
ボタンヒントKeyHintControl
グリッドウィンドウGridScrollerControl
ポインター検出エリアCursorEventArea
テンプレート参照モジュールReferenceControl
プリセットボタンPresetButton
存在(作成済みかどうか)alive
有効enable
アクティブactive
表示visible
コントローラーナビゲーションを隔離IsolateNavigation
ボタンイベントの貫通をブロックdisableKeyEventPassthrough
エリア内のポインターイベントの貫通をブロックdisableCursorEventPassthrough
ポインターを常時表示showCursor
ポインターのレイキャストで検出可能Raycast Target

星々の幻境では、実行環境に「Lua 5.3」を使用しています。
※作成したクライアントスクリプトがLua 5.3で実行できる内容であるかチェックするようにしてください。

また、以下の標準ライブラリは使用することができません。

・string.dump
・io.*
・os.(os.time、os.date、os.clock、os.difftime を除く)
・debug.(debug.traceback を除く)
・math(math.modf、math.ult、math.isnann、math.isnafn を除く)

該当の関数を紐づけられたクライアントスクリプト内に記述しておくことで、条件を満たした時に自動的に呼び出されます。
※ノードグラフのイベントノードと同じようなものです。

関数引数呼び出し条件
OnInit()–スクリプトの初期化時
OnStrat()–スクリプトの起動時
OnEnable()–スクリプトの有効化時
OnDisable()–スクリプトの無効化時
OnUpdate(dt)dt:number毎フレーム
※ステージの時間停止の影響を受けません
OnLevelUpdate(dt)dt:number毎フレーム
※ステージの時間停止の影響を受けます
OnDestroy()–スクリプトの破棄時

*dt: デルタタイム :前回のフレームから今回のフレームまでに経過した時間

script:EnableUpdate(enabled: boolean)

3-1.スクリプトのライフサイクルの「OnUpdate(dt)」と「OnLevelUpdate(dt)」の呼び出しを停止します。

・false
→フレーム更新を停止
・true
→フレーム更新を再開

※60FPSであれば、1秒間に60回もの更新処理が呼ばれることになります。
 フレーム更新を呼ぶ必要のない時は、呼び出しを停止することでパフォーマンスの向上に繋がります。

(1) 型の取得

関数戻り値内容
typeof(value)stringvalueの型を取得します

(2) ログとデバッグ

関数戻り値内容
print(…)–通常ログを出力します
※この関数は処理を中断しません
printerr(…)–エラーログを出力します
※この関数は、エラーではなく処理を中断しません
debug.traceback([message[, level]])string現在の呼び出し履歴を文字列として生成します
※message: 文字列の先頭に追加する説明文
※level: 呼び出し履歴の開始階層を指定します
※この関数はログに自動書き込みはしません
game.PrintClientUITree()–現在のクライアントコントロールの階層構造をログに出力します

数値チェック

外部入力や補間処理で異常な数値が出ていないかチェックすることができます。

関数戻り値内容
math.isnan(n)boolean引数が数値でないか判定します
math.isinf(n)boolean引数が正または負の無限大かどうかを判定します

グローバル変数

名前型内容
scriptScript現在のスクリプト
EnumEnum列挙型

星々の幻境では、色を表現する時に「R:赤」「G:緑」「B:青」「A:透明度」で表します。

例えば、Color(255,0,0,255)なら完全な赤色になります。

引数に「?」がついているものは省略可能で、省略した場合は初期値が設定されます。

(1) コンストラクタ

コンストラクタ戻り値内容
Color(r: number, g: number, b: number, a: number?)ColorValue0〜255のRGBA値からカラーを作成します
aの初期値は255(不透明)

(2) 関数

関数戻り値内容
Color.FromRGB(r: number, g: number, b: number)ColorValue0〜255のRGB値からカラーを作成します。
Color.FromRGBA(r: number, g: number, b: number, a: number?)ColorValue0〜255のRGBA値からカラーを作成します
aの初期値は255(不透明)
Color.ToRGBA(colorValue: ColorValue)r, g, b, a:numberカラーを0〜255のRGBAの4つの値に分解します

Scriptは現在実行中のLuaスクリプトそのものを表すオブジェクトです。

グローバル変数:Scriptを通じてアクセスできます。

(1) フィールド

フィールド名型アクセス内容
aliveboolean読み取り専用スクリプトがまだ存在してるかどうか
scriptMappingIdinteger読み取り専用スクリプトのマッピングID
objectany読み取り専用スクリプトが紐づけられているオブジェクトを取得
pathstring読み取り専用スクリプトのパス
enabledboolean読み書き可能スクリプトの有効状態
※script.enabled = falseで無効化できます

(2) メソッド

メソッド戻り値内容
script:GetParam(paramName: string)anyスクリプト変数を取得します
script:Invoke(funcName: string, …: any)–スクリプト内の関数を名前指定で呼び出します
script:EnableUpdate(enabled: boolean)–※「3-2.フレーム単位の制御」参照
script:RegisterServerSignalHandler(signalName: string, callback: fun(signalName: string, signalParams: any[]))–監視するサーバー側から送られる信号を登録します
※コールバックのパラメータは順に信号名、信号引数の配列になります
script:UnregisterServerSignalHandler(signalName: string)–登録した信号の監視を解除します
script:RegisterCustomVariableChangedHandler(entityType: CustomVariableEntityType, customVariableName: string, callback: fun(entityType: CustomVariableEntityType, customVariableName: string))–監視するカスタム変数を登録します
※エンティティタイプと変数名のみがコールバックされるため、現在の値を取得するには「game.GetGlobalCustomVariableValue」を使用する必要があります
script:UnregisterCustomVariableChangedHandler(entityType: CustomVariableEntityType, customVariableName: string)–登録したカスタム変数の監視を解除します

gameは、クライアント実行環境が提供するグローバルAPIです。

(1) UIと階層操作

関数戻り値内容
game.InstantiateClientUIControl(controlPrefabIndex: integer, parent: ClientUIBaseControl)ClientUIBaseControl指定したテンプレートインデックスからparentの下にUIを作成します
game.DestroyClientUIControl(control: ClientUIBaseControl)–指定したUIを破棄します
game.GetClientUIControl(controlId: integer)ClientUIBaseControl実行時のIDからUIを取得します
game.FindClientUIRoot(nodeName: string)ClientUIBaseControl指定したUIのルートを取得します
game.GetClientUIRoots()ClientUIBaseControl[]すべてのUIのルートを取得します
game.GetUICanvasSize()x, y: number画面解像度に応じたUI領域の幅と高さを取得します
game.GetCursorUIPos()x, y: numberカーソルのUI座標を取得します

(2) 入力とフォーカス

関数戻り値内容
game.GetDevice()Device現在の入力デバイスを取得します
game.SetControllerFocus(control: ClientUIBaseControl)–コントローラーのフォーカスを設定します
game.GetControllerFocus()ClientUIBaseControl現在のコントローラーのフォーカスを取得します
game.GetControllerLeftStickAxis()horizontal, vertical: number左スティックの軸値を取得します
game.GetControllerRightStickAxis()horizontal, vertical: number右スティックの軸値を取得します

(3) Tween、サーバー信号、カスタム変数

関数戻り値内容
game.Tween(object: any, tweenDataTable: table, duration: number)TweenTweenアニメーションを作成します
※指定したオブジェクトのプロパティを一定時間かけて変化させます
※object:対象オブジェクト
※tweenDataTable:Tween可能なフィールド名をキーとし目標値を値としたテーブル
※duration:継続時間を引数にします
game.TweenSequence()TweenSequence空のTweenアニメーションシーケンスを作成します
game.ServerSignal(signalName: string)ServerSignalサーバーへ信号を送ります
game.GetGlobalCustomVariableValue(entityType: CustomVariableEntityType, customVariableName: string)anyカスタム変数を取得します

(4) ステージ、効果音、ローカライズ

関数戻り値内容
game.PauseLevelTime(pause: boolean)–1人プレイモードでステージの時間停止状態を設定します
※true:有効、false:無効
※スクリプト自体の実行は停止しません(OnUpdate)
game.IsLevelTimePaused()booleanステージが時間停止状態にあるか確認します
game.PlayAudio2D(audioId: integer)integer設定済みの効果音IDに従って2D効果音を再生し、効果音インスタンスIDを返します
game.StopAudio(audioInstanceId: integer)–指定した効果音を停止します
game.IsAudioAlive(audioInstanceId: integer)boolean効果音インスタンスが存在しているか確認します
game.GetLanguageType()LanguageType現在の言語を取得します
game.GetStageMode()StageMode現在のステージモードを取得します
※Classic, Beyond
game.IsTestPlay()boolean現在テストプレイであるか確認します
game.GetText(textMapId: string)string設定済みのテキストマッピングIDに従ってローカライズテキストを取得します
※多言語テキスト管理に設定が必要

Tweenオブジェクトに対して、補間処理を行うためのTweenアニメーションクラスです。

(1) 作成

関数戻り値内容
game.Tween(object: any, tweenDataTable: table, duration: number)Tween※「3-6.game」参照

(2) メソッド

メソッド戻り値内容
Tween:SetEase(easeType: EaseType)Tween変化の仕方を設定し、現在のインスタンスを返します
Tween:SetRelative(relative: boolean)TweentweenDataTableにおける目標値の解釈方法を設定します
※true:絶対値
※false:現在の値からの相対的な増量
Tween:Play()Tween再生し、現在のインスタンスを返します
Tween:Pause()–一時停止します
Tween:Resume()–一時停止した位置から再開します
Tween:Restart()–初期状態に戻り、最初から再生します
Tween:Complete()–終了します
Tween:Kill(complete: boolean)–インスタンスを破棄します
※true:完了のコールバックを呼び出します
※false:完了のコールバックを呼び出しません
Tween:SetOnComplete(onComplete: fun())Tweenすべてのループが完了した後のコールバックを設定し、現在のインスタンスを返します
Tween:SetOnStepComplete(onStepComplete: fun())Tweenステップ完了時のコールバックを設定し、現在のインスタンスを返します
Tween:SetLoops(times: integer)Tweenループ回数を設定し、現在のインスタンスを返します
※無限ループの場合は、負の数を設定します

複数のTweenを順番に実行するためのタイムラインです

(1) 作成

関数戻り値内容
game.TweenSequence()TweenSequence※「3-6.game」参照

(2) メソッド

メソッド戻り値内容
TweenSequence:Append(tween: Tween)TweenSequenceシーケンスの末尾にTweenを追加します
TweenSequence:AppendInterval(interval: number)TweenSequenceシーケンスの末尾に指定した秒数の待機時間を追加します
TweenSequence:AppendCallback(callback: fun())TweenSequenceシーケンスの末尾にコールバックを追加します
TweenSequence:Join(tween: Tween)TweenSequence現在の末尾のステップと同時に再生します
※ステップの終了タイミングは最も遅いものに合わせられます
TweenSequence:Insert(time: number, tween: Tween)TweenSequence指定した時間にTweenを挿入します
TweenSequence:InsertCallback(time: number, callback: fun())TweenSequence指定した時間にコールバックを挿入します
TweenSequence:Play()TweenSequenceシーケンスの再生を開始し、現在のインスタンスを返します
TweenSequence:Pause()–シーケンスを一時停止します
TweenSequence:Resume()–シーケンスを再開します
TweenSequence:Restart()–初期状態に戻って最初から再生します
TweenSequence:Complete()–シーケンス全体を終了させます
TweenSequence:Kill(complete: boolean)–シーケンスを破棄します
※true:完了のコールバックを呼び出します
※false:完了のコールバックを呼び出しません
TweenSequence:SetOnComplete(onComplete: fun())TweenSequenceシーケンスが完了した後のコールバックを設定し、現在のインスタンスを返します
TweenSequence:SetOnStepComplete(onStepComplete: fun())TweenSequenceステップ完了時のコールバックを設定し、現在のインスタンスを返します
TweenSequence:SetLoops(times: integer)TweenSequenceループ回数を設定し、現在のインスタンスを返します
※無限ループの場合は、負の数を設定します

信号を作成し、サーバーへ送信します。
引数はサーバーの使用に従って順に追加します。

(1) 作成

関数戻り値内容
game.ServerSignal(signalName: string)ServerSignal※「3-6.game」参照

(2) メソッド

メソッド戻り値内容
ServerSignal:AddParam(paramType: ParamType, paramValue: any)–paramTypeでパラメータの型、paramValueでパラメータの値を設定します
ServerSignal:SendSignal()–作成済みの信号を送信します
ServerSignal:AddInt(intValue: integer)–パラメータ(整数)を追加します
ServerSignal:AddIntList(intListValue: integer[])–パラメータ(整数リスト)を追加します
ServerSignal:AddFloat(floatValue: number)–パラメータ(浮動小数点数)を追加します
ServerSignal:AddFloatList(floatListValue: number[])–パラメータ(浮動小数点数リスト)を追加します
ServerSignal:AddString(stringValue: string)–パラメータ(文字列)を追加します
ServerSignal:AddStringList(stringListValue: string[])–パラメータ(文字列リスト)を追加します
ServerSignal:AddVector3(vector3Value: table)–パラメータ(3Dベクトル)を追加します
ServerSignal:AddVector3List(vector3ListValue: table[])–パラメータ(3Dベクトルリスト)を追加します
ServerSignal:AddBool(boolValue: boolean)–パラメータ(ブール値)を追加します
ServerSignal:AddBoolList(boolListValue: boolean[])–パラメータ(ブール値リスト)を追加します
ServerSignal:AddGuid(guidValue: integer)–パラメータ(GUID)を追加します
ServerSignal:AddGuidList(guidListValue: integer[])–パラメータ(GUIDリスト)を追加します
ServerSignal:AddEntity(entityValue: integer)–パラメータ(エンティティ)を追加します
ServerSignal:AddEntityList(entityListValue: integer[])–パラメータ(エンティティリスト)を追加します
ServerSignal:AddPrefabId(prefabIdValue: integer)–パラメータ(プレハブID)を追加します
ServerSignal:AddPrefabIdList(prefabIdListValue: integer[])–パラメータ(プレハブIDリスト)を追加します
ServerSignal:AddConfigId(configIdValue: integer)–パラメータ(配置ID)を追加します
ServerSignal:AddConfigIdList(configIdListValue: integer[])–パラメータ(配置IDリスト)を追加します

(1) フィールド

フィールド名型アクセス内容
Namestring読み取り専用列挙値の名称
FullNamestring読み取り専用列挙値の完全名
EnumTypestring読み取り専用列挙型の名称

(1) Enum.EaseType

列挙名列挙値内容
Enum.EaseTypeLinearリニア
Enum.EaseTypeInSineイーズイン
Enum.EaseTypeOutSineイーズアウト
Enum.EaseTypeInOutSineイーズインアウト
Enum.EaseTypeInQuadイーズイン(Sineより強い)
Enum.EaseTypeOutQuadイーズアウト(Sineより強い)
Enum.EaseTypeInOutQuadイーズインアウト(Sineより強い)
Enum.EaseTypeInCubicイーズイン(Quadより強い)
Enum.EaseTypeOutCubicイーズアウト(Quadより強い)
Enum.EaseTypeInOutCubicイーズインアウト(Quadより強い)
Enum.EaseTypeInQuartイーズイン(Cubicより強い)
Enum.EaseTypeOutQuartイーズアウト(Cubicより強い)
Enum.EaseTypeInOutQuartイーズインアウト(Cubicより強い)
Enum.EaseTypeInQuintイーズイン(Quartより強い)
Enum.EaseTypeOutQuintイーズアウト(Quartより強い)
Enum.EaseTypeInOutQuintイーズインアウト(Quartより強い)
Enum.EaseTypeInExpoイーズイン(Quintより強い)
Enum.EaseTypeOutExpoイーズアウト(Quintより強い)
Enum.EaseTypeInOutExpoイーズインアウト(Quintより強い)
Enum.EaseTypeInCircイーズイン(Expoより加速や減速がゆるやか)
Enum.EaseTypeOutCircイーズアウト(Expoより加速や減速がゆるやか)
Enum.EaseTypeInOutCircイーズインアウト(Expoより加速や減速がゆるやか)
Enum.EaseTypeInBackイーズイン(少し行き過ぎてから戻ってくる)
Enum.EaseTypeOutBackイーズアウト(少し行き過ぎてから戻ってくる)
Enum.EaseTypeInOutBackイーズインアウト(少し行き過ぎてから戻ってくる)
Enum.EaseTypeInElasticイーズイン(ゴムのような動き)
Enum.EaseTypeOutElasticイーズアウト(ゴムのような動き)
Enum.EaseTypeInOutElasticイーズインアウト(ゴムのような動き)
Enum.EaseTypeInBounceイーズイン(ボールのような動き)
Enum.EaseTypeOutBounceイーズアウト(ボールのような動き)
Enum.EaseTypeInOutBounceイーズインアウト(ボールのような動き)

(2) Enum.CustomVariableEntityType

列挙名列挙値内容
Enum.CustomVariableEntityTypeLevelステージ
Enum.CustomVariableEntityTypePlayerSelfプレイヤー自身
Enum.CustomVariableEntityTypeAvatarSelfキャラ自身

(3) Enum.Device

列挙名列挙値内容
Enum.DeviceKeyboardAndMouseキーボード&マウス
Enum.DeviceMobileモバイルタッチパネル
Enum.DeviceControllerコンソールコントローラー
Enum.DeviceMobileControllerモバイル用コントローラー

(4) Enum.StageMode

列挙名列挙値内容
Enum.StageModeBeyondアドバンスモード
Enum.StageModeClassicクラシックモード

(5) Enum.LanguageType

列挙名列挙値内容
Enum.LanguageTypeLanguageNone未設定
Enum.LanguageTypeLanguageEng英語
Enum.LanguageTypeLanguageChs簡体字中国語
Enum.LanguageTypeLanguageCht繁体字中国語
Enum.LanguageTypeLanguageFraフランス語
Enum.LanguageTypeLanguageDeuドイツ語
Enum.LanguageTypeLanguageSpaスペイン語
Enum.LanguageTypeLanguagePorポルトガル語
Enum.LanguageTypeLanguageRusロシア語
Enum.LanguageTypeLanguageJpn日本語
Enum.LanguageTypeLanguageKor韓国語
Enum.LanguageTypeLanguageThaタイ語
Enum.LanguageTypeLanguageVieベトナム語
Enum.LanguageTypeLanguageIndインドネシア語
Enum.LanguageTypeLanguageTurトルコ語
Enum.LanguageTypeLanguageItaイタリア語

(6) Enum.ParamType

列挙名列挙値内容
Enum.ParamTypeEntityエンティティ
Enum.ParamTypeEntityListエンティティリスト
Enum.ParamTypeInt整数
Enum.ParamTypeIntList整数リスト
Enum.ParamTypeBoolブール値
Enum.ParamTypeBoolListブール値リスト
Enum.ParamTypeFloat浮動小数点数
Enum.ParamTypeFloatList浮動小数点数リスト
Enum.ParamTypeString文字列
Enum.ParamTypeStringList文字列リスト
Enum.ParamTypeVector33Dベクトル
Enum.ParamTypeVector3List3Dベクトルリスト
Enum.ParamTypeGuidGUID
Enum.ParamTypeGuidListGUIDリスト
Enum.ParamTypeConfigId配置ID
Enum.ParamTypePrefabIdプレハブID
Enum.ParamTypeConfigIdList配置IDリスト
Enum.ParamTypePrefabIdListプレハブIDリスト

(7) Enum.CursorEventType

列挙名列挙値内容
Enum.CursorEventTypeCursorDownカーソルを押した時
Enum.CursorEventTypeCursorUpカーソルを離した時
Enum.CursorEventTypeCursorEnterカーソルが検知エリアに入った時
Enum.CursorEventTypeCursorExitカーソルが検知エリアから外れた時
Enum.CursorEventTypeCursorDragカーソルをドラッグ中
Enum.CursorEventTypeCursorBeginDragドラッグ開始時
Enum.CursorEventTypeCursorEndDragドラッグ終了時
Enum.CursorEventTypeCursorClickクリック完了時

(8) Enum.ScrollDirection

列挙名列挙値内容
Enum.ScrollDirectionHorizontal水平スクロール
Enum.ScrollDirectionVertical垂直スクロール

(9) Enum.ScrollLayoutConstraint

列挙名列挙値内容
Enum.ScrollLayoutConstraintAutoWrap自動折り返しレイアウト
Enum.ScrollLayoutConstraintFixed行数または列数固定レイアウト

(10) Enum.ScrollAlignType

列挙名列挙値内容
Enum.ScrollAlignTypeBottom下揃え
Enum.ScrollAlignTypeCenter中央揃え
Enum.ScrollAlignTypeTop上揃え

(11) Enum.ControllerNavigationDir

列挙名列挙値内容
Enum.ControllerNavigationDirUp上
Enum.ControllerNavigationDirDown下
Enum.ControllerNavigationDirLeft左
Enum.ControllerNavigationDirRight右

(12) Enum.ControllerNavigationEventType

列挙名列挙値内容
Enum.ControllerNavigationEventTypeConfirm決定
Enum.ControllerNavigationEventTypeCancelキャンセル
Enum.ControllerNavigationEventTypeFocusフォーカス
Enum.ControllerNavigationEventTypeLostFocusフォーカスアウト
Enum.ControllerNavigationEventTypeRightStickUp右スティック上
Enum.ControllerNavigationEventTypeRightStickDown右スティック下
Enum.ControllerNavigationEventTypeRightStickRight右スティック右
Enum.ControllerNavigationEventTypeRightStickLeft右スティック左
Enum.ControllerNavigationEventTypeLeftStickUp左スティック上
Enum.ControllerNavigationEventTypeLeftStickDown左スティック下
Enum.ControllerNavigationEventTypeLeftStickRight左スティック右
Enum.ControllerNavigationEventTypeLeftStickLeft左スティック左

(13) Enum.ControllerNavigationMode

列挙名列挙値内容
Enum.ControllerNavigationModeNoneナビゲーションなし
Enum.ControllerNavigationModeNearestControl最も近いモジュールへ移動
Enum.ControllerNavigationModeSpecified指定したモジュールへ移動

(14) Enum.TextHorizontalAlignment

列挙名列挙値内容
Enum.TextHorizontalAlignmentLeft左揃え
Enum.TextHorizontalAlignmentMiddle中央揃え(水平方向)
Enum.TextHorizontalAlignmentRight右揃え

(15)Enum.TextVerticalAlignment

列挙名列挙値内容
Enum.TextVerticalAlignmentTop上揃え
Enum.TextVerticalAlignmentMiddle中央揃え(垂直方向)
Enum.TextVerticalAlignmentBottom下揃え

(16)Enum.ImageType

列挙名列挙値内容
Enum.ImageTypeBasic基礎
Enum.ImageTypeStretch伸縮

(17) Enum.ImageSource

列挙名列挙値内容
Enum.ImageSourceStaticReference静的参照
Enum.ImageSourceItemアイテム
Enum.ImageSourceEquipment装備
Enum.ImageSourceSkillスキル
Enum.ImageSourceUnitStatusユニット状態
Enum.ImageSourceFaction陣営
Enum.ImageSourceCurrency通貨
Enum.ImageSourcePrefabプレハブ

(18) Enum.ImageFillType

列挙名列挙値内容
Enum.ImageFillTypeUnused進捗に応じた塗りつぶしを使用しない
Enum.ImageFillTypeHorizontal水平方向
Enum.ImageFillTypeVertical垂直方向
Enum.ImageFillTypeRadial9090度円軌道
Enum.ImageFillTypeRadial180180度円軌道
Enum.ImageFillTypeRadial360360度円軌道

(19) Enum.ImageFillHorizontalType

列挙名列挙値内容
Enum.ImageFillHorizontalTypeLeft左から右
Enum.ImageFillHorizontalTypeRight右から左

(20)Enum.ImageFillVerticalType

列挙名列挙値内容
Enum.ImageFillVerticalTypeBottom下から上
Enum.ImageFillVerticalTypeTop上から下

(21)Enum.ImageFillRadial90Type

列挙名列挙値内容
Enum.ImageFillRadial90TypeBottomLeft左下
Enum.ImageFillRadial90TypeTopLeft左上
Enum.ImageFillRadial90TypeTopRight右上
Enum.ImageFillRadial90TypeBottomRight右下

(22)Enum.ImageFillRadialType

列挙名列挙値内容
Enum.ImageFillRadialTypeBottom下
Enum.ImageFillRadialTypeLeft左
Enum.ImageFillRadialTypeTop上
Enum.ImageFillRadialTypeRight右

(23)Enum.ImageMaskSoftEdgeMode

列挙名列挙値内容
Enum.ImageMaskSoftEdgeModePercentageぼかしモード:パーセンテージ
Enum.ImageMaskSoftEdgeModePixelぼかしモード:ピクセル

(24)Enum.UIAnimationLayer

列挙名列挙値内容
Enum.UIAnimationLayerAboveAllControls全モジュールより上
Enum.UIAnimationLayerBelowAllControls全モジュールより下

(1) 継承関係

すべてのクライアントコントロールは、「ClientUIBaseControl」を継承します。

型コントロール名
ClientUIImageControl画像
ClientUITextBoxControlテキストボックス
ClientUITextWindowControlテキストウィンドウ
ClientUIPresetButtonControlプリセットボタン
ClientUICursorEventAreaControlポインター検出エリア
ClientUIGridScrollerControlグリッドウィンドウ
ClientUIKeyHintControlボタンヒント
ClientUIAnimationControl画像エフェクト
ClientUIFullscreenAnimationControlフルスクリーンエフェクト
ClientUIContainerControlコンテナノード
ClientUIReferenceControlテンプレート参照モジュール

クライアントコントロールのベースクラスです。
階層、レイアウト、スクリプトからのアクセス、入力の監視、およびコントローラー(ゲームパッド)ナビゲーション機能を提供します。

(1) フィールド

フィールド名型アクセス内容
aliveboolean読み取り専用コントロールが存在しているか
idinteger読み取り専用実行時ID
prefabIndexinteger読み取り専用コントロールのテンプレートインデックス
activeboolean読み取り専用アクティブ状態
true:コントロールは表示され、スクリプトのロジックが実行されます
false:コントロールは非表示となり、スクリプトのロジックも停止します
※デフォルトはfalse
activeInHierarchyboolean読み取り専用すべての親要素を考慮した実際のアクティブ状態
visibleboolean読み取り専用表示・非表示のみを制御し、アクティブ状態やスクリプトロジック実行状態は変更しません
namestring読み書き可能コントロール名
parentClientUIBaseControl読み書き可能親コントロール
anchoredPositionX ,
anchoredPositionY
number読み書き可能位置
※Tween可能
sizeDeltaX ,
sizeDeltaY
number読み書き可能サイズ
※Tween可能
anchorMinX ,
anchorMinY
number読み書き可能最小アンカー
※Tween可能
anchorMaxX ,
anchorMaxY
number読み書き可能最大アンカー
※Tween可能
pivotX ,
pivotY
number読み書き可能中心
※Tween可能
localScaleX ,
localScaleY ,
localScaleZ
number読み書き可能ズーム
※Tween可能
localRotationX ,
localRotationY ,
localRotationZ
number読み書き可能回転
※Tween可能
canControllerFocusboolean読み書き可能コントローラーのスティックによるナビゲーションで選択可能

(2) 階層と表示状態

再利用されたリストによって生成された項目については、同階層内での並び順が常に一定であることを保証しません。

メソッド戻り値内容
GetChildren()ClientUIBaseControl[]子のコントロールを取得します
GetChild(name)ClientUIBaseControlカレントコントロール内の指定した名称の子のコントロールを取得します
FindChild(path)ClientUIBaseControlパスに基づいて子のコントロールを取得します
SetActive(active)–アクティブ状態を設定します
非アクティブにするとコントロールが非表示になり、紐づけされているスクリプトのロジック実行も停止します
SetVisible(visible)–表示状態を設定します
アクティブ状態には影響しません
GetSiblingIndex()integer同階層内での並び順インデックスを取得します
戻り値の範囲は0から「親コントロールの子コントロール数-1」です
SetSiblingIndex(index)boolean同階層内での並び順インデックスを設定します
indexの範囲は0から「親コントロールの子コントロール数-1」です
SetAsFirstSibling()boolean同階層の先頭に移動します
SetAsLastSibling()boolean同階層の末尾に移動します

(3) レイアウトと変換

親子階層における移動、拡大縮小、可視性、不透明度、反転、クリッピング効果は、実行時のUI階層によって決定されます。
複合レイアウトを使用する場合は、実際の表示結果を確認してください。

メソッド戻り値内容
GetAnchoredPosition()x, y親階層がない場合はキャンバスの左下を原点として位置を取得し、親階層がある場合は親階層の中心からの相対オフセットを取得します
SetAnchoredPosition(x, y)–親階層がない場合はキャンバスの左下を原点として位置を設定し、親階層がある場合は親階層の中心からの相対オフセットを設定します
GetSizeDelta()x, yサイズの取得
SetSizeDelta(x, y)–サイズの設定
GetAnchorMin()x, y最小アンカーの取得
SetAnchorMin(x, y)–最小アンカーの設定
GetAnchorMax()x, y最大アンカーの取得
SetAnchorMax(x, y)–最大アンカーの設定
GetPivot()x, y中心の取得
SetPivot(x, y)–中心の設定
GetLocalScale()x, y, zズーム比の取得
SetLocalScale(x, y, z)–ズーム比の設定
GetLocalRotation()x, y, z回転の取得
SetLocalRotation(x, y, z)–回転の設定

(4) スクリプトへのアクセス

返されるスクリプトのインスタンスは、破棄され存在していない可能性があります。
使用する前に script.alive で確認してください。

メソッド戻り値内容
GetScriptByPath(scriptPath)Scriptパス指定で紐づけられているスクリプトを取得します
GetScript(scriptMappingId)ScriptスクリプトマッピングIDでスクリプトを取得します
GetScripts()Script[]コントロール上のすべてのスクリプトを取得します

(5) キーボード・マウス / コントローラーのイベント

メソッド戻り値内容
AddKeyEventListener(eventType, callback)–監視するキーイベントを登録します
コールバックはbooleanを返します

監視を削除するには、コールバックの参照を保持しておく必要があります

同じコンテナ内で、インタラクティブなキーイベントがLuaのコールバックによって応答され、処理済みになった場合、コンテナ内の他のキーが今回のキーイベントに重複して応答することはありません
RemoveKeyEventListener(eventType, callback)–登録したキーイベントの監視を解除します
コールバックは登録時と同じ参照である必要があります
RemoveKeyEventListeners(eventType)–指定したキーイベントのすべての監視を解除します
RemoveAllKeyEventListeners()–すべてのキーイベントの監視を解除します

(6) コントローラーナビゲーションイベント

メソッド戻り値内容
AddNavigationEventListener(eventType, callback)–監視するコントローラーナビゲーションイベントを登録します
RemoveNavigationEventListener(eventType, callback)–登録したコントローラーナビゲーションイベントの監視を解除します
RemoveNavigationEventListeners(eventType)–指定したコントローラーナビゲーションイベントのすべての監視を解除します
RemoveAllNavigationEventListeners()–すべてのコントローラーナビゲーションイベントの監視を解除します

(7) コントローラーナビゲーションの設定

メソッド戻り値内容
SetControllerNavigation(navigationDir, navigationMode, navigationTarget)–指定した方向のナビゲーションモードおよびターゲットコントロールを設定します
ターゲットには nil を指定できます
GetControllerNavigation(navigationDir)navigationMode, navigationTarget指定した方向のナビゲーションモードおよびターゲットコントロールを取得します

画像のカラー、マスク、塗りつぶしの効果を制御します。

(1) フィールド

フィールド名型アクセス内容
imageSourceImageSource読み取り専用画像ソース
imageIdinteger読み取り専用画像ID
imageColorColorValue読み書き可能カラー
※Tween可能
imageTypeImageType読み書き可能画像タイプ
enableMaskboolean読み書き可能マスキングを有効にするかどうか
enableSoftEdgeboolean読み書き可能境界線のぼかしを有効にするかどうか
softEdgeModeImageMaskSoftEdgeMode読み書き可能ぼかしモード
softEdgeWidthXnumber読み書き可能水平方向の境界ぼかし幅
※Tween可能
softEdgeWidthYnumber読み書き可能垂直方向の境界ぼかし幅
※Tween可能
horizontalSoftRangenumber読み書き可能横方向エリア範囲
※Tween可能
verticalSoftRangenumber読み書き可能縦方向エリア範囲
※Tween可能
reverseMaskAreaboolean読み書き可能マスクエリア反転するかどうか
fillTypeImageFillType読み書き可能塗りつぶしの形状
fillHorizontalTypeImageFillHorizontalType読み書き可能塗りつぶしの方向(横)
fillVerticalTypeImageFillVerticalType読み書き可能塗りつぶしの方向(縦)
fillRadial90TypeImageFillRadial90Type読み書き可能塗りつぶしの開始位置(90度円軌道)
fillRadialTypeImageFillRadialType読み書き可能塗りつぶしの開始位置(180度,360度円軌道)
fillAmountnumber読み書き可能進捗
※Tween可能

(2) メソッド

メソッド戻り値内容
SetImage(imageSource, imageId)–画像のソースと画像IDを設定する
SetSoftEdgeWidth(widthX, widthY)–水平方向および垂直方向のぼかし幅を設定する
SetFillUnused()–塗りつぶしを使用しないように設定する
SetFillHorizontal(fillHorizontalType, fillAmount)–水平方向の塗りつぶしを設定する
SetFillVertical(fillVerticalType, fillAmount)–垂直方向の塗りつぶしを設定する
SetFillRadial90(fillRadial90Type, fillAmount)–90度円軌道の塗りつぶしを設定する
SetFillRadial180(fillRadialType, fillAmount)–180度円軌道の塗りつぶしを設定する
SetFillRadial360(fillRadialType, fillAmount)–360度円軌道の塗りつぶしを設定する

(1) フィールド

フィールド名型アクセス内容
textstring読み書き可能表示テキスト
fontSizeinteger読み書き可能フォントサイズ
※Tween可能
fontColorColorValue読み書き可能文字色
※Tween可能
bgColorColorValue読み書き可能背景色
※Tween可能
enableOutlineboolean読み書き可能縁取りを有効にするかどうか
outlineColorColorValue読み書き可能縁取りの色
※Tween可能
horizontalAlignmentTextHorizontalAlignment読み書き可能横方向の揃え位置
verticalAlignmentTextVerticalAlignment読み書き可能縦方向の揃え位置
adaptiveFontSizeboolean読み書き可能フォントサイズを自動で調整するかどうか
minimumFontSizeinteger読み書き可能自動調整のフォントの最小サイズ
※Tween可能

(1) フィールド

フィールド型アクセス内容
interactableboolean読み書き可能インタラクト可能かどうか
showScrollBarboolean読み書き可能スクロールバーを表示するかどうか
textstring読み書き可能表示テキスト
fontSizeinteger読み書き可能フォントサイズ
※Tween可能
fontColorColorValue読み書き可能文字色
※Tween可能
bgColorColorValue読み書き可能背景色
※Tween可能
enableOutlineboolean読み書き可能縁取りを有効にするかどうか
outlineColorColorValue読み書き可能縁取り色
※Tween可能
horizontalAlignmentTextHorizontalAlignment読み書き可能横方向の揃え位置
verticalAlignmentTextVerticalAlignment読み書き可能縦方向の揃え位置
adaptiveFontSizeboolean読み書き可能フォントサイズを自動で調整するかどうか
minimumFontSizeinteger読み書き可能自動調整のフォントの最小サイズ
※Tween可能

(1) フィールド

フィールド名型アクセス内容
interactableboolean読み書き可能ボタンの利用可否
clickAudioIdinteger読み書き可能クリックの効果音のインデックス
raycastTargetboolean読み書き可能ポインターのレイキャストで検出可能かどうか

(2) メソッド

メソッド戻り値内容
AddCursorEventListener(eventType, callback)–監視するカーソルイベントを登録する
※コールバックはCursorEventDataを受け取る
RemoveCursorEventListener(eventType, callback)–登録したカーソルイベントおよびコールバックを解除する
RemoveCursorEventListeners(eventType)–指定したカーソルイベントのすべての監視を解除します
RemoveAllCursorEventListeners()–すべてのカーソルイベントの監視を解除します
SimulateCursorClick()–CursorDown、CursorUp、CursorClick を順に実行します

(1) フィールド

フィールド名型アクセス内容
raycastTargetboolean読み書き可能ポインターのレイキャストで検出可能かどうか

(2) メソッド

メソッド戻り値内容
AddCursorEventListener(eventType, callback)–「3-17.ClientUIPresetButtonControl」参照
RemoveCursorEventListener(eventType, callback)–「3-17.ClientUIPresetButtonControl」参照
RemoveCursorEventListeners(eventType)–「3-17.ClientUIPresetButtonControl」参照
RemoveAllCursorEventListeners()–「3-17.ClientUIPresetButtonControl」参照
SimulateCursorClick()–「3-17.ClientUIPresetButtonControl」参照

(1) フィールド

フィールド名型アクセス内容
draggingboolean読み取り専用現在、ドラッグ中かどうか
touchIdinteger読み取り専用タッチポイントID

(2) メソッド

メソッド戻り値内容
CursorEventData:GetUIPos()x, y: numberキャンパスの左下を原点として、現在の画面のUI座標を取得します
座標の比率はレイアウト座標と一致します
CursorEventData:GetPressUIPos()x, y: numberタッチした画面UI座標を取得します
CursorEventData:GetUIPosDelta()x, y: number今回のイベントにおける画面UIの移動量を取得します

(1) フィールド

フィールド名型アクセス内容
itemCountinteger読み取り専用アイテムの数
itemPrefabIndexinteger読み書き可能モジュールテンプレートのインデックス
raycastTargetboolean読み書き可能ポインターのレイキャストで検出可能かどうか
showScrollBarboolean読み書き可能スクロール可能かどうか
interactableboolean読み書き可能スクロールバーを表示するかどうか
scrollDirectionScrollDirection読み取り専用スクロール方向
layoutConstraintScrollLayoutConstraint読み取り専用配列制限
layoutConstraintFixedCountnumber読み取り専用固定列数の時の列数
scrollProgressnumber読み書き可能スクロール進行度
※Tween可能

(2) メソッド

リスト項目のインデックスは、実行時に渡されるindexを基準とします。

メソッド戻り値内容
RefreshItems(itemCount, refreshCallback)–リスト項目を更新し、項目ごとにコールバックを呼び出します
更新コールバックの形式は fun(control: ClientUIBaseControl, index: integer) で、引数は順に「現在のリスト項目コントロール」と「リスト項目のインデックス」です
GetItemIndex(control)integerリスト項目のインデックスを取得します。
GetItemSize()x, y: numberリスト項目の幅と高さを取得します
GetItemSpacing()x, y: numberリスト項目の水平方向および垂直方向の間隔を取得します
GetPadding()top, bottom, left, right: numberコンテンツエリアの上、下、左、右の余白を取得します
ScrollToItemAt(index, scrollAlignType)–index の項目へスクロールし、scrollAlignType に基づいて整列させます
GetContentLength()numberスクロール方向におけるスクロールコンテンツの長さを取得します

現在の入力デバイスに応じて、対応するキーを表示します。

(1) フィールド

フィールド名型アクセス内容
keyboardKeyCodeKeyboardKeyCode読み書き可能キーボード・マウスのキー列挙値
controllerKeyCodeControllerKeyCode読み書き可能コントローラー(パッド)のボタン列挙値

設定済みの画面エフェクトを再生または停止するために使用します。

(1) フィールド

フィールド名型アクセス内容
animationIdinteger読み書き可能画面エフェクトのインデックス
playSoundEffectboolean読み書き可能効果音を再生するかどうか
layerUIAnimationLayer読み書き可能レイヤー

(2) メソッド

メソッド戻り値内容
PlayAnimation()–画面エフェクトを再生する
StopAnimation()–画面エフェクトを停止する

(1) フィールド

フィールド名型アクセス内容
animationIdinteger読み書き可能画面エフェクトのID
playSoundEffectboolean読み書き可能効果音を再生するかどうか

子コントロールを整理、管理するために使用します。

(1) フィールド

フィールド名型アクセス内容
isolateNavigationboolean読み書き可能コントローラーナビゲーションを隔離するかどうか
disableKeyEventPassthroughboolean読み書き可能ボタンイベントの貫通をブロックするかどうか
disableCursorEventPassthroughboolean読み書き可能エリア内のポインターイベントの貫通をブロックするかどうか
showCursorboolean読み書き可能ポインターを常時表示するかどうか

設定済みのコントロールテンプレートを参照するために使用します。

(1) フィールド

フィールド名型アクセス内容
referencedPrefabIndexinteger読み取り専用参照するモジュールテンプレートのインデックス

(1) Enum.KeyboardKeyCode

列挙名列挙値内容デフォルトの割り当て
Enum.KeyboardKeyCodeCraftspersonKey1クリエイターキー11
Enum.KeyboardKeyCodeCraftspersonKey2クリエイターキー22
Enum.KeyboardKeyCodeCraftspersonKey3クリエイターキー33
Enum.KeyboardKeyCodeCraftspersonKey4クリエイターキー44
Enum.KeyboardKeyCodeCraftspersonKey5クリエイターキー55
Enum.KeyboardKeyCodeCraftspersonKey6クリエイターキー66
Enum.KeyboardKeyCodeCraftspersonKey7クリエイターキー77
Enum.KeyboardKeyCodeCraftspersonKey8クリエイターキー88
Enum.KeyboardKeyCodeCraftspersonKey9クリエイターキー99
Enum.KeyboardKeyCodeCraftspersonKey10クリエイターキー100
Enum.KeyboardKeyCodeCraftspersonKey11クリエイターキー11U
Enum.KeyboardKeyCodeCraftspersonKey12クリエイターキー12Z
Enum.KeyboardKeyCodeCraftspersonKey13クリエイターキー13Y
Enum.KeyboardKeyCodeCraftspersonKey14クリエイターキー14G
Enum.KeyboardKeyCodeCraftspersonKey15クリエイターキー15H
Enum.KeyboardKeyCodeCraftspersonKey16クリエイターキー16I
Enum.KeyboardKeyCodeCraftspersonKey17クリエイターキー17O
Enum.KeyboardKeyCodeCraftspersonKey18クリエイターキー18P
Enum.KeyboardKeyCodeCraftspersonKey19クリエイターキー19J
Enum.KeyboardKeyCodeCraftspersonKey20クリエイターキー20K
Enum.KeyboardKeyCodeCraftspersonKey21クリエイターキー21L
Enum.KeyboardKeyCodeCraftspersonKey22クリエイターキー22V
Enum.KeyboardKeyCodeCraftspersonKey23クリエイターキー23F5
Enum.KeyboardKeyCodeCraftspersonKey24クリエイターキー24F6
Enum.KeyboardKeyCodeCraftspersonKey25クリエイターキー25F7
Enum.KeyboardKeyCodeCraftspersonKey26クリエイターキー26F8
Enum.KeyboardKeyCodeCraftspersonKey27クリエイターキー27F9
Enum.KeyboardKeyCodeCraftspersonKey28クリエイターキー28F10
Enum.KeyboardKeyCodeCraftspersonKey29クリエイターキー29‘
Enum.KeyboardKeyCodeCraftspersonKey30クリエイターキー30–
Enum.KeyboardKeyCodeCraftspersonKey31クリエイターキー31=
Enum.KeyboardKeyCodeCraftspersonKey32クリエイターキー32[
Enum.KeyboardKeyCodeCraftspersonKey33クリエイターキー33,
Enum.KeyboardKeyCodeCraftspersonKey34クリエイターキー34.
Enum.KeyboardKeyCodeCraftspersonKey35クリエイターキー35/
Enum.KeyboardKeyCodeCraftspersonKey36クリエイターキー36↑
Enum.KeyboardKeyCodeCraftspersonKey37クリエイターキー37↓
Enum.KeyboardKeyCodeCraftspersonKey38クリエイターキー38←
Enum.KeyboardKeyCodeCraftspersonKey39クリエイターキー39→
Enum.KeyboardKeyCodeCraftspersonKey40クリエイターキー40右Ctrl
Enum.KeyboardKeyCodeCraftspersonKey41クリエイターキー41右Shift
Enum.KeyboardKeyCodeCraftspersonKey42クリエイターキー42BackSpace
Enum.KeyboardKeyCodeCraftspersonKey43クリエイターキー43CapsLock
Enum.KeyboardKeyCodeMoveForwardKey前に移動W
Enum.KeyboardKeyCodeMoveBackwardKey後ろに移動S
Enum.KeyboardKeyCodeMoveLeftKey左に移動A
Enum.KeyboardKeyCodeMoveRightKey右に移動D
Enum.KeyboardKeyCodeSwitchToWalkOrRunKey歩く/走る状態を切り替える左Ctrl
Enum.KeyboardKeyCodeSprintKeyダッシュ右クリック
Enum.KeyboardKeyCodeJumpKeyジャンプSpace
Enum.KeyboardKeyCodeDropKey落下X
Enum.KeyboardKeyCodeOpenShortcutWheelKeyショートカットルーレット呼出Tab
Enum.KeyboardKeyCodeInteractKey拾う/会話F
Enum.KeyboardKeyCodeNormalAttackKey通常攻撃左クリック
Enum.KeyboardKeyCodeCharacterSkill1Keyキャラスキル1E
Enum.KeyboardKeyCodeCharacterSkill2Keyキャラスキル2Q
Enum.KeyboardKeyCodeCharacterSkill3Keyキャラスキル3R
Enum.KeyboardKeyCodeCharacterSkill4Keyキャラスキル4T
Enum.KeyboardKeyCodeNoneなし–

(2) Enum.ControllerKeyCode

列挙名列挙値内容デフォルトの割り当て
Enum.ControllerKeyCodeCraftspersonKey1クリエイターキー1方向キー左
Enum.ControllerKeyCodeCraftspersonKey2クリエイターキー2方向キー下
Enum.ControllerKeyCodeCraftspersonKey3クリエイターキー3LT
Enum.ControllerKeyCodeCraftspersonKey4クリエイターキー4LB + Y
Enum.ControllerKeyCodeCraftspersonKey5クリエイターキー5LB + X
Enum.ControllerKeyCodeCraftspersonKey6クリエイターキー6LB + A
Enum.ControllerKeyCodeCraftspersonKey7クリエイターキー7LB + 方向キー上
Enum.ControllerKeyCodeCraftspersonKey8クリエイターキー8LB + 方向キー右
Enum.ControllerKeyCodeCraftspersonKey9クリエイターキー9LB + 方向キー左
Enum.ControllerKeyCodeCraftspersonKey10クリエイターキー10LB + 方向キー下
Enum.ControllerKeyCodeCraftspersonKey11クリエイターキー11LB + RB
Enum.ControllerKeyCodeCraftspersonKey12クリエイターキー12LB + LT
Enum.ControllerKeyCodeCraftspersonKey13クリエイターキー13LB + RT
Enum.ControllerKeyCodeCraftspersonKey14クリエイターキー14LB + LS(左スティック押下)
Enum.ControllerKeyCodeSprintKeyダッシュRB
Enum.ControllerKeyCodeJumpKeyジャンプA
Enum.ControllerKeyCodeInteractKey拾う/会話X
Enum.ControllerKeyCodeNormalAttackKey通常攻撃B
Enum.ControllerKeyCodeCharacterSkill1Keyキャラスキル1RT
Enum.ControllerKeyCodeCharacterSkill2Keyキャラスキル2Y
Enum.ControllerKeyCodeCharacterSkill3Keyキャラスキル3方向キー上
Enum.ControllerKeyCodeCharacterSkill4Keyキャラスキル4方向キー右
Enum.ControllerKeyCodeMenuConfirmKeyメニュー決定– (コントローラーナビゲーションの設定により決定)
Enum.ControllerKeyCodeMenuBackKeyメニュー戻る– (コントローラーナビゲーションの設定により決定)
Enum.ControllerKeyCodeNoneなし–

(3) Enum.KeyEventType

列挙名列挙値内容デフォルトの割り当て
Enum.KeyEventTypeKeyboardCraftspersonKey1Downキーボード&マウス:クリエイターキー1(押下)1
Enum.KeyEventTypeKeyboardCraftspersonKey2Downキーボード&マウス:クリエイターキー2(押下)2
Enum.KeyEventTypeKeyboardCraftspersonKey3Downキーボード&マウス:クリエイターキー3(押下)3
Enum.KeyEventTypeKeyboardCraftspersonKey4Downキーボード&マウス:クリエイターキー4(押下)4
Enum.KeyEventTypeKeyboardCraftspersonKey5Downキーボード&マウス:クリエイターキー5(押下)5
Enum.KeyEventTypeKeyboardCraftspersonKey6Downキーボード&マウス:クリエイターキー6(押下)6
Enum.KeyEventTypeKeyboardCraftspersonKey7Downキーボード&マウス:クリエイターキー7(押下)7
Enum.KeyEventTypeKeyboardCraftspersonKey8Downキーボード&マウス:クリエイターキー8(押下)8
Enum.KeyEventTypeKeyboardCraftspersonKey9Downキーボード&マウス:クリエイターキー9(押下)9
Enum.KeyEventTypeKeyboardCraftspersonKey10Downキーボード&マウス:クリエイターキー10(押下)0
Enum.KeyEventTypeKeyboardCraftspersonKey11Downキーボード&マウス:クリエイターキー11(押下)U
Enum.KeyEventTypeKeyboardCraftspersonKey12Downキーボード&マウス:クリエイターキー12(押下)Z
Enum.KeyEventTypeKeyboardCraftspersonKey13Downキーボード&マウス:クリエイターキー13(押下)Y
Enum.KeyEventTypeKeyboardCraftspersonKey14Downキーボード&マウス:クリエイターキー14(押下)G
Enum.KeyEventTypeKeyboardCraftspersonKey15Downキーボード&マウス:クリエイターキー15(押下)H
Enum.KeyEventTypeKeyboardCraftspersonKey16Downキーボード&マウス:クリエイターキー16(押下)I
Enum.KeyEventTypeKeyboardCraftspersonKey17Downキーボード&マウス:クリエイターキー17(押下)O
Enum.KeyEventTypeKeyboardCraftspersonKey18Downキーボード&マウス:クリエイターキー18(押下)P
Enum.KeyEventTypeKeyboardCraftspersonKey19Downキーボード&マウス:クリエイターキー19(押下)J
Enum.KeyEventTypeKeyboardCraftspersonKey20Downキーボード&マウス:クリエイターキー20(押下)K
Enum.KeyEventTypeKeyboardCraftspersonKey21Downキーボード&マウス:クリエイターキー21(押下)L
Enum.KeyEventTypeKeyboardCraftspersonKey22Downキーボード&マウス:クリエイターキー22(押下)V
Enum.KeyEventTypeKeyboardCraftspersonKey23Downキーボード&マウス:クリエイターキー23(押下)F5
Enum.KeyEventTypeKeyboardCraftspersonKey24Downキーボード&マウス:クリエイターキー24(押下)F6
Enum.KeyEventTypeKeyboardCraftspersonKey25Downキーボード&マウス:クリエイターキー25(押下)F7
Enum.KeyEventTypeKeyboardCraftspersonKey26Downキーボード&マウス:クリエイターキー26(押下)F8
Enum.KeyEventTypeKeyboardCraftspersonKey27Downキーボード&マウス:クリエイターキー27(押下)F9
Enum.KeyEventTypeKeyboardCraftspersonKey28Downキーボード&マウス:クリエイターキー28(押下)F10
Enum.KeyEventTypeKeyboardCraftspersonKey29Downキーボード&マウス:クリエイターキー29(押下)‘
Enum.KeyEventTypeKeyboardCraftspersonKey30Downキーボード&マウス:クリエイターキー30(押下)–
Enum.KeyEventTypeKeyboardCraftspersonKey31Downキーボード&マウス:クリエイターキー31(押下)=
Enum.KeyEventTypeKeyboardCraftspersonKey32Downキーボード&マウス:クリエイターキー32(押下)[
Enum.KeyEventTypeKeyboardCraftspersonKey33Downキーボード&マウス:クリエイターキー33(押下),
Enum.KeyEventTypeKeyboardCraftspersonKey34Downキーボード&マウス:クリエイターキー34(押下).
Enum.KeyEventTypeKeyboardCraftspersonKey35Downキーボード&マウス:クリエイターキー35(押下)/
Enum.KeyEventTypeKeyboardCraftspersonKey36Downキーボード&マウス:クリエイターキー36(押下)↑
Enum.KeyEventTypeKeyboardCraftspersonKey37Downキーボード&マウス:クリエイターキー37(押下)↓
Enum.KeyEventTypeKeyboardCraftspersonKey38Downキーボード&マウス:クリエイターキー38(押下)←
Enum.KeyEventTypeKeyboardCraftspersonKey39Downキーボード&マウス:クリエイターキー39(押下)→
Enum.KeyEventTypeKeyboardCraftspersonKey40Downキーボード&マウス:クリエイターキー40(押下)右Ctrl
Enum.KeyEventTypeKeyboardCraftspersonKey41Downキーボード&マウス:クリエイターキー41(押下)右Shift
Enum.KeyEventTypeKeyboardCraftspersonKey42Downキーボード&マウス:クリエイターキー42(押下)Backspace
Enum.KeyEventTypeKeyboardCraftspersonKey43Downキーボード&マウス:クリエイターキー43(押下)CapsLock
Enum.KeyEventTypeKeyboardMoveForwardKeyDownキーボード&マウス:前に移動(押下)W
Enum.KeyEventTypeKeyboardMoveBackwardKeyDownキーボード&マウス:後ろに移動(押下)S
Enum.KeyEventTypeKeyboardMoveLeftKeyDownキーボード&マウス:左に移動(押下)A
Enum.KeyEventTypeKeyboardMoveRightKeyDownキーボード&マウス:右に移動(押下)D
Enum.KeyEventTypeKeyboardSwitchToWalkOrRunKeyDownキーボード&マウス:歩く/走る状態を切り替える(押下)左Ctrl
Enum.KeyEventTypeKeyboardSprintKeyDownキーボード&マウス:ダッシュ(押下)右クリック
Enum.KeyEventTypeKeyboardJumpKeyDownキーボード&マウス:ジャンプ(押下)Space
Enum.KeyEventTypeKeyboardDropKeyDownキーボード&マウス:落下(押下)X
Enum.KeyEventTypeKeyboardOpenShortcutWheelKeyDownキーボード&マウス:ショートカットルーレット呼出(押下)Tab
Enum.KeyEventTypeKeyboardInteractKeyDownキーボード&マウス:拾う/会話(押下)F
Enum.KeyEventTypeKeyboardNormalAttackKeyDownキーボード&通常攻撃(押下)左クリック
Enum.KeyEventTypeKeyboardCharacterSkill1KeyDownキーボード&マウス:キャラスキル1(押下)E
Enum.KeyEventTypeKeyboardCharacterSkill2KeyDownキーボード&マウス:キャラスキル2(押下)Q
Enum.KeyEventTypeKeyboardCharacterSkill3KeyDownキーボード&マウス:キャラスキル3(押下)R
Enum.KeyEventTypeKeyboardCharacterSkill4KeyDownキーボード&マウス:キャラスキル4(押下)T
列挙名列挙値内容デフォルトの割り当て
Enum.KeyEventTypeKeyboardCraftspersonKey1Upキーボード&マウス:クリエイターキー1(離す)1
Enum.KeyEventTypeKeyboardCraftspersonKey2Upキーボード&マウス:クリエイターキー2(離す)2
Enum.KeyEventTypeKeyboardCraftspersonKey3Upキーボード&マウス:クリエイターキー3(離す)3
Enum.KeyEventTypeKeyboardCraftspersonKey4Upキーボード&マウス:クリエイターキー4(離す)4
Enum.KeyEventTypeKeyboardCraftspersonKey5Upキーボード&マウス:クリエイターキー5(離す)5
Enum.KeyEventTypeKeyboardCraftspersonKey6Upキーボード&マウス:クリエイターキー6(離す)6
Enum.KeyEventTypeKeyboardCraftspersonKey7Upキーボード&マウス:クリエイターキー7(離す)7
Enum.KeyEventTypeKeyboardCraftspersonKey8Upキーボード&マウス:クリエイターキー8(離す)8
Enum.KeyEventTypeKeyboardCraftspersonKey9Upキーボード&マウス:クリエイターキー9(離す)9
Enum.KeyEventTypeKeyboardCraftspersonKey10Upキーボード&マウス:クリエイターキー10(離す)0
Enum.KeyEventTypeKeyboardCraftspersonKey11Upキーボード&マウス:クリエイターキー11(離す)U
Enum.KeyEventTypeKeyboardCraftspersonKey12Upキーボード&マウス:クリエイターキー12(離す)Z
Enum.KeyEventTypeKeyboardCraftspersonKey13Upキーボード&マウス:クリエイターキー13(離す)Y
Enum.KeyEventTypeKeyboardCraftspersonKey14Upキーボード&マウス:クリエイターキー14(離す)G
Enum.KeyEventTypeKeyboardCraftspersonKey15Upキーボード&マウス:クリエイターキー15(離す)H
Enum.KeyEventTypeKeyboardCraftspersonKey16Upキーボード&マウス:クリエイターキー16(離す)I
Enum.KeyEventTypeKeyboardCraftspersonKey17Upキーボード&マウス:クリエイターキー17(離す)O
Enum.KeyEventTypeKeyboardCraftspersonKey18Upキーボード&マウス:クリエイターキー18(離す)P
Enum.KeyEventTypeKeyboardCraftspersonKey19Upキーボード&マウス:クリエイターキー19(離す)J
Enum.KeyEventTypeKeyboardCraftspersonKey20Upキーボード&マウス:クリエイターキー20(離す)K
Enum.KeyEventTypeKeyboardCraftspersonKey21Upキーボード&マウス:クリエイターキー21(離す)L
Enum.KeyEventTypeKeyboardCraftspersonKey22Upキーボード&マウス:クリエイターキー22(離す)V
Enum.KeyEventTypeKeyboardCraftspersonKey23Upキーボード&マウス:クリエイターキー23(離す)F5
Enum.KeyEventTypeKeyboardCraftspersonKey24Upキーボード&マウス:クリエイターキー24(離す)F6
Enum.KeyEventTypeKeyboardCraftspersonKey25Upキーボード&マウス:クリエイターキー25(離す)F7
Enum.KeyEventTypeKeyboardCraftspersonKey26Upキーボード&マウス:クリエイターキー26(離す)F8
Enum.KeyEventTypeKeyboardCraftspersonKey27Upキーボード&マウス:クリエイターキー27(離す)F9
Enum.KeyEventTypeKeyboardCraftspersonKey28Upキーボード&マウス:クリエイターキー28(離す)F10
Enum.KeyEventTypeKeyboardCraftspersonKey29Upキーボード&マウス:クリエイターキー29(離す)‘
Enum.KeyEventTypeKeyboardCraftspersonKey30Upキーボード&マウス:クリエイターキー30(離す)–
Enum.KeyEventTypeKeyboardCraftspersonKey31Upキーボード&マウス:クリエイターキー31(離す)=
Enum.KeyEventTypeKeyboardCraftspersonKey32Upキーボード&マウス:クリエイターキー32(離す)[
Enum.KeyEventTypeKeyboardCraftspersonKey33Upキーボード&マウス:クリエイターキー33(離す),
Enum.KeyEventTypeKeyboardCraftspersonKey34Upキーボード&マウス:クリエイターキー34(離す).
Enum.KeyEventTypeKeyboardCraftspersonKey35Upキーボード&マウス:クリエイターキー35(離す)/
Enum.KeyEventTypeKeyboardCraftspersonKey36Upキーボード&マウス:クリエイターキー36(離す)↑
Enum.KeyEventTypeKeyboardCraftspersonKey37Upキーボード&マウス:クリエイターキー37(離す)↓
Enum.KeyEventTypeKeyboardCraftspersonKey38Upキーボード&マウス:クリエイターキー38(離す)←
Enum.KeyEventTypeKeyboardCraftspersonKey39Upキーボード&マウス:クリエイターキー39(離す)→
Enum.KeyEventTypeKeyboardCraftspersonKey40Upキーボード&マウス:クリエイターキー40(離す)右Ctrl
Enum.KeyEventTypeKeyboardCraftspersonKey41Upキーボード&マウス:クリエイターキー41(離す)右Shift
Enum.KeyEventTypeKeyboardCraftspersonKey42Upキーボード&マウス:クリエイターキー42(離す)Backspace
Enum.KeyEventTypeKeyboardCraftspersonKey43Upキーボード&マウス:クリエイターキー43(離す)CapsLock
Enum.KeyEventTypeKeyboardMoveForwardKeyUpキーボード&マウス:前に移動(離す)W
Enum.KeyEventTypeKeyboardMoveBackwardKeyUpキーボード&マウス:後ろに移動(離す)S
Enum.KeyEventTypeKeyboardMoveLeftKeyUpキーボード&マウス:左に移動(離す)A
Enum.KeyEventTypeKeyboardMoveRightKeyUpキーボード&マウス:右に移動(離す)D
Enum.KeyEventTypeKeyboardSwitchToWalkOrRunKeyUpキーボード&マウス:歩く/走る状態を切り替える(離す)左Ctrl
Enum.KeyEventTypeKeyboardSprintKeyUpキーボード&マウス:ダッシュ(離す)右クリック
Enum.KeyEventTypeKeyboardJumpKeyUpキーボード&マウス:ジャンプ(離す)Space
Enum.KeyEventTypeKeyboardDropKeyUpキーボード&マウス:落下(離す)X
Enum.KeyEventTypeKeyboardOpenShortcutWheelKeyUpキーボード&マウス:ショートカットルーレット呼出(離す)Tab
Enum.KeyEventTypeKeyboardInteractKeyUpキーボード&マウス:拾う/会話(離す)F
Enum.KeyEventTypeKeyboardNormalAttackKeyUpキーボード&通常攻撃(離す)左クリック
Enum.KeyEventTypeKeyboardCharacterSkill1KeyUpキーボード&マウス:キャラスキル1(離す)E
Enum.KeyEventTypeKeyboardCharacterSkill2KeyUpキーボード&マウス:キャラスキル2(離す)Q
Enum.KeyEventTypeKeyboardCharacterSkill3KeyUpキーボード&マウス:キャラスキル3(離す)R
Enum.KeyEventTypeKeyboardCharacterSkill4KeyUpキーボード&マウス:キャラスキル4(離す)T
列挙名列挙値内容デフォルトの割り当て
Enum.KeyEventTypeControllerCraftspersonKey1Downコントローラー:クリエイターキー1(押下)方向キー左
Enum.KeyEventTypeControllerCraftspersonKey2Downコントローラー:クリエイターキー2(押下)方向キー下
Enum.KeyEventTypeControllerCraftspersonKey3Downコントローラー:クリエイターキー3(押下)LT
Enum.KeyEventTypeControllerCraftspersonKey4Downコントローラー:クリエイターキー4(押下)LB + Y
Enum.KeyEventTypeControllerCraftspersonKey5Downコントローラー:クリエイターキー5(押下)LB + X
Enum.KeyEventTypeControllerCraftspersonKey6Downコントローラー:クリエイターキー6(押下)LB + A
Enum.KeyEventTypeControllerCraftspersonKey7Downコントローラー:クリエイターキー7(押下)LB + 方向キー上
Enum.KeyEventTypeControllerCraftspersonKey8Downコントローラー:クリエイターキー8(押下)LB + 方向キー右
Enum.KeyEventTypeControllerCraftspersonKey9Downコントローラー:クリエイターキー9(押下)LB + 方向キー左
Enum.KeyEventTypeControllerCraftspersonKey10Downコントローラー:クリエイターキー10(押下)LB + 方向キー下
Enum.KeyEventTypeControllerCraftspersonKey11Downコントローラー:クリエイターキー11(押下)LB + RB
Enum.KeyEventTypeControllerCraftspersonKey12Downコントローラー:クリエイターキー12(押下)LB + LT
Enum.KeyEventTypeControllerCraftspersonKey13Downコントローラー:クリエイターキー13(押下)LB + RT
Enum.KeyEventTypeControllerCraftspersonKey14Downコントローラー:クリエイターキー14(押下)LB + LS(左スティック押下)
Enum.KeyEventTypeControllerSprintKeyDownコントローラー:ダッシュ(押下)RB
Enum.KeyEventTypeControllerJumpKeyDownコントローラー:ジャンプ(押下)A
Enum.KeyEventTypeControllerInteractKeyDownコントローラー:拾う/会話(押下)X
Enum.KeyEventTypeControllerNormalAttackKeyDownコントローラー:通常攻撃(押下)B
Enum.KeyEventTypeControllerCharacterSkill1KeyDownコントローラー:キャラスキル1(押下)RT
Enum.KeyEventTypeControllerCharacterSkill2KeyDownコントローラー:キャラスキル2(押下)Y
Enum.KeyEventTypeControllerCharacterSkill3KeyDownコントローラー:キャラスキル3(押下)方向キー上
Enum.KeyEventTypeControllerCharacterSkill4KeyDownコントローラー:キャラスキル4(押下)方向キー右
Enum.KeyEventTypeControllerMenuConfirmKeyDownコントローラー:メニュー決定(押下)– (コントローラーナビゲーションの設定により決定)
Enum.KeyEventTypeControllerMenuBackKeyDownコントローラー:メニュー戻る(押下)– (コントローラーナビゲーションの設定により決定)
列挙名列挙値内容デフォルトの割り当て
Enum.KeyEventTypeControllerCraftspersonKey1Upコントローラー:クリエイターキー1(離す)方向キー左
Enum.KeyEventTypeControllerCraftspersonKey2Upコントローラー:クリエイターキー2(離す)方向キー下
Enum.KeyEventTypeControllerCraftspersonKey3Upコントローラー:クリエイターキー3(離す)LT
Enum.KeyEventTypeControllerCraftspersonKey4Upコントローラー:クリエイターキー4(離す)LB + Y
Enum.KeyEventTypeControllerCraftspersonKey5Upコントローラー:クリエイターキー5(離す)LB + X
Enum.KeyEventTypeControllerCraftspersonKey6Upコントローラー:クリエイターキー6(離す)LB + A
Enum.KeyEventTypeControllerCraftspersonKey7Upコントローラー:クリエイターキー7(離す)LB + 方向キー上
Enum.KeyEventTypeControllerCraftspersonKey8Upコントローラー:クリエイターキー8(離す)LB + 方向キー右
Enum.KeyEventTypeControllerCraftspersonKey9Upコントローラー:クリエイターキー9(離す)LB + 方向キー左
Enum.KeyEventTypeControllerCraftspersonKey10Upコントローラー:クリエイターキー10(離す)LB + 方向キー下
Enum.KeyEventTypeControllerCraftspersonKey11Upコントローラー:クリエイターキー11(離す)LB + RB
Enum.KeyEventTypeControllerCraftspersonKey12Upコントローラー:クリエイターキー12(離す)LB + LT
Enum.KeyEventTypeControllerCraftspersonKey13Upコントローラー:クリエイターキー13(離す)LB + RT
Enum.KeyEventTypeControllerCraftspersonKey14Upコントローラー:クリエイターキー14(離す)LB + LS(左スティック押下)
Enum.KeyEventTypeControllerSprintKeyUpコントローラー:ダッシュ(離す)RB
Enum.KeyEventTypeControllerJumpKeyUpコントローラー:ジャンプ(離す)A
Enum.KeyEventTypeControllerInteractKeyUpコントローラー:拾う/会話(離す)X
Enum.KeyEventTypeControllerNormalAttackKeyUpコントローラー:通常攻撃(離す)B
Enum.KeyEventTypeControllerCharacterSkill1KeyUpコントローラー:キャラスキル1(離す)RT
Enum.KeyEventTypeControllerCharacterSkill2KeyUpコントローラー:キャラスキル2(離す)Y
Enum.KeyEventTypeControllerCharacterSkill3KeyUpコントローラー:キャラスキル3(離す)方向キー上
Enum.KeyEventTypeControllerCharacterSkill4KeyUpコントローラー:キャラスキル4(離す)方向キー右
Enum.KeyEventTypeControllerMenuConfirmKeyUpコントローラー:メニュー決定(離す)– (コントローラーナビゲーションの設定により決定)
Enum.KeyEventTypeControllerMenuBackKeyUpコントローラー:メニュー戻る(離す)– (コントローラーナビゲーションの設定により決定)

コメント