マニュアル：Method/Signal/API一覧

アクションゲームメーカー チュートリアル
,
1

GDScript で Action Game Maker のクラスにアクセスするために使用される API のリストです。

ObjectVariable/Switch および ProjectVariable/Switch API

オブジェクト変数 (VariableSettings ノード) にアクセスする

変数データの取得: $VariableSettings.get_value("VariableDataName")
変数データのセット: $VaribleSettings.set_value("VariableName", Value)
変数データの存在確認: $VariableSettings.has_value("VariableDataName")
VariableSettings ノードの取得: $GameObject.get_variable_settings()

オブジェクトスイッチ (SwitchSettings ノード) にアクセスする

スイッチデータの取得: $SwitchSettings.get_value("SwitchDataName")
スイッチデータのセット: $SwitchSettings.set_value("SwitchName", True / False)
スイッチデータの存在確認: $SwitchSettings.has_value("SwitchDataName")
SwitchSettings ノードの取得: $GameObject.get_switch_settings()

読み取り専用のオブジェクト変数/スイッチ

以下の ACTION GAME MAKER の変数/スイッチは読み取り専用値であり、メソッド経由で変更することはできません。

スイッチ:
is_locked, is_touching_portal
変数:
object_id, stayed_area_id, visible_direction, x_speed, y_speed, player_id, controller_id, taken_damage

プロジェクト変数へのアクセス

プロジェクト変数の取得: AGMakerManager.get_project_database_variable("record_name")
レコードインデックスによるプロジェクト変数の取得: get_project_database_variable_by_idx
プロジェクトデータベース変数のセット: AGMakerManager.update_project_database_variable("VariableName", variable)
レコードインデックスによるプロジェクト変数のセット: AGMakerManager.update_project_database_variable_by_idx
プロジェクト変数のレコード数の取得: AGMakerManager.get_project_database_variable_record_max

プロジェクトスイッチへのアクセス

プロジェクトスイッチの取得: AGMakerManager.get_project_database_switch("record_name")
プロジェクトデータベーススイッチのセット: AGMakerManager.update_project_database_switch("SwitchName", True / False)
レコードインデックスによるプロジェクトスイッチの取得: AGMakerManager.get_project_database_switch_by_idx
レコードインデックスによるプロジェクトスイッチのセット: AGMakerManager.update_project_database_switch_by_idx
プロジェクトスイッチのレコード数の取得: AGMakerManager.get_project_database_switch_record_max

データベース API

ユーザーデータベースへのアクセス

ユーザーデータベースの取得: AGMakerManager.get_project_database_plain("database_name", "record_name", "column_name")
レコードインデックスによるユーザーデータベースの取得: get_project_database_plain_by_idx
ユーザーデータベース変数のセット: AGMakerManager.update_project_database_plain("DatabaseName", "RecordName", "CplumnName", variable)
レコードインデックスによるユーザーデータベース変数のセット: AGMakerManager.update_project_database_plain_by_idx
ユーザーデータベースのレコード数の取得: AGMakerManager.get_project_database_plain_record_max

その他のデータベースへのアクセス

サウンドデータベースの取得: AGMakerManager.get_project_database_sound("record_name", "column_name")

:small_blue_diamond: レコードインデックスによるデータの取得メソッド

装備タイプ: AGMakerManager.get_project_database_equipment_type_by_idx
属性タイプ: AGMakerManager.get_project_database_attribute_type_by_idx
ユーザー定義タイプ: AGMakerManager.get_project_database_custom_type_by_idx
オーディオデータベース: AGMakerManager.get_project_database_sound_by_idx

:small_blue_diamond: レコード数の取得メソッド

装備タイプ: AGMakerManager.get_project_database_equipment_type_record_max
属性タイプ: AGMakerManager.get_project_database_attribute_type_record_max
ユーザー定義タイプ: AGMakerManager.get_project_database_custom_type_record_max
オーディオデータベース: AGMakerManager.get_project_database_sound_record_max

カメラ API

:small_blue_diamond: CameraTargetSettings の生成

var camera_target_settings = CameraTargetSettings.new()
camera_target_settings.\_target_id = "Any ID"
camera_target_settings.\_is_active_target = true
camera_target_settings.\_visible_size = Vector2(100, 100)
add_child(camera_target_settings)
camera_target_settings.position = Vector2( 100, 100)

:small_blue_diamond: ZoomCamera2D への CameraTargetSettings の登録

$ZoomCamera2D.regist_target(camera_target_settings.get_instance_id())

:small_blue_diamond: ZoomCamera2D からの CameraTargetSettings の解除

$ZoomCamera2D.unregist_target(camera_target_settings.get_instance_id())

FaceDirectionSettings API

  • set_face_direction(angle, flip_flag): 第1引数: 向いている方向の角度、第2引数: 反転するかどうか
  • get_face_direction(): 現在の向いている方向の角度を返します

その他の AGMakerManager メソッド

:small_blue_diamond: GDScript で生成されたゲームオブジェクトを AGMakerManager に登録する

AGMakerManager.regist_game_object("TargetNode")

  • AGMakerManager は ACTION GAME MAKER のさまざまな側面を管理するシステムです。ゲームオブジェクトのライフサイクルを追跡する責任も負っているため、AGMakerManager 外で作成されたオブジェクトは、手動で登録する必要があります。

:small_blue_diamond: シーンの遷移

get_current_game_scene()

  • 現在実行中の GameScene を返します。戻り値の型は GameScene です。

サンプルコード:

func _ready() -> void:
	var game_scene = AGMakerManager.get_current_game_scene()
	print("*** get current scene = ", game_scene.name)
	pass

シグナル

このセクションでは、ACTION GAME MAKER の各種操作中に発行されるシグナルを一覧表示します。

:small_blue_diamond: ゲームオブジェクト

保存/読み込みシグナル

保存実行時: on_saved(int slot, Object object)
読み込み実行時: on_loaded(int slot, Object object)

:small_blue_diamond: AGMakerManager

保存/読み込みシグナル

保存実行時: on_saved(int slot)
読み込み実行時: on_loaded(int slot)

シーン遷移関連シグナル

game_scene_about_to_change(current: Object)
このシグナルは、シーン遷移が実行される直前に発行されます。
パラメータ current には、遷移前の GameScene が渡されます。

game_scene_changed(current: Object)
このシグナルは、シーン遷移が完了した後に発行されます。
パラメータ current には、遷移後の GameScene が渡されます。

注意: パラメータの型は Godot の仕様により Object となっています。
使用する際は、ユーザー側で GameScene または Node2D にキャストしてください。

サンプルコード:

func _ready() -> void:
	# シーン遷移前に発行されるシグナルに接続する
	AGMakerManager.game_scene_about_to_change.connect(_on_before_change_scene)
	# シーン遷移後に発行されるシグナルに接続する
	AGMakerManager.game_scene_changed.connect(_on_after_change_scene)
	pass

func _on_before_change_scene(current_scene: GameScene):
	print("*** on before change scene = ", current_scene.name)
	pass

func _on_after_change_scene(current_scene: GameScene):
	print("*** on after change scene = ", current_scene.name)
	pass
「いいね！」 2
Tutorial/Manual: table of contents
ACTION GAME MAKER v1.0.13 Patch Notes
プロジェクトスイッチの切り替えについて
チュートリアル/マニュアル: 目次
マニュアル: カスタムアクションプラグイン
リンクにおける変数の条件分岐について