|
|
@@ -162,15 +162,15 @@ Organized and annotated Script canvas graph files that produce verifiable output
|
|
|
|
|
|
| Workflow | Requests | Things to Watch For |
|
|
|
|--------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|
|
-| Creating a user function and calling its input/output from another graph |<ol><li>Use Script Canvas editor to create a graph file with enter/exit nodelings. (An instance of such graph and buttons used to create nodelings can be seen in the picture below) [](https://github.com/o3de/sig-content/blob/main/testing-guidance/workflow-tests/scripting/images/SCeditor_basic_userFunction00.png) </li><li>Place complex logic or entity behavior between the enter/exit nodelings.</li><li>Give the graph file a unique recognizable name and save it.</li><li>Call the user function from another graph by finding it in the node palette or right click context menu [](https://github.com/o3de/sig-content/blob/main/testing-guidance/workflow-tests/scripting/images/SCeditor_basic_userFunction01.png)</li></ol> **Example Functions:** <ol><li>Two color parameters and returns a blended color.</li><li>Entity parameter and returns the number of child entities.</li><li>No parameters or output but triggers behavior. | <ul><li>Recursive functions are **NOT** supported at the moment</li><li>Modifications to the user function file should require scripts calling the function to also be modified.</li> |
|
|
|
+| Creating a user function and calling its input/output from another graph |<ol><li>Use Script Canvas editor to create a graph file with enter/exit nodelings. (An instance of such graph and buttons used to create nodelings can be seen in the picture below) [](https://github.com/o3de/sig-content/blob/main/testing-guidance/workflow-tests/scripting/images/SCeditor_basic_userFunction00.png) </li><li>Place complex logic or entity behavior between the enter/exit nodelings.</li><li>Give the graph file a unique recognizable name and save it.</li><li>Call the user function from another graph by finding it in the node palette or right click context menu. [](https://github.com/o3de/sig-content/blob/main/testing-guidance/workflow-tests/scripting/images/SCeditor_basic_userFunction01.png)</li></ol> **Example Functions:** <ol><li>Two color parameters and returns a blended color.</li><li>Entity parameter and returns the number of child entities.</li><li>No parameters or output but triggers behavior. | <ul><li>Recursive functions are **NOT** supported at the moment.</li><li>Modifications to the user function file should require scripts calling the function to also be modified.</li> |
|
|
|
| Generate and modify translation data | <ol><li> Select any node in Script Canvas Node Pallete and right click it.</li><li>Select a _Generate Translation_ option.</li><li>Open the generated _.names_ file and modify in with any text editor by for instance changing the node name. </li><li> Save the file and drag another instance of the corresponding node into the Script Canvas graph. <ol> | <ul><li>Generating translation data does not cause major performance dips, however please note that generating translation data takes about 3-5 seconds.</li><li>Non-english characters render properly in SC graph.</li><li>Translation data modifications are reflected in Script Canvas editor.</li></ul> |
|
|
|
-| Use groupings | <ol><li>Create groups of all available types grouping nodes of an existing graph.</li><li>Move the groups around in the Script Canvas editor.</li><li>Resize groups and grab more nodes into them.</li><li>Open Node Inspector and select one of the created groups.</li><li>Perform all available actions found in Node Inspector for selected group (Enabling as Bookmark, Collapsing Group, Changing all Font settings, etc...)</li><li>Double click the groups in graph to collapse/expand them.</li><li>Perform actions from group edit menu by right clicking on a group in Script Canvas graph window (Copy/Paste, Duplicate, Collapse, etc...)</li></ol> | <ul><li>If groupings are not rendering when placed on the graph.</li><li>If nodes are not "Sticking" to a grouping when size or position is changed.</li><li>Modifications to groups are maintained when graph is saved/loaded.</li><li>Groups can have their all corresponding menu and Node Inspector actions performed.</li><li>Different fonts can be assigned to groups with Font Settings. |
|
|
|
-| Use annotations | <ol><li>Create a comment on an existing graph.</li><li>Move the created comment around in the Script Canvas editor. </li><li>Input strings into comment input field.</li><li>Open Node Inspector and select the comment.</li><li>Perform all available actions found in Node Inspector for selected comment (Comment, Background Color, etc...) </li><li>Double click the comment in graph to enter its edit mode.</li><li>Perform actions from comment edit menu by right clicking on a comment in Script Canvas graph window (Cut, Copy/Paste, Duplicate, Delete, Edit comment, etc...)</li></ol> | <ul><li>Comments can be created on the graph and strings can be written in their input field</li><li>Comments size scales depending on the length of written string.</li><li>Different fonts can be assigned to comments with Font Settings</li><li>Comments can have their all corresponding menu and Node Inspector actions performed.
|
|
|
-| Use bookmarks | <ol><li>Create a bookmark on an existing graph.</li><li> Move the created bookmark around in the Script Canvas editor.</li><li>Open Node Inspector and select the comment.</li><li>Perform all available actions found in Node Inspector for selected bookmark( Bookmark Name and Color) </li><li>Open Bookmarks tool and perform available actions:<ul><li>Double click bookmark to enter its name edit mode</li><li>Right click bookmark and select Go to Bookmark action</li><li>Right click bookmark and select Delete Bookmark action</li><li>Double click Shortcut section and select a number shortcut for a bookmark</li></ul></li><li>Select a Script Canvas graph window and click a shortcut number associated with one of the bookmarks.</li><li>Perform actions from group edit menu by right clicking on a group in Script Canvas graph window (Cut, Copy/Paste, Duplicate, etc...) </li></ol> | <ul><li>Bookmarks can be created on the graph and are assigned with random color and a shortcut when available.</li><li> Bookmarks can have their color and name changed via Node Inspector.</li><li>Bookmarks can be edited with Bookmarks tool.</li><li>Clicking a number shortcut associated with one of the bookmarks finds and focuses the Script Canvas graph view on the selected bookmark.</li> |
|
|
|
+| Use groupings | <ol><li>Create groups of all available types grouping nodes of an existing graph.</li><li>Move the groups around in the Script Canvas editor.</li><li>Resize groups and grab more nodes into them.</li><li>Open Node Inspector and select one of the created groups.</li><li>Perform all available actions found in Node Inspector for selected group (Enabling as Bookmark, Collapsing Group, Changing all Font settings, etc...).</li><li>Double click the groups in graph to collapse/expand them.</li><li>Perform actions from group edit menu by right clicking on a group in Script Canvas graph window (Copy/Paste, Duplicate, Collapse, etc...).</li></ol> | <ul><li>If groupings are not rendering when placed on the graph.</li><li>If nodes are not "Sticking" to a grouping when size or position is changed.</li><li>Modifications to groups are maintained when graph is saved/loaded.</li><li>Groups can have their all corresponding menu and Node Inspector actions performed.</li><li>Different fonts can be assigned to groups with Font Settings. |
|
|
|
+| Use annotations | <ol><li>Create a comment on an existing graph.</li><li>Move the created comment around in the Script Canvas editor. </li><li>Input strings into comment input field.</li><li>Open Node Inspector and select the comment.</li><li>Perform all available actions found in Node Inspector for selected comment (Comment, Background Color, etc...). </li><li>Double click the comment in graph to enter its edit mode.</li><li>Perform actions from comment edit menu by right clicking on a comment in Script Canvas graph window (Cut, Copy/Paste, Duplicate, Delete, Edit comment, etc...).</li></ol> | <ul><li>Comments can be created on the graph and strings can be written in their input field.</li><li>Comments size scales depending on the length of written string.</li><li>Different fonts can be assigned to comments with Font Settings.</li><li>Comments can have their all corresponding menu and Node Inspector actions performed.
|
|
|
+| Use bookmarks | <ol><li>Create a bookmark on an existing graph.</li><li> Move the created bookmark around in the Script Canvas editor.</li><li>Open Node Inspector and select the comment.</li><li>Perform all available actions found in Node Inspector for selected bookmark( Bookmark Name and Color). </li><li>Open Bookmarks tool and perform available actions:<ul><li>Double click bookmark to enter its name edit mode</li><li>Right click bookmark and select Go to Bookmark action</li><li>Right click bookmark and select Delete Bookmark action</li><li>Double click Shortcut section and select a number shortcut for a bookmark</li></ul></li><li>Select a Script Canvas graph window and click a shortcut number associated with one of the bookmarks.</li><li>Perform actions from group edit menu by right clicking on a group in Script Canvas graph window (Cut, Copy/Paste, Duplicate, etc...). </li></ol> | <ul><li>Bookmarks can be created on the graph and are assigned with random color and a shortcut when available.</li><li> Bookmarks can have their color and name changed via Node Inspector.</li><li>Bookmarks can be edited with Bookmarks tool.</li><li>Clicking a number shortcut associated with one of the bookmarks finds and focuses the Script Canvas graph view on the selected bookmark.</li> |
|
|
|
| Create and use presets | <ol><li>Create a comment and a group.</li><li>Change their font settings and colors with Node Inspector.</li><li>Right click them in Script Canvas Graph pane and select "Create Preset From" option.</li><li>Save the selected comment and a group as separate presets.</li><li>Create a new comment and a group.</li><li>Right click them in Script Canvas Graph pane and select "apply preset".</li><li>Apply created presets and default presets to groups and comments.</li><li>Open the Presets Editor tool.</li><li>Switch between Node Group and Comment Construct Types.</li><li>Set various presets as default.</li><li>Remove various presets.</li><li>Click the Reset Button.</li></ol> | <ul><li>Presets can be made out of different comments and groups.</li><li>Presets can be applied to comments and groups and retain their assigned values, fonts and colors.</li><li>Presets can be viewed and removed in Presets Editor tool.</li><li>Using the Reset option in Editor Tool, resets presets to default, removing newly created presets and readding removed default presets.</li> |
|
|
|
-| Use the Debugging tool to generate script logs | <ol><li> Create a simple graph with On Graph Start -> Delay -> Print nodes.</li><li>Create an entity with Script Canvas component in the viewport and assign it with previously created graph<li>Open the Debbuger tool in Script Canvas Editor and select the created debug targets from dropdown.</li><li>Enable and disable Auto Capture and Live Updates options.</li><li>Run the Script Canvas Debugger with Capture button.</li><li>Run the Script Canvas Debugger by entering Game Mode in the main Editor window.</li><li>Examine captured data, expand and collapse lines with dedicated buttons.</li></ol> | <ul><li>Created entity appears in Entities tab of Debugging tool.</li><li>Existing script files are displayed in Graphs tab of Debugging tool.</li> |
|
|
|
-| Use Interpreter tool to execute script | <ol><li>Create a simple graph with On Graph Start -> Delay (5s) -> Print nodes.</li><li>Open the Interpreter tool in Script Canvas Editor and assign previously created script to it.<li>Click Start button to execute the script.</li><li>Click Stop button during script execution.</li></ol> | <ul><li> Interpreter tool can be assigned with scripts</li><li>Scripts can be executed with Interpreter tool</li><li>Execution of scripts by the Interpreter can be stopped.</li> |
|
|
|
-| Create a script to handle inputs | <ol><li>Create an Input Bindings file in Asset Editor tool and configure it as shown in the picture below. </li><li>Create a script with Input Handler node, set Event Name to match previously created input bindings file (Print). <li>Create an entity with Script Canvas and Input components, assign previously created Input Bindings file and script to corresponding components.</li><li>Enter Game Mode and press space key to print message in console.</li><li>Assign various keys in Input Bindings file.</li></ol> | <ul><li>Various inputs can be assigned to Input Handlers</li><li>Script Canvas receives and handles assigned inputs</li> |
|
|
|
-| Create a script for Audio playback | **Prerequisites:**</li><ul><li>Wwise project is setup.</li><li>Wwise Audio Engine Gem is enabled.</li></ul></ul> <ol><li>Create an entity with Script Canvas, Audio Trigger, and Audio Proxy components.</li><li>In Audio Trigger component assign Play trigger.<li>Create a script with Execute Trigger node that will execute after short delay and assign it to Script Canvas component. </li><li> Enter Game Mode.</li></ol> | <ul><li>Audio triggers can be triggered by Script Canvas</li><li>Audio output can be heard when triggers are playing</li> |
|
|
|
+| Use the Debugging tool to generate script logs | <ol><li> Create a simple graph with On Graph Start -> Delay -> Print nodes.</li><li>Create an entity with Script Canvas component in the viewport and assign it with previously created graph.<li>Open the Debbuger tool in Script Canvas Editor and select the created debug targets from dropdown.</li><li>Enable and disable Auto Capture and Live Updates options.</li><li>Run the Script Canvas Debugger with Capture button.</li><li>Run the Script Canvas Debugger by entering Game Mode in the main Editor window.</li><li>Examine captured data, expand and collapse lines with dedicated buttons.</li></ol> | <ul><li>Created entity appears in Entities tab of Debugging tool.</li><li>Existing script files are displayed in Graphs tab of Debugging tool.</li> |
|
|
|
+| Use Interpreter tool to execute script | <ol><li>Create a simple graph with On Graph Start -> Delay (5s) -> Print nodes.</li><li>Open the Interpreter tool in Script Canvas Editor and assign previously created script to it.<li>Click Start button to execute the script.</li><li>Click Stop button during script execution.</li></ol> | <ul><li> Interpreter tool can be assigned with scripts.</li><li>Scripts can be executed with Interpreter tool.</li><li>Execution of scripts by the Interpreter can be stopped.</li> |
|
|
|
+| Create a script to handle inputs | <ol><li>Create an Input Bindings file in Asset Editor tool and configure it as shown in the picture below. </li><li>Create a script with Input Handler node, set Event Name to match previously created input bindings file (Print). <li>Create an entity with Script Canvas and Input components, assign previously created Input Bindings file and script to corresponding components.</li><li>Enter Game Mode and press space key to print message in console.</li><li>Assign various keys in Input Bindings file.</li></ol> | <ul><li>Various inputs can be assigned to Input Handlers.</li><li>Script Canvas receives and handles assigned inputs.</li> |
|
|
|
+| Create a script for Audio playback | **Prerequisites:**</li><ul><li>Wwise project is setup.</li><li>Wwise Audio Engine Gem is enabled.</li></ul></ul> <ol><li>Create an entity with Script Canvas, Audio Trigger, and Audio Proxy components.</li><li>In Audio Trigger component assign Play trigger.<li>Create a script with Execute Trigger node that will execute after short delay and assign it to Script Canvas component. </li><li> Enter Game Mode.</li></ol> | <ul><li>Audio triggers can be triggered by Script Canvas.</li><li>Audio output can be heard when triggers are playing.</li> |
|
|
|
| Using Command Line | <ol><li>Open the Command Line tool with tools menu and Ctrl+P shortcut.</li><li>Type **?** in the command line text bar.<li>Select a command.</li><li>Click the Enter key.</li><li>Type in working command directly into a text bar and click the Enter key.</li></ol> | <ul><li>Command Line Tool can be opened and input can be written into its text bar.</li><li>Commands can be searched for by typing **?** into the text bar.</li><li>Found commands can be entered and corresponding actions such as creating new nodes in Script Canvas graph are executed by the command.</li><li> Commands can be manually typed into the text bar and executed.</li> |
|
|
|
---
|
Tomasz Serwański