プラグインサンプル†
Bakinのプラグインのサンプルコードを掲載しています。
サンプルコードは今後も追加していきます。
・各サンプルコードは本ツールのSteam Workshopより取得してください。
・プラグインの改変にはVisual Studioのインストールが必要です。
・プラグインについてのページを一度ご確認ください。
・「C#プログラムの呼び出し」パネルについては制御をご覧ください。
このパネルでは現在複数の引数を設定することはできないことにご注意ください。
ゲームにSteamの「実績」を導入する†
- 説明
・Steamライブラリをリンクすることで、自作ゲームにSteamの「実績」を導入できるプラグインです。
・具体的にどのような実績を設定するか、それぞれの実績をどのような条件で解除するかはSteam側での設定が必要です。
方法についてはSteamのリファレンスでご確認ください。
・ゲーム内で「実績」を与える条件は、イベントを使ってコントロールしてください。
- 使い方
1.Steam Workshopで.csrbrファイルをサブスクライブし、インポートします。
この流れについてはSteam Workshopをご覧ください。
2. Bakinにて実績解除のきっかけとしたいイベントを配置し、そのイベントのイベントシート左下の「C#プログラムの割り当て」欄をクリック。
3．「追加」ボタンを押してAchievement_Sample_SmileBoom_2023.csrbrを選択。リストにAchievement.csが追加されます。
4. リスト上のAchievement.csを選択して、「編集」を押します。Visual Studioもしくは.csと関連付けられているエディタが起動します。
5. 「Sample_AppID」と書かれた箇所をご自身のゲームの「AppID」に書き換え、かつ"TEST" と書かれた部分を、ご自身のゲームの「実績ID」に書き換えます。
6. 編集後保存してから、OKを押して「C#プログラムの割り当て」欄を閉じます。
7. Windowsのエクスプローラーでご自身のプロジェクトフォルダに生成された「Scriptフォルダ」以下にあるsteam_appid.txtを開きます。
8. steam_appid.txt内の「Sample_AppID」と書かれた箇所をご自身のゲームの「AppID」に書き換えて、ファイルを保存します。
9. Bakinにて先ほどAchievement.csを割り当てたイベント内に「C#プログラムの呼び出し」パネルを設置し、Addメソッドを選択。
このプラグインを割り当てて実績解除をするイベントはゲーム内に複数置くことができます。
メッセージウィンドウを一時的に非表示にする†
- 説明
会話などのウィンドウの表示/非表示を変更できます。
いわゆる「閲覧モード」のようなシーンの制作にも使えます。
並列実行するイベントに置いて利用することを想定しています。
ウィンドウを消した後、時間経過やボタン入力などで復帰するように設定するといいでしょう。
- 使い方
1.Steam Workshopで.csrbrファイルをサブスクライブし、インポートします。
この流れについてはSteam Workshopをご覧ください。
2.この機能を使用したいイベントのイベントシート左下の「C#プログラムの割り当て」欄をクリック。
3．「追加」ボタンを押してHideMessage_Sample_SmileBoom_2023を選択。HideMessage.csがリストに追加されたらOKを押して「C#プログラムの割り当て」欄を閉じます。
4. イベント内に「C#プログラムの呼び出し」パネルを設置し、HideもしくはShowメソッドを指定します。
アイテムの攻撃力を取得†
- 説明
指定のアイテムの攻撃力を指定の変数に格納できるプラグインです。
- 使い方
1.Steam Workshopで.csrbrファイルをサブスクライブし、インポートします。
この流れについてはSteam Workshopをご覧ください。
2.この機能を使用したいイベントのイベントシート左下の「C#プログラムの割り当て」欄をクリック。
3．「追加」ボタンを押してCodeSamples_SmileBoom_2023.csrbrを選択。
4. リストに追加されたCodeSamples.csを選択し、「編集」ボタンを押します。Visual Studioもしくは.csと関連付けられているエディタが起動します。
5.上記サンプルコードに書かれている部分を下記のように編集します。
“Item Name” の部分に取得したいアイテムの名前を記述してください。
“アイテム名”の後にある「Attack」の部分を書き換えることで取得する値を変えることができます。
指定できるプロパティについては下記の記事を参照してください。 (たとえば、Price にすると価格が取得できます)
プラグインリファレンス
6. 編集後保存してから、OKを押して「C#プログラムの割り当て」欄を閉じます。
7. イベント内に「C#プログラムの呼び出し」パネルを設置し、メソッドを指定。値を格納する変数を指定します。
変更していなければ"GetAttackPower"がメソッド名となります。
キャストの初期HPを取得†
- 説明
指定のキャストの初期HPを指定の変数に格納できるプラグインです。
- 使い方
1.Steam Workshopで.csrbrファイルをサブスクライブし、インポートします。
この流れについてはSteam Workshopをご覧ください。
2.この機能を使用したいイベントのイベントシート左下の「C#プログラムの割り当て」欄をクリック。
3．「追加」ボタンを押してCodeSamples_SmileBoom_2023.csrbrを選択。
4. リストに追加されたCodeSamples.csを選択し、「編集」ボタンを押します。Visual Studioもしくは.csと関連付けられているエディタが起動します。
5.上記サンプルコードに書かれている部分を下記のように編集します。
“Cast Name” の部分に情報を取得したいキャストの名前を記述してください。
HP の部分を書き換えることによって取得する値を変えることができます。
指定できるプロパティについては下記の記事を参照してください。
プラグインリファレンス
6. 編集後保存してから、OKを押して「C#プログラムの割り当て」欄を閉じます。
7. イベント内に「C#プログラムの呼び出し」パネルを設置し、メソッドを指定。値を格納する変数を指定します。
変更していなければ"GetInitialHP"がメソッド名となります。
パーティの先頭からN番目のメンバーの現在HPを取得†
下記にある.csrbr内のCodeSample.csにコードがあります。
https://steamcommunity.com/sharedfiles/filedetails/?id=3038039863
- 説明
パーティ内の指定のメンバーの現在のHPを指定の変数に格納できるプラグインです。
- 使い方
1.Steam Workshopで.csrbrファイルをサブスクライブし、インポートします。
この流れについてはSteam Workshopをご覧ください。
2.この機能を使用したいイベントのイベントシート左下の「C#プログラムの割り当て」欄をクリック。
3.「追加」ボタンを押してCodeSamples_SmileBoom_2023.csrbrを選択。CodeSamples.csがリストに追加されたらOKを押して「C#プログラムの割り当て」欄を閉じます。
4.イベント内に「C#プログラムの呼び出し」パネルを設置し、メソッドを指定。値を格納する変数を指定します。
変更していなければ"GetPartyHP"がメソッド名となります。
- プラグインを編集し、hitpoint の部分を書き換えることによって取得する値を変えることができます。
- 「C#プログラムの割り当て」欄にてCodeSample.csを選択し、「編集」ボタンを押すとVisual Studioが起動しコードを編集することができます。
- 指定できるプロパティについては下記の記事を参照してください。
プラグインリファレンス
クォータニオンを使ってイベントを回転させる†
- 使い方
1.Steam Workshopで.csrbrファイルをサブスクライブし、インポートします。
この流れについてはSteam Workshopをご覧ください。
2.この機能を使用したいイベントのイベントシート左下の「C#プログラムの割り当て」欄をクリック。
3.「追加」ボタンを押してCodeSamples_SmileBoom_2023.csrbrを選択。CodeSamples.csがリストに追加されたらOKを押して「C#プログラムの割り当て」欄を閉じます。
4.イベント内に「C#プログラムの呼び出し」パネルを設置し、メソッドを指定。回転角を指定します。
変更していなければ"RotateEvent"がメソッド名となります。
プレイヤーが障害物に隠れた部分の色を変更†
- 説明
プレイヤーが手前の物体の裏に入った際、隠れている箇所を表示する色を変更します。
ゲーム定義のルールと操作にて指定した色を変更できるプラグインです。
- 使い方
1.Steam Workshopで.csrbrファイルをサブスクライブし、インポートします。
この流れについてはSteam Workshopをご覧ください。
2.この機能を使用したいイベントのイベントシート左下の「C#プログラムの割り当て」欄をクリック。
3.「追加」ボタンを押してCodeSamples_SmileBoom_2023.csrbrを選択。
4.リストに追加されたCodeSamples.csを選択し、「編集」ボタンを押します。Visual Studioもしくは.csと関連付けられているエディタが起動します。
5.サンプルコードに書かれている部分を下記のように編集します。
引数(0, 0, 1, 1 の部分)にR,G,B,Aの順でそれぞれ0～1の値のカラーコードを記入します。
サンプルコードのままの値だと、隠れた部分の色は「青」になります。
（この場合カラーコードがOpenGL用のものとなるため、0～1になっていることに注意してください。）
6. 編集後保存してから、OKを押して「C#プログラムの割り当て」欄を閉じます。
7. イベント内に「C#プログラムの呼び出し」パネルを設置し、メソッドを指定します。
変更していなければ"ChangeHiddenStencilColor"がメソッド名となります。
画面上に線分を描画†
- 説明
画面上の指定の位置に指定の色の線分を表示するプラグインです。
レーダーのような機能を作るのに使えると考えています。
ずっと線分を表示しつづけるためには、毎フレームこのプラグインが呼び出されるようにイベントを設定してください。
- 使い方
1.Steam Workshopで.csrbrファイルをサブスクライブし、インポートします。
この流れについてはSteam Workshopをご覧ください。
2.この機能を使用したいイベントのイベントシート左下の「C#プログラムの割り当て」欄をクリック。
3.「追加」ボタンを押してCodeSamples_SmileBoom_2023.csrbrを選択。
4.リストに追加されたCodeSamples.csを選択し、「編集」ボタンを押します。Visual Studioもしくは.csと関連付けられているエディタが起動します。
5.上記サンプルコードに書かれている部分を下記のように編集します。
線の開始位置、終了位置、色を引数で指定します。
引数（カッコの中の数値）は、それぞれ(x1, y1, x2, y2, 色R, 色G, 色B, 色A) を表します。RGBAのカラーコードは「0～255」の範囲で指定してください。
6. 編集後保存してから、OKを押して「C#プログラムの割り当て」欄を閉じます。
7. イベント内に「C#プログラムの呼び出し」パネルを設置し、メソッドを指定します。
変更していなければ"DrawLine"がメソッド名となります。
![[PukiWiki]](./skin/BAKIN_logo_92.png "[PukiWiki]"){kind=logo}
