StudyCrafter

===== StudyCrafter Scriptor Tab ===== The Scriptor Tab is where you design the logic driving each scene. You can set player choices, write dialogues, or plan actions in the Scriptor Tab, by creating nodes and setting relationships between them. a {{::scriptor_screen.png?1000|}} ==== 1. Variables ==== Click this button to show the Variables tab. The tab is shown in the image below. If the Variables tab is already shown, clicking the button again will hide it. {{::variables_tab.png?400|}} From the Variables tab, the following functions can be accessed: === 1. Set Values === The main section of the Variables tab shows all variables currently in use: This includes all variables related to every character and asset in the current scene, and all global variables created in the project. Variables are displayed hierarchically: All global variables are collected under the Global Variables header, while all character or asset-related variables are collected under the Object Variables header, with subheaders for each specific character or asset. Clicking the arrow on the right side of each header collapses or expands all subordinate variables. You can change the value of any variable by double-clicking it, and putting the desired value in the value box. === 2. Create New Variables === By clicking this button, you can create new global variables. The screen that appears to do this is shown below: {{::variable_create.png?400|}} A global variable has the following attributes: ==Name== The name of the variable. This can be whatever you want. ==Type== The variable type. Possible types include: Integer, float, string, boolean, and 'none'. Different variable types allow for different types of data to be stored. ==Initial Value== You can set an initial value for the new variable here. This value should fit the variable type set above; if this does not match, StudyCrafter sets the variable to 'empty'. ==Kind== The 'kind' of variable you are making, i.e. what role this variable plays in your study. Variable kinds include: Independent variable, dependent variable, 'none', and 'null'. === 3. Hide & Expand Variables === Click this little triangle buttons, you can hide or expand global and object variable group. For the variables in these groups, you can also click those buttons to hide or expand the values of each variable. === 4. Hide & Expand Tab === Click this arrow button to hide the Variables tab. If the Variables tab is already hidden, clicking the button again will show it. ==== 2. Starting Node ==== Every StudyCrafter scene starts from a Start node. By clicking, dragging, then releasing the yellow ball, StudyCrafter will give you the option to create a new node that is directly connected to the Start node. The image below shows what this looks like: {{::nodes_new.png?400|}} A brief overview of the node types is presented here; for a more comprehensive overview, see the [[guide_nodetypes|Node Types]] page. === 1. Dialogue === This node adds dialogue to the scene. === 2. Action === This node allows characters or assets to undertake actions, such as moving, resizing, or appearing/disappearing from the scene. === 3. Player Choice === This node presents the player with a choice, and allows you to branch the scene logic based on that choice. === 4. Branch === This node branches off the scene logic based on predetermined criteria. It can also be used to randomly send players down one branch. === 5. Set Variable === This node lets you change the value of any Global Variable, or any Object Variable in the current scene. === 6. Sound === This node lets you play a sound. === 7. End Scene === This node lets you end the current scene, either in order to move to a different scene or in order to end the game entirely. === 8. Event === This node lets you tell StudyCrafter to look for a certain type of 'event', e.g. a mouse click or a certain button press, or the passage of a certain amount of time. When this event happens, the node and any nodes attached to them become active. === 9. Make Function === This node lets you define a 'function', consisting of a number of connected nodes. The Function node and any connected nodes are inactive unless 'called'. === 10. Call Function === This node lets you 'call' a previously-defined Function Node, activating it and any connected nodes. ==== 3. Center Button ==== Click this button to center your camera view. ==== 4. Mini-Map (?) ==== The Mini-Map shows the thumbnail of the scene. If you move your mouse above it, it will show the X/Y coordinates of the place you are pointing. {{:mini_map.png?400|}} ==== 5. Report Bug ==== If you encounter any bugs while using StudyCrafter, click the Report Bug button to let us know. The bug report window is shown below. {{:report_bug.png?400|}} ==== 6. Research Button ==== Click this button to enter the [[guide_research|Research Tab]]. ==== 7. Layout Button ==== Click the Layout Button to enter the [[guide_layout|Layout Tab]]. ==== 8. Play the Scene ==== Click the Play Button to play your game from the selected scene. **Note:** If your game is not designed to be started from this scene, this may cause some anomalous effects. ==== 9. Back to Project ==== Click this button to go back to the [[guide_projects|Projects Screen]]. ==== 10. Zoom in & Zoom out ==== Click the "+" button to zoom in and the "-" button to zoom out.