Construction

- type: constructionGraph

  # Identifier for the graph.
  id: ExampleGraph
  
  # Graphs must specify an starting node for pathfinding purposes.
  # All other nodes should be reachable from this one.
  start: start
  
  # And now we actually define the graph!
  graph:
  
    # You define nodes like this.
    - node: start
    
      # The entity prototype specified by this node.
      # This will turn the entity into it, if different.
      entity: MySpecialEntity
    
      # Nodes can have actions that are executed when the node is reached.
      # They are executed in the same order they're defined, from top to bottom.
      actions:
        # You specify actions without parameters like this.
        # The type is the name of the C# class that implements IGraphAction.
        - !type:ExampleActionWithNoParameters {}
        
        # Actions can specify any parameters, as they implement IExposeData.
        - !type:ExampleActionWithParameters
          foo: "bar"
          
        # Below, you'll find all valid actions as of the time of writing.
        
        # This action simply plays a sound from the entity, with pitch variation.
        - !type:PlaySound
          sound: /path/to/my/sound.ogg
          # When sound collection is specified, "sound" is ignored.
          soundCollection: mySoundCollection
          
          # This action displays a popup to the user.
        - !type:PopupUser
          # Whether the popup is shown on the cursor, or on the entity.
          cursor: false
          text: "Hello, person who made me reach this node!"
          
          # Sets the anchor value of the entity.
        - !type:SetAnchor
          value: true
          
          # Snaps the entity to the tile it's standing on.
        - !type:SnapToGrid
          offset: Center # or Edge. See the SnapGridOffset enum.
          
          # Spawns an entity prototype on the location of the entity.
        - !type:SpawnPrototype
          # The entity prototype ID. In this case, a single steel sheet.
          prototype: SteelSheet1
          # Number of times it will be spawned
          amount: 5
          
          # Changes the sprite of the entity.
        - !type:SpriteChange
          # Layer to change. Zero by default.
          layer: 0
          # RSI+State sprite specifier.
          specifier:
            sprite: "My/special/sprite.rsi"
            state: "sample_state"
          # Texture sprite specifier. Duplicated only for teaching purposes.
          specifier: "My/texture/somewhere.png"
          
          # Changes the RSI state of a layer.
        - !type:SpriteStateChange
          # Layer to change. Zero by default.
          layer: 0
          state: "my_state"
          
          # Sets the data of a visualizer to an int.
        - !type:VisualizerDataInt
          # The key (either a regular string or enum) of the data.
          key: "enum.MyVisualizerVisuals.MyVisuals"
          # The actual data to be set.
          data: 1
        
          # Special action that creates a computer from a computer board
          # in a specific container. You probably don't want to use this.
        - !type:BuildComputer
          # The container where the computer board is located. 
          container: "board"
          
          # Deletes the entity! Actions after this one aren't executed.
        - !type:DeleteEntity {}
      
      # And now we define the edges!
      edges:
        # This defines an edge. "otherNode" is the identifier of another node.
        - to: otherNode
          # This also takes actions like above.
          # They will be executed when the edge is completed.
          completed:
            - !type:ExampleActionWithNoParameters {}
            
          # Edges can also specify conditions.
          # All of these must be satisfied for the edge to be available.
          # They are defined in a similar way to the actions above.
          conditions:
            - !type:ExampleConditionWithNoParameters {}
            
            # Below you will find all conditions as of the time of writing.
          
              # Condition for when there has to be an entity with
              # a component on a tile, or no entities with
              # a certain component on the tile.
            - !type:ComponentInTile
              # The component name.
              component: "myComponent"
              # If true, any entity on the tile must have the component.
              # If false, no entity on the tile must have the component.
              hasEntity: true
              
              # Condition for when a container on the entity must be empty.
            - !type:ContainerEmpty
              container: "board"
              
              # Condition for when an entity needs to be anchored or unanchored.
            - !type:EntityAnchored
              # anchored state required for the condition to be satisfied
              anchored: false
              
              # Condition for when the entity's wire panel must be open/closed.
            - !type:WirePanel
              # State of the wire panel for the condition to be satisfied.
              open: true
    
      # And now we define the actual steps of this edge.
      steps:
      
      
        # Material step. Requires you to insert a material.
      - material: Glass # Any from StackType.
        amount: 2
        # If store is specified, it will store the material in a container.
        # If store is not specified, it will simply delete it.
        store: myContainer
        # All steps can have a do_after delay, in seconds.
        doAfter: 2
        # All steps can also have completed actions, just like edges.
        # They're specified in the same way as with node actions.
        # They will be executed when the step is completed (after the doAfter)
        completed:
        - !type:ExampleActionWithNoParameters {}
        
        
        # Tool step. Requires you to use a tool on the entity.
      - tool: Screwing # As specified in the ToolQuality enum.
        doAfter: 0.25
        
        
        # Component step.
      - component: ComputerBoard # This accepts any entities with that component.
        # The container where the item will be stored at.
        # It will be deleted if this is not specified.
        store: board
        # This name will be used in the construction guide.
        name: Computer Board
        # This icon will be used in the construction guide.
        # It uses SpriteSpecifier.
        icon: /Textures/My/Path/To/A/Texture.png
        
        
        # Prototype step. Requires you to insert an entity that comes from a
        # specific prototype. Won't accept anything else.
      - prototype: MyVerySpecificPrototype
        # The container where the item will be stored at.
        # It will be deleted if this is not specified.
        store: aCertainContainer
        # This name will be used in the construction guide.
        name: A Certain Item
        # This icon will be used in the construction guide.
        # It uses SpriteSpecifier.
        icon:
          sprite: My/Path/To/A/Sprite.rsi
          state: MyState
      
      
        # Tag step. Requires you to insert an entity that has a specific tag.
        # Won't accept anything else.
      - tag: MyVerySpecificTag
        # The container where the item will be stored at.
        # It will be deleted if this is not specified.
        store: anotherCertainContainer
        # This name will be used in the construction guide.
        name: Another Certain Item
        # This icon will be used in the construction guide.
        # It uses SpriteSpecifier.
        icon: /Textures/I/Cant/Thing/Of/Anything.png
        
        
        # Multiple tag step. Allows you to require a certain configuration of tags.
        
        # I will now write multiple valid multiple tag step configurations
        # Keep in mind that multiple tag steps can also specify 
        # "store", "name", "icon" and "doAfter" as well! I will omit them here 
        # for extra clarity...
        
        # This will require the entity to have all of the tags below.
      - allTags:
          - MyTagOne
          - MyTagTwo
          
        # This will require the entity to have any of the tags below.
      - anyTags:
          - MyTagOne
          - MyTagTwo
          
        # This will require the entity to have MyTagOne and either
        # MyTagTwo or MyTagThree.
      - allTags:
          - MyTagOne
        anyTags:
          - MyTagTwo
          - MyTagThree
          
        # This will require the entity to have MyTagOne and MyTagFour
        # and either MyTagTwo or MyTagThree.
        # As you can see, you can put these in any order!
      - anyTags:
          - MyTagTwo
          - MyTagThree
        allTags:
          - MyTagOne
          - MyTagFour
    
    # We can keep defining as many nodes as we want... The sky is the limit!
    - node: otherNode
    - node: anotherNode    

# Girder
- type: construction

  # User-friendly name.
  name: girder
  
  # Recipe identifier.
  id: girder
  
  # Construction graph identifier.
  graph: girder
  
  # The node we start the recipe from. (State of the construction ghost)
  startNode: start
  
  # The node we're trying to arrive. Can be any node in the graph, as long as
  # there's a path to it from the starting node.
  targetNode: girder
  
  # User-friendly category of the recipe.
  category: Structures
  
  # User-friendly description shown on the menu.
  description: A large structural assembly made out of metal.
  
  # Sprite specifier for the recipe. Shown on the menu.
  icon:
    sprite: /Textures/Constructible/Structures/Walls/solid.rsi
    state: wall_girder

  # Whether this is an Structure or an Item.
  # In the case of an structure, a construction ghost will be placed.
  # The user then needs to interact with it to start building it.
  # In the case of an item, the user attempts to craft the item directly from
  # the items in their hands, inventory and surroundings.
  objectType: Structure
  
  # Placement mode.
  placementMode: SnapgridCenter
  
  # Same as edge conditions, but these will be checked before constructing.
  conditions:
    - !type:ExampleConstrutionConditionWithNoParameters {}
    
    # Below you'll find all current construction conditions as of writing this.
    
    # Checks if there's a low wall in the tile. Useful for windows.
    - !type:LowWallInTile {}
    
    # Checks if there are no windows in the tile. Useful for low walls.
    - !type:NoWindowsInTile {}