• City Builder Game Template v0.6.1 Documentation

    Table Of Contents
    1. Class Reference

    Class Reference

    Builder

    • Inherits: Node3D

    Description

    Signals

    Contants

    Properties

    • PackedScene camera_scene
    • CameraController camera_controller
    • GridMap gridmap
    • Plane plane
    • bool state_machine_debug = true
    • StateMachineBuilder state_machine
    • StateBuilderLoading loading_state
    • StateBuilderNavigate navigate_state

    Methods

    • void _read()
    • void init()
    • void init_camera()
    • void init_gridmap()
    • void init_state_machine()

    Inner Classes

    Condition

    • Inherits: Resource

    Description

    Signals

    Contants

    Properties

    • bool result

    Methods

    • bool validate()

    Inner Classes

    GridMapBuilder

    • Inherits: GridMap

    Description

    Signals

    Contants

    Properties

    • PackedScene camera_scene
    • CameraController camera_controller
    • GridMap gridmap
    • Plane plane
    • InputMapSetup input_map_setup
    • GridRender grid_render
    • GridMapBuilder gridmap
    • Vector3i gridmap_current_position = Vector3i.ZERO
    • Vector3i gridmapd_previous_position = Vector3i(-999, -999, -999)
    • Vector3i gridmap_world_position = Vector3.ZERO
    • Vector3i last_valid_world_position = Vector3(999.0, 999.0, 999.0)
    • int last_structure_selected = 0
    • int current_structure = 0
    • bool state_machine_debug = true
    • StateMachineBuilder state_machine
    • StateBuilderLoading loading_state
    • StateBuilderNavigate navigate_state

    Methods

    • void _read()
    • void _process(delta: float)
    • void init()
    • void init_camera()
    • void init_gridmap()
    • void init_renders()
    • void init_state_machine()
    • void calculate_gridmap_position()
    • bool mouse_is_inside_viewport()
    • void move_renders()

    Inner Classes

    GridRender

    • Inherits: GridMap

    Description

    Signals

    Contants

    Properties

    • PackedScene camera_scene
    • CameraController camera_controller
    • GridMap gridmap
    • Plane plane
    • bool state_machine_debug = true
    • StateMachineBuilder state_machine
    • StateBuilderLoading loading_state
    • StateBuilderNavigate navigate_state

    Methods

    • void _read()
    • void init()
    • void init_camera()
    • void init_gridmap()
    • void init_state_machine()

    Inner Classes

    ConditionValidator

    • Inherits: Resource

    Description

    Signals

    Contants

    Properties

    • PackedScene camera_scene
    • CameraController camera_controller
    • GridMap gridmap
    • Plane plane
    • bool state_machine_debug = true
    • StateMachineBuilder state_machine
    • StateBuilderLoading loading_state
    • StateBuilderNavigate navigate_state

    Methods

    • void _read()
    • void init()
    • void init_camera()
    • void init_gridmap()
    • void init_state_machine()

    Inner Classes

    GridMapBuilder

    • Inherits: GridMap

    Description

    Signals

    Contants

    Properties

    Methods

    Inner Classes

    Structure

    • Inherits: Resource

    Description

    Signals

    Contants

    • BUILD_MODE_NONE = 0
    • BUILD_MODE_MESH = 1
    • BUILD_MODE_BOX = 2
    • BUILD_MODE_PATH = 4

    Properties

    • int structure_id
    • String structure_name
    • PackedScene model_scene
    • int category_id
    • int type_id
    • Vector2i size
    • int build_modes
    • String icon_path
    • float price

    Methods

    Inner Classes

    StructureCategory

    • Inherits: Resource

    Description

    Signals

    Contants

    Properties

    • int id = -1
    • StringName category_name = &””
    • bool visible_on_menu = true

    Methods

    Inner Classes

    StructureType

    • Inherits: Resource

    Description

    Signals

    Contants

    Properties

    • int id = -1
    • StringName type_name = &””
    • bool visible_on_menu = true
    • int fallback_structure_id = -1

    Methods

    • void _init(p_id: int = -1, p_name: String = “”, p_visible: bool = true, p_fallback = -1)

    Inner Classes

  • Tiled City Builder BuilderMachine Class

    BuilderMachine

    Inherits: Node3D

    Inherited by:

    Description

    An implementation of A* for finding the shortest path between two vertices on a connected graph in 3D space.

    Signals

    transitioned(mode_name: String)

    Properties
    Dictionary(int, PointType)_type
    Methods
    void_read()
    void_unhandled_input(event: InputEvent)
    void_proccess(float: delta)

  • Tiled City Builder Builder Class

    Builder

    Inherits: Node3D

    Inherited by:

    Description

    Tiles builder controller

    Properties
    Planeplane
    boolmouse_click_enabledtrue
    intindex0
    GameMapmap
    Vector3world_positionVector3.ZERO
    Vector3gridmap_positionVector3.ZERO
    Stringcurrent_user_folderGlobalGameData.DEFAULT_GRIDMAP_PATH_NAME
    Methods
    void_read()
    void_unhandled_input(event: InputEvent)
    void_proccess(float: delta)

  • Tiled City Builder Astar3DPath Class

    Astar3DPath

    Inherits: Astar3D

    Inherited by:

    Description

    An implementation of A* for finding the shortest path between two vertices on a connected graph in 3D space.

    Enumerations

    PointType

    NONE.PointType

    PASSING.PointType

    DEPART.PointType

    Properties
    Dictionary(int, PointType)_type
    Methods
    voidset_point_type(id: int, type: PointType)
    void_remove_point_typephysics_proccess(id: int)
    PointTypeget_point_type(id: int)

  • Tiled City Builder AiAgent3D Class

    AiAgent3D

    Inherits: CharacterBody3D

    Inherited by:

    Description

    Controls the ai agents that populate the city.

    Properties
    Vector3end_positionVector3(0.0, 0.0, 0.0)
    intindex0
    floatmin_distance0.05
    boolmovefalse
    Array[Vector3]path_to_go[]
    floatspeed0.5
    Methods
    voidstart_agent(path: Array[Vector3])
    void_physics_proccess(delta: float)
    voidwalk_the_path(_delta: float)

  • Simple Series 3D Models Pack

    Is a series of 3D Models primarily built to be used with the City Builder Game Template as the models are stylished and scaled to reach the best visual for the game template package.

    Packges Included

    • Simple Buildings
    • Somple Cars
    • Simple Facilities
    • Simple Grounds
    • Simple Houses
    • Simple Roads
    • Simple Textures
    • Simple Trees

    Simple Facilities

    Simple Cars

    Simple Pack Buildings

    City Hall

    2x Scaled 3D Model using two textures: simple universal base texture and tiled roof texture.

    Hotel

    2x Scaled 3D Model using two textures: simple universal base texture and tiled roof texture.

    Municipal Hospital

    1.6x Scaled 3D Model using two textures: simple universal base texture and tiled roof texture.

    Military Police

    1.6x Scaled 3D Model using two textures: simple universal base texture and tiled roof texture.

    Municipal School

    1.6x Scaled 3D Model using simple universal base texture.

    Municipal Theather

    2.0x Scaled 3D Model using simple universal base texture.

    Simple Pack Houses Vol. 1

    House 01A

    1.0x Scaled 3D Model using simple universal base texture.

    House 02A

    1.0x Scaled 3D Model using simple universal base texture.