Portal SDK API リファレンス (日本語)

バージョン: 1.0.1.0
元ファイル: index.d.ts
最終更新: 2025年10月26日

⚠️ 注意: index.d.tsは自動生成されるファイルです。このドキュメントはSDKの日本語リファレンスとして作成されています。

列挙型 (Enums)

RuntimeSpawn (ランタイムスポーン)

各マップで使用可能なスポーンオブジェクトの列挙値です。

対応マップ:

RuntimeSpawn_Abbasid - Abbasidマップ
RuntimeSpawn_Aftermath - Aftermathマップ
RuntimeSpawn_Battery - Batteryマップ
RuntimeSpawn_Capstone - Capstoneマップ
RuntimeSpawn_Common - 全マップ共通
RuntimeSpawn_Dumbo - Dumboマップ
RuntimeSpawn_FireStorm - FireStormマップ
RuntimeSpawn_Limestone - Limestoneマップ
RuntimeSpawn_Outskirts - Outskirtsマップ
RuntimeSpawn_Tungsten - Tungstenマップ

各列挙型には、建物、車両、小道具、植生、効果音などの3Dアセット名が含まれています。

関数リファレンス

AI関連

`AIBattlefieldBehavior(player: Player): void`

説明: AIに戦場での行動をさせます。

`AIDefendPositionBehavior(player: Player, position: Vector, range: number): void`

説明: AIに指定位置を防衛させます。

player - AI制御するプレイヤー
position - 防衛する位置
range - 防衛範囲

`AIMoveToBehavior(player: Player, destination: Vector): void`

説明: AIを指定位置に移動させます。

player - AI制御するプレイヤー
destination - 目的地

`AITargetPlayerBehavior(player: Player, target: Player): void`

説明: AIに特定のプレイヤーを標的にさせます。

player - AI制御するプレイヤー
target - 標的となるプレイヤー

`SetAIBehavior(player: Player, behavior: AIBehavior): void`

説明: AIの行動パターンを設定します。

プレイヤー関連

`DealDamage(player: Player, amount: number): void`

説明: プレイヤーにダメージを与えます。

player - 対象プレイヤー
amount - ダメージ量

`Heal(player: Player, amount: number): void`

説明: プレイヤーを回復します。

player - 対象プレイヤー
amount - 回復量

`Kill(player: Player, killer: Player): void`

説明: プレイヤーをキルします。

player - キルされるプレイヤー
killer - キルしたプレイヤー

`Teleport(player: Player, position: Vector): void`

説明: プレイヤーを指定位置にテレポートします。

player - 対象プレイヤー
position - テレポート先の座標

`SetPlayerHealth(player: Player, health: number): void`

説明: プレイヤーの体力を設定します。

`SetPlayerMaxHealth(player: Player, maxHealth: number): void`

説明: プレイヤーの最大体力を設定します。

`GivePlayerGadget(player: Player, gadget: GadgetUnlock): void`

説明: プレイヤーにガジェットを付与します。

`GivePlayerWeapon(player: Player, weapon: WeaponUnlock): void`

説明: プレイヤーに武器を付与します。

`RemovePlayerGadget(player: Player, gadgetSlot: GadgetSlot): void`

説明: プレイヤーからガジェットを削除します。

`RemovePlayerWeapon(player: Player): void`

説明: プレイヤーから武器を削除します。

`SetPlayerMovementScale(player: Player, scale: number): void`

説明: プレイヤーの移動速度の倍率を設定します。

`SetPlayerScale(player: Player, scale: number): void`

説明: プレイヤーのサイズスケールを設定します。

`SpotTarget(spotter: Player, target: Player, duration: number): void`

説明: 標的をスポットします。

spotter - スポットするプレイヤー
target - スポットされる標的
duration - スポット時間(秒)

UI関連

`AddUIButton(player: Player, text: string, position: Vector2, size: Vector2): UIWidget`

説明: UIボタンを追加します。

player - 対象プレイヤー
text - ボタンのテキスト
position - 画面上の位置
size - ボタンのサイズ
戻り値: 作成されたUIウィジェット

`AddUIContainer(player: Player, position: Vector2, size: Vector2): UIWidget`

説明: UIコンテナを追加します。

`AddUIImage(player: Player, imagePath: string, position: Vector2, size: Vector2): UIWidget`

説明: UI画像を追加します。

`AddUIText(player: Player, text: string, position: Vector2, fontSize: number): UIWidget`

説明: UIテキストを追加します。

`RemoveUIWidget(player: Player, widget: UIWidget): void`

説明: UIウィジェットを削除します。

`SetUIWidgetVisible(widget: UIWidget, visible: boolean): void`

説明: UIウィジェットの表示/非表示を設定します。

`UpdateUIText(widget: UIWidget, text: string): void`

説明: UIテキストを更新します。

車両関連

`ForceVehicleSpawnerSpawn(spawner: VehicleSpawner): void`

説明: 車両スポーナーを強制的にスポーンさせます。

`GetVehicleDriver(vehicle: Vehicle): Player`

説明: 車両のドライバーを取得します。

`GetVehicleHealth(vehicle: Vehicle): number`

説明: 車両の体力を取得します。

`SetVehicleHealth(vehicle: Vehicle, health: number): void`

説明: 車両の体力を設定します。

`SetVehicleMaxHealthMultiplier(vehicle: Vehicle, multiplier: number): void`

説明: 車両の最大体力の倍率を設定します。

`DestroyVehicle(vehicle: Vehicle): void`

説明: 車両を破壊します。

`EjectAllPlayersFromVehicle(vehicle: Vehicle): void`

説明: 車両から全プレイヤーを排出します。

`EjectPlayerFromVehicle(player: Player): void`

説明: プレイヤーを車両から排出します。

数学関数

`Add(a: number, b: number): number`

説明: 2つの数値を加算します。

`Subtract(a: number, b: number): number`

説明: 2つの数値を減算します。

`Multiply(a: number, b: number): number`

説明: 2つの数値を乗算します。

`Divide(a: number, b: number): number`

説明: 2つの数値を除算します。

`CrossProduct(a: Vector, b: Vector): Vector`

説明: ベクトルの外積を計算します。

`DotProduct(a: Vector, b: Vector): number`

説明: ベクトルの内積を計算します。

`Distance(a: Vector, b: Vector): number`

説明: 2点間の距離を計算します。

`Normalize(vector: Vector): Vector`

説明: ベクトルを正規化します。

`VectorLength(vector: Vector): number`

説明: ベクトルの長さを取得します。

`AngleBetweenVectors(a: Vector, b: Vector): number`

説明: 2つのベクトル間の角度を計算します。

`RandomReal(min: number, max: number): number`

説明: 指定範囲のランダムな実数を生成します。

`RandomInteger(min: number, max: number): number`

説明: 指定範囲のランダムな整数を生成します。

配列操作

`AppendToArray(array: any[], element: any): any[]`

説明: 配列に要素を追加します。

`RemoveFromArray(array: any[], element: any): any[]`

説明: 配列から要素を削除します。

`SortedArray(array: any[], rank: number): any[]`

説明: 配列をソートします。

`ArrayContains(array: any[], element: any): boolean`

説明: 配列に要素が含まれているか確認します。

`CountOf(array: any[]): number`

説明: 配列の要素数を取得します。

`FirstOf(array: any[]): any`

説明: 配列の最初の要素を取得します。

`LastOf(array: any[]): any`

説明: 配列の最後の要素を取得します。

ゲームモード制御

`EndGameMode(winningTeam: Team): void`

説明: ゲームモードを終了し、勝利チームを設定します。

`PauseGameMode(): void`

説明: ゲームモードを一時停止します。

`ResumeGameMode(): void`

説明: ゲームモードを再開します。

`SetGameModeTimeLimit(seconds: number): void`

説明: ゲームモードの制限時間を設定します。

`SetRoundTimeRemaining(seconds: number): void`

説明: ラウンドの残り時間を設定します。

`SetMatchTime(seconds: number): void`

説明: マッチの時間を設定します。

`DeclareWinner(team: Team): void`

説明: 勝者を宣言します。

イベントハンドラ

`OngoingGlobal(): void`

説明: 常に実行され続けるグローバルイベント。

`OnGameModeStarted(): void`

説明: ゲームモード開始時にトリガーされます。

`OnGameModeEnding(): void`

説明: ゲームモード終了時にトリガーされます。

`OnPlayerJoinGame(eventPlayer: Player): void`

説明: プレイヤーがゲームに参加したときにトリガーされます。

eventPlayer - 参加したプレイヤー

`OnPlayerLeaveGame(eventNumber: number): void`

説明: プレイヤーがゲームを退出したときにトリガーされます。

eventNumber - プレイヤー番号

`OnPlayerDeployed(eventPlayer: Player): void`

説明: プレイヤーがデプロイ(出撃)したときにトリガーされます。

eventPlayer - デプロイしたプレイヤー

`OnPlayerUndeploy(eventPlayer: Player): void`

説明: プレイヤーが死亡してデプロイ画面に戻ったときにトリガーされます。

eventPlayer - 対象プレイヤー

`OnPlayerDied(eventPlayer: Player, eventOtherPlayer: Player, eventDeathType: DeathType, eventWeaponUnlock: WeaponUnlock): void`

説明: プレイヤーが死亡したときにトリガーされます。

eventPlayer - 死亡したプレイヤー
eventOtherPlayer - キルしたプレイヤー
eventDeathType - 死亡の種類
eventWeaponUnlock - 使用された武器

`OnPlayerEarnedKill(eventPlayer: Player, eventOtherPlayer: Player, eventDeathType: DeathType, eventWeaponUnlock: WeaponUnlock): void`

説明: プレイヤーが他のプレイヤーをキルしたときにトリガーされます。

eventPlayer - キルしたプレイヤー
eventOtherPlayer - キルされたプレイヤー
eventDeathType - 死亡の種類
eventWeaponUnlock - 使用された武器

`OnPlayerEarnedKillAssist(eventPlayer: Player, eventOtherPlayer: Player): void`

説明: プレイヤーがキルアシストを獲得したときにトリガーされます。

eventPlayer - アシストしたプレイヤー
eventOtherPlayer - キルされたプレイヤー

`OnPlayerDamaged(eventPlayer: Player, eventOtherPlayer: Player, eventDamageType: DamageType, eventWeaponUnlock: WeaponUnlock): void`

説明: プレイヤーがダメージを受けたときにトリガーされます。

eventPlayer - ダメージを受けたプレイヤー
eventOtherPlayer - ダメージを与えたプレイヤー
eventDamageType - ダメージの種類
eventWeaponUnlock - 使用された武器

`OnPlayerInteract(eventPlayer: Player, eventInteractPoint: InteractPoint): void`

説明: プレイヤーがインタラクトポイントと相互作用したときにトリガーされます。

eventPlayer - 相互作用したプレイヤー
eventInteractPoint - インタラクトポイント

`OnPlayerEnterAreaTrigger(eventPlayer: Player, eventAreaTrigger: AreaTrigger): void`

説明: プレイヤーがエリアトリガーに入ったときにトリガーされます。

eventPlayer - 入ったプレイヤー
eventAreaTrigger - エリアトリガー

`OnPlayerExitAreaTrigger(eventPlayer: Player, eventAreaTrigger: AreaTrigger): void`

説明: プレイヤーがエリアトリガーから出たときにトリガーされます。

eventPlayer - 出たプレイヤー
eventAreaTrigger - エリアトリガー

`OnPlayerEnterCapturePoint(eventPlayer: Player, eventCapturePoint: CapturePoint): void`

説明: プレイヤーが占領ポイントの範囲に入ったときにトリガーされます。

eventPlayer - 入ったプレイヤー
eventCapturePoint - 占領ポイント

`OnPlayerExitCapturePoint(eventPlayer: Player, eventCapturePoint: CapturePoint): void`

説明: プレイヤーが占領ポイントの範囲から出たときにトリガーされます。

eventPlayer - 出たプレイヤー
eventCapturePoint - 占領ポイント

`OnPlayerEnterVehicle(eventPlayer: Player, eventVehicle: Vehicle): void`

説明: プレイヤーが車両の座席に乗り込んだときにトリガーされます。

eventPlayer - 乗り込んだプレイヤー
eventVehicle - 車両

`OnPlayerEnterVehicleSeat(eventPlayer: Player, eventVehicle: Vehicle, eventSeat: Object): void`

説明: プレイヤーが車両の特定座席に乗り込んだときにトリガーされます。

eventPlayer - 乗り込んだプレイヤー
eventVehicle - 車両
eventSeat - 座席

`OnPlayerExitVehicle(eventPlayer: Player, eventVehicle: Vehicle): void`

説明: プレイヤーが車両から降りたときにトリガーされます。

eventPlayer - 降りたプレイヤー
eventVehicle - 車両

`OnPlayerExitVehicleSeat(eventPlayer: Player, eventVehicle: Vehicle, eventSeat: Object): void`

説明: プレイヤーが車両の座席から降りたときにトリガーされます。

eventPlayer - 降りたプレイヤー
eventVehicle - 車両
eventSeat - 座席

`OnPlayerSwitchTeam(eventPlayer: Player, eventTeam: Team): void`

説明: プレイヤーがチームを変更したときにトリガーされます。

eventPlayer - チームを変更したプレイヤー
eventTeam - 新しいチーム

`OnPlayerUIButtonEvent(eventPlayer: Player, eventUIWidget: UIWidget, eventUIButtonEvent: UIButtonEvent): void`

説明: プレイヤーがUIボタンと相互作用したときにトリガーされます。

eventPlayer - 相互作用したプレイヤー
eventUIWidget - UIウィジェット
eventUIButtonEvent - ボタンイベント

`OnRevived(eventPlayer: Player, eventOtherPlayer: Player): void`

説明: プレイヤーが他のプレイヤーに蘇生されたときにトリガーされます。

eventPlayer - 蘇生されたプレイヤー
eventOtherPlayer - 蘇生したプレイヤー

`OnCapturePointCaptured(eventCapturePoint: CapturePoint, eventTeam: Team): void`

説明: 占領ポイントが占領されたときにトリガーされます。

eventCapturePoint - 占領されたポイント
eventTeam - 占領したチーム

`OnVehicleSpawned(eventVehicle: Vehicle): void`

説明: 車両がマップに召喚されたときにトリガーされます。

eventVehicle - スポーンした車両

`OnVehicleDestroyed(eventVehicle: Vehicle): void`

説明: 車両が破壊されたときにトリガーされます。

eventVehicle - 破壊された車両

`OnSpawnerSpawned(eventPlayer: Player, eventSpawner: Spawner): void`

説明: AIスポーナーがAI兵士をスポーンしたときにトリガーされます。

eventPlayer - スポーンしたAI
eventSpawner - スポーナー

`OnRayCastHit(eventPlayer: Player, eventPoint: Vector, eventNormal: Vector): void`

説明: レイキャストが標的に当たったときにトリガーされます。

eventPlayer - プレイヤー
eventPoint - 衝突点
eventNormal - 法線ベクトル

`OnRayCastMissed(eventPlayer: Player): void`

説明: レイキャストが呼び出されたが標的に当たらなかったときにトリガーされます。

eventPlayer - プレイヤー

`OnTimeLimitReached(): void`

説明: ゲームモードの制限時間に達したときにトリガーされます。

その他の関数

`Wait(seconds: number): void`

説明: 指定秒数待機します。

`SetVariable(variable: Variable, value: any): void`

説明: 変数に値を設定します。

`GetVariable(variable: Variable): any`

説明: 変数の値を取得します。

`ShowMessage(player: Player, message: string): void`

説明: プレイヤーにメッセージを表示します。

`ShowMessageAll(message: string): void`

説明: 全プレイヤーにメッセージを表示します。

`Log(message: string): void`

説明: コンソールにログを出力します。

使用例

// プレイヤーがゲームに参加したときに歓迎メッセージを表示
export function OnPlayerJoinGame(eventPlayer: mod.Player): void {
    mod.ShowMessage(eventPlayer, "ゲームへようこそ!");
}

// プレイヤーがキルを獲得したときに回復
export function OnPlayerEarnedKill(
    eventPlayer: mod.Player,
    eventOtherPlayer: mod.Player,
    eventDeathType: mod.DeathType,
    eventWeaponUnlock: mod.WeaponUnlock
): void {
    mod.Heal(eventPlayer, 50);
}

// エリアトリガーに入ったプレイヤーをテレポート
export function OnPlayerEnterAreaTrigger(
    eventPlayer: mod.Player,
    eventAreaTrigger: mod.AreaTrigger
): void {
    const destination = mod.Vector(100, 0, 100);
    mod.Teleport(eventPlayer, destination);
}

注意事項:

この日本語ドキュメントは参照用です
実際の関数定義はindex.d.tsを確認してください
SDKのアップデート時は最新のindex.d.tsを参照してください

C4N4242/BF6_Portal_SDK_API_Reference_JP.md

Portal SDK API リファレンス (日本語)

目次

列挙型 (Enums)

RuntimeSpawn (ランタイムスポーン)

対応マップ:

関数リファレンス

AI関連

AIBattlefieldBehavior(player: Player): void

AIDefendPositionBehavior(player: Player, position: Vector, range: number): void

AIMoveToBehavior(player: Player, destination: Vector): void

AITargetPlayerBehavior(player: Player, target: Player): void

SetAIBehavior(player: Player, behavior: AIBehavior): void

プレイヤー関連

DealDamage(player: Player, amount: number): void

Heal(player: Player, amount: number): void

Kill(player: Player, killer: Player): void

Teleport(player: Player, position: Vector): void

SetPlayerHealth(player: Player, health: number): void

SetPlayerMaxHealth(player: Player, maxHealth: number): void

GivePlayerGadget(player: Player, gadget: GadgetUnlock): void

GivePlayerWeapon(player: Player, weapon: WeaponUnlock): void

RemovePlayerGadget(player: Player, gadgetSlot: GadgetSlot): void

RemovePlayerWeapon(player: Player): void

SetPlayerMovementScale(player: Player, scale: number): void

SetPlayerScale(player: Player, scale: number): void

SpotTarget(spotter: Player, target: Player, duration: number): void

UI関連

AddUIButton(player: Player, text: string, position: Vector2, size: Vector2): UIWidget

AddUIContainer(player: Player, position: Vector2, size: Vector2): UIWidget

AddUIImage(player: Player, imagePath: string, position: Vector2, size: Vector2): UIWidget

AddUIText(player: Player, text: string, position: Vector2, fontSize: number): UIWidget

RemoveUIWidget(player: Player, widget: UIWidget): void

SetUIWidgetVisible(widget: UIWidget, visible: boolean): void

UpdateUIText(widget: UIWidget, text: string): void

車両関連

ForceVehicleSpawnerSpawn(spawner: VehicleSpawner): void

GetVehicleDriver(vehicle: Vehicle): Player

GetVehicleHealth(vehicle: Vehicle): number

SetVehicleHealth(vehicle: Vehicle, health: number): void

SetVehicleMaxHealthMultiplier(vehicle: Vehicle, multiplier: number): void

DestroyVehicle(vehicle: Vehicle): void

EjectAllPlayersFromVehicle(vehicle: Vehicle): void

EjectPlayerFromVehicle(player: Player): void