#author("2023-09-20T00:46:42+00:00","default:admin","admin")
#author("2023-09-20T03:30:17+00:00","default:admin","admin")
*Plug-in Samples [#sf65b270]

Sample codes for Bakin's plug-ins are available.
Sample codes will be added in the future.
Plug-in samples for Bakin's plug-ins are available.
Plug-in samples will be added in the future.

-Please obtain each sample code from [[Steam Workshop:https://steamcommunity.com/app/1036640/workshop/]] of this tool.
-Please obtain each plug-in sample from [[Steam Workshop:https://steamcommunity.com/app/1036640/workshop/]] of this tool.
-Modification of plug-ins requires Visual Studio to be installed. 
-Please check the [[What are Plug-ins?]] page once. 

-See [[Control]] for the "Call C# Program" panel.  Please note that this panel does not currently allow multiple parameters to be set.

#Contents
----
**Introduce Steam "Achievements" into the Game [#ib5b4cdd]
-''Sample Code''
-''Plug-in Sample''
https://steamcommunity.com/sharedfiles/filedetails/?id=3038041387

-''Description''
--This plug-in allows you to introduce Steam "Achievements" to your own games by linking the Steam library.
--The specific type of achievements to be set and the conditions under which each achievement will be unlocked must be set on the Steam side.  See the Steam reference for instructions on how to do this.
--The conditions under which "Achievements" are given in the game should be controlled through the use of events.

-''How to Use''
+Subscribe the .csrbr file in the Steam Workshop and import it. See [[Steam Workshop]] for more information on this process.
+In Bakin, place an event that you want to trigger the unlocking of an achievement, and click on the "C# Program Assignment" field in the lower left corner of the event sheet for that event.
+Click the "Add" button and select Achievement_Sample_SmileBoom_2023.csrbr. Achievement.cs will be added to the list.
+Select Achievement.cs and click "Edit". The editor associated with Visual Studio or .cs will launch.
+Replace "AppID" with your game's "AppID" and "TEST" with your game's "Achievement ID".
+Save after editing and click OK to close the "C# Program Assignment" field.
+Open steam_appid.txt in Windows Explorer under the "Script folder" generated in your project folder.
+Replace the "AppID" in steam_appid.txt with the "AppID" of your game and save the file.
+In Bakin, place the "Call C# Program" panel in the event to which you have just assigned Achievement.cs and select the Add method.

Multiple events can be placed in the game to assign this plug-in to unlock achievements.

----
**Temporarily Hide the Message Window [#k176eae6]
-''Sample Code''
-''Plug-in Sample''
https://steamcommunity.com/sharedfiles/filedetails/?id=3038040372

-''Description''
You can change the display/hide of conversations and other windows.
It can also be used to create scenes in what is called "viewing mode".
It is intended to be used by placing it on an event to be executed in parallel.
After the window is turned off, it is recommended that it be set to restore after a period of time or button input.

-''How to Use''
+Subscribe the .csrbr file in the Steam Workshop and import it.
See [[Steam Workshop]] for more information on this process.
+Click on the "C# Program Assignment" field in the lower left corner of the event sheet for the event for which you want to use this function.
+Click the "Add" button and select HideMessage_Sample_SmileBoom_2023. When HideMessage.cs is added to the list, click OK to close the "C# Program Assignment" field.
+Place a "Call C# Program" panel in the event and specify the Hide or Show method.

----
**Get the Item's Attack Power [#k424ea57]
-''Sample Code''
-''Plug-in Sample''
You can find the code in CodeSample.cs in the .csrbr below.
https://steamcommunity.com/sharedfiles/filedetails/?id=3038039863

-''Description''
This plug-in allows you to store the attack power of a specified item in a specified variable.

-''How to Use''
+Subscribe the .csrbr file in the Steam Workshop and import it.
See [[Steam Workshop]] for more information on this process.
+Click on the "C# Program Assignment" field in the lower left corner of the event sheet for the event for which you want to use this function.
+Click the "Add" button and select CodeSamples_SmileBoom_2023.csrbr.
+Select CodeSamples.cs added to the list and click the "Edit" button. The editor associated with Visual Studio or .cs will launch.
+Edit the part written in the above sample code as follows.
+Edit the part written in the above plug-in sample as follows.
Enter the name of the item to be obtained in the "Item Name" part. 
#br
The value to be obtained can be changed by rewriting the "Attack" part after "Item_Name".
See the following article for a list of properties that can be specified. 
(For example, Price to obtain the price.) 
[[Plug-in Reference:https://rpgbakin.com/csreference/doc/ja/class_yukar_1_1_common_1_1_rom_1_1_n_item.html]]
+Save after editing and click OK to close the "C# Program Assignment" field.
+Place a "Call C# Program" panel in the event and specify the method. Specify a variable to store the value.
If not changed, "GetAttackPower" will be the method name.

----
**Get the Cast's Initial HP [#q7eda3a5]
-''Sample Code''
-''Plug-in Sample''
You can find the code in CodeSample.cs in the .csrbr below.
https://steamcommunity.com/sharedfiles/filedetails/?id=3038039863

-''Description''
This plug-in allows the initial HP of a specified cast to be stored in a specified variable.

-''How to Use''
+Subscribe the .csrbr file in the Steam Workshop and import it.
See [[Steam Workshop]] for more information on this process.
+Click on the "C# Program Assignment" field in the lower left corner of the event sheet for the event for which you want to use this function.
+Click the "Add" button and select CodeSamples_SmileBoom_2023.csrbr.
+Select CodeSamples.cs added to the list and click the "Edit" button. The editor associated with Visual Studio or .cs will launch.
+Edit the part written in the above sample code as follows.
+Edit the part written in the above plug-in sample as follows.
Enter the name of the cast to be obtained in the "Cast Name" part. 
#br
The value to be obtained can be changed by rewriting the HP part.
See the following article for a list of properties that can be specified.  
[[Plug-in Reference:https://rpgbakin.com/csreference/doc/ja/class_yukar_1_1_common_1_1_rom_1_1_cast.html]]
+Save after editing and click OK to close the "C# Program Assignment" field.
+Place a "Call C# Program" panel in the event and specify the method. Specify a variable to store the value.
If not changed, "GetInitialHP" will be the method name.

----
**Get the Current HP of the nth Member from the First in the Party [#p18de7c9]
You can find the code in CodeSample.cs in the .csrbr below.
https://steamcommunity.com/sharedfiles/filedetails/?id=3038039863

-''Description''
This plug-in can store the current HP of a specified member in the party in a specified variable.

-''How to Use''
+Subscribe the .csrbr file in the Steam Workshop and import it.
See [[Steam Workshop]] for more information on this process.
+Click on the "C# Program Assignment" field in the lower left corner of the event sheet for the event for which you want to use this function.
+Click the "Add" button and select CodeSamples_SmileBoom_2023.csrbr. When CodeSamples.cs is added to the list, click OK to close the "C# Program Assignment" field.
+Place a "Call C# Program" panel in the event and specify the method. Specify a variable to store the value.
If not changed, "GetPartyHP" will be the method name.

--The value to be obtained can be changed by editing the plug-in and rewriting the hitpoint part.
---Select CodeSample.cs in the "C# Program Assignment" field and click the "Edit" button to launch Visual Studio and edit the code.
---See the following article for a list of properties that can be specified. 
[[Plug-in Reference:https://rpgbakin.com/csreference/doc/ja/class_yukar_1_1_common_1_1_rom_1_1_hero.html]]


----
**Rotate an Event with Quaternion [#nd55675c]
-''Sample Code''(The line after the // is a comment line. It will be ignored at runtime.)
-''Plug-in Sample''(The line after the // is a comment line. It will be ignored at runtime.)
You can find the code in CodeSample.cs in the .csrbr below.
https://steamcommunity.com/sharedfiles/filedetails/?id=3038039863

-''Description''
This plug-in rotates an event by specifying the angle of Y rotation in terms of quaternion instead of Euler angle.

Rotation amount quat can also be generated by CreateFromYawPitchRoll and other methods. See below for details. 
https://docs.monogame.net/api/Microsoft.Xna.Framework.Quaternion.html 

-''How to Use''
+Subscribe the .csrbr file in the Steam Workshop and import it.
See [[Steam Workshop]] for more information on this process.
+Click on the "C# Program Assignment" field in the lower left corner of the event sheet for the event for which you want to use this function.
+Click the "Add" button and select CodeSamples_SmileBoom_2023.csrbr. When CodeSamples.cs is added to the list, click OK to close the "C# Program Assignment" field.
+Place a "Call C# Program" panel in the event and specify the method. Specify the rotation angle.
If not changed, "RotateEvent" will be the method name.
----
**Change the Color of the Area Where the Player is Hidden by Obstacles [#q6276196]

-''Sample Code''
-''Plug-in Sample''
You can find the code in CodeSample.cs in the .csrbr below.
https://steamcommunity.com/sharedfiles/filedetails/?id=3038039863

-''Description''
When the player goes behind objects in the front, change the color to show the hidden area.
This plug-in enables to change the color specified in [[Rules and Operations]].

-''How to Use''
+Subscribe the .csrbr file in the Steam Workshop and import it.
See [[Steam Workshop]] for more information on this process.
+Click on the "C# Program Assignment" field in the lower left corner of the event sheet for the event for which you want to use this function.
+Click the "Add" button and select CodeSamples_SmileBoom_2023.csrbr.
+Select CodeSamples.cs added to the list and click the "Edit" button. The editor associated with Visual Studio or .cs will launch.
+Edit the part written in the sample code as follows:
+Edit the part written in the plug-in sample as follows:
#br
Enter the color codes for the parameters (0, 0, 1, 1 part) in the order of R, G, B, and A, each with a value between 0 and 1.
With the values as in the sample code, the color of the hidden area is "blue".
With the values as in the plug-in sample, the color of the hidden area is "blue".
(Note that in this case the color code is for OpenGL, so it is 0 to 1.)
#br
+Save after editing and click OK to close the "C# Program Assignment" field.
+Place a "Call C# Program" panel in the event and specify the method.
If not changed, "ChangeHiddenStencilColor" will be the method name.

----
**Draw a Line on the Screen [#g53ef2f1]

-''Sample Code''
-''Plug-in Sample''
You can find the code in CodeSample.cs in the .csrbr below.
https://steamcommunity.com/sharedfiles/filedetails/?id=3038039863

-''Description''
This plug-in displays a line segment of a specified color at a specified position on the screen.
We believe it can be used to create a radar-like feature.
To keep the line segment visible, set up an event so that this plug-in is called every frame.

-''How to Use''
+Subscribe the .csrbr file in the Steam Workshop and import it.
See [[Steam Workshop]] for more information on this process.
+Click on the "C# Program Assignment" field in the lower left corner of the event sheet for the event for which you want to use this function.
+Click the "Add" button and select CodeSamples_SmileBoom_2023.csrbr.
+Select CodeSamples.cs added to the list and click the "Edit" button. The editor associated with Visual Studio or .cs will launch.
+Edit the part written in the sample code as follows:
+Edit the part written in the plug-in sample as follows:
#br
The starting position, ending position, and color of the line are specified by parameters.
Parameters (values in parentheses) represent (x1, y1, x2, y2, colorR, colorG, colorB, colorA), respectively; the color code for RGBA must be in the range "0 to 255".
#br
+Save after editing and click OK to close the "C# Program Assignment" field.
+Place a "Call C# Program" panel in the event and specify the method. Specify a variable to store the value.
If not changed, "DrawLine" will be the method name.

Front page   Edit Diff History Attach Copy Rename Reload   New Page list Search Recent changes   Help   RSS of recent changes