Skip to content

Commit

Permalink
version bump and schema docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Bam4d committed May 10, 2021
1 parent b4a6558 commit 1e77492
Show file tree
Hide file tree
Showing 29 changed files with 635 additions and 80 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ If applicable, add screenshots to help explain your problem.

**Desktop (please complete the following information):**
- OS: [e.g. mac/linux/windows]
- Version [e.g. 1.0.2]
- Version [e.g. 1.1.0]

**Additional context**
Add any other context about the problem here.
2 changes: 1 addition & 1 deletion CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
cmake_minimum_required(VERSION 3.10.0)
project(Griddly VERSION 1.0.2)
project(Griddly VERSION 1.1.0)

set(BINARY ${CMAKE_PROJECT_NAME})

Expand Down
2 changes: 1 addition & 1 deletion bindings/python.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ namespace griddly {

PYBIND11_MODULE(python_griddly, m) {
m.doc() = "Griddly python bindings";
m.attr("version") = "1.0.2";
m.attr("version") = "1.1.0";

#ifndef NDEBUG
spdlog::set_level(spdlog::level::debug);
Expand Down
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
author = 'Chris Bamford'

# The full version, including alpha/beta/rc tags
release = '1.0.2'
release = '1.1.0'


# -- General configuration ---------------------------------------------------
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.. _#/properties/Actions/items/properties/Behaviours/definitions/behaviourDefinitionConditionalCommand/properties/lt:
.. _#/properties/Actions/items/properties/Behaviours/definitions/behaviourDefinitionConditionalCommand/properties/gt:

.. #/properties/Actions/items/properties/Behaviours/definitions/behaviourDefinitionConditionalCommand/properties/lt
.. #/properties/Actions/items/properties/Behaviours/definitions/behaviourDefinitionConditionalCommand/properties/gt
Greater Than
============
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
.. _#/properties/Actions/items/properties/Behaviours/definitions/behaviourDefinitionConditionalCommand/properties/gte:

.. #/properties/Actions/items/properties/Behaviours/definitions/behaviourDefinitionConditionalCommand/properties/gte
Greater Than Or Equal
=====================

:Description: The specified commands will only be run if the value of the first argument is greater than or equal to the second.

.. list-table::

* - **Data Type**
- **YAML Key**
* - object
- ``gte``


:Properties:

.. list-table::

* - **Property**
- **Required**
* - :ref:`Arguments <#/properties/Actions/items/properties/Behaviours/definitions/commandArgument>`
-
* - :ref:`Commands <#/properties/Actions/items/properties/Behaviours/definitions/behaviourDefinitionConditionalCommandList>`
-


.. toctree::
:hidden:

/reference/GDY/Actions/items/Behaviours/commandArgument/index
/reference/GDY/Actions/items/Behaviours/behaviourDefinitionConditionalCommandList/index
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,13 @@ Conditional Behaviour Command
- **Required**
* - :ref:`eq <#/properties/Actions/items/properties/Behaviours/definitions/behaviourDefinitionConditionalCommand/properties/eq>`
-
* - :ref:`lt <#/properties/Actions/items/properties/Behaviours/definitions/behaviourDefinitionConditionalCommand/properties/gt>`
* - :ref:`lt <#/properties/Actions/items/properties/Behaviours/definitions/behaviourDefinitionConditionalCommand/properties/lt>`
-
* - :ref:`gt <#/properties/Actions/items/properties/Behaviours/definitions/behaviourDefinitionConditionalCommand/properties/lt>`
* - :ref:`lte <#/properties/Actions/items/properties/Behaviours/definitions/behaviourDefinitionConditionalCommand/properties/lte>`
-
* - :ref:`gt <#/properties/Actions/items/properties/Behaviours/definitions/behaviourDefinitionConditionalCommand/properties/gt>`
-
* - :ref:`gte <#/properties/Actions/items/properties/Behaviours/definitions/behaviourDefinitionConditionalCommand/properties/gte>`
-


Expand All @@ -26,4 +30,6 @@ Conditional Behaviour Command

eq/index
lt/index
lte/index
gt/index
gte/index
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.. _#/properties/Actions/items/properties/Behaviours/definitions/behaviourDefinitionConditionalCommand/properties/gt:
.. _#/properties/Actions/items/properties/Behaviours/definitions/behaviourDefinitionConditionalCommand/properties/lt:

.. #/properties/Actions/items/properties/Behaviours/definitions/behaviourDefinitionConditionalCommand/properties/gt
.. #/properties/Actions/items/properties/Behaviours/definitions/behaviourDefinitionConditionalCommand/properties/lt
Less Than
=========
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
.. _#/properties/Actions/items/properties/Behaviours/definitions/behaviourDefinitionConditionalCommand/properties/lte:

.. #/properties/Actions/items/properties/Behaviours/definitions/behaviourDefinitionConditionalCommand/properties/lte
Less Than Or Equal
==================

:Description: The specified commands will only be run if the value of the first argument is less than or equal to the second.

.. list-table::

* - **Data Type**
- **YAML Key**
* - object
- ``lte``


:Properties:

.. list-table::

* - **Property**
- **Required**
* - :ref:`Arguments <#/properties/Actions/items/properties/Behaviours/definitions/commandArgumentList>`
-
* - :ref:`Commands <#/properties/Actions/items/properties/Behaviours/definitions/behaviourDefinitionConditionalCommandList>`
-


.. toctree::
:hidden:

/reference/GDY/Actions/items/Behaviours/commandArgumentList/index
/reference/GDY/Actions/items/Behaviours/behaviourDefinitionConditionalCommandList/index
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
.. _#/properties/Actions/items/properties/Behaviours/definitions/behaviourDefinitionPreconditionCommand/properties/gte:

.. #/properties/Actions/items/properties/Behaviours/definitions/behaviourDefinitionPreconditionCommand/properties/gte
Greater Than Or Equal
=====================

:Description: Check if the first argument is greater than or equal to the second

.. list-table::

* - **Data Type**
- **YAML Key**
- **Max Items**
- **Min Items**
* - array
- ``gte``
- 2
- 2


:Array Type:

.. list-table::

* - **Type**
- **Description**
* - :ref:`Command Argument<#/properties/Actions/items/properties/Behaviours/definitions/commandArgument>`
- An argument to a behaviour command.


.. toctree::
:maxdepth: 5
:hidden:

/reference/GDY/Actions/items/Behaviours/commandArgument/index
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,12 @@ Behaviour Precondition
-
* - :ref:`gt <#/properties/Actions/items/properties/Behaviours/definitions/behaviourDefinitionPreconditionCommand/properties/gt>`
-
* - :ref:`gte <#/properties/Actions/items/properties/Behaviours/definitions/behaviourDefinitionPreconditionCommand/properties/gte>`
-
* - :ref:`lt <#/properties/Actions/items/properties/Behaviours/definitions/behaviourDefinitionPreconditionCommand/properties/lt>`
-
* - :ref:`lte <#/properties/Actions/items/properties/Behaviours/definitions/behaviourDefinitionPreconditionCommand/properties/lte>`
-


.. toctree::
Expand All @@ -29,4 +33,6 @@ Behaviour Precondition
eq/index
neq/index
gt/index
gte/index
lt/index
lte/index
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
.. _#/properties/Actions/items/properties/Behaviours/definitions/behaviourDefinitionPreconditionCommand/properties/lte:

.. #/properties/Actions/items/properties/Behaviours/definitions/behaviourDefinitionPreconditionCommand/properties/lte
Less Than Or Equal
==================

:Description: Check if the first argument is less than or equal to the second

.. list-table::

* - **Data Type**
- **YAML Key**
- **Max Items**
- **Min Items**
* - array
- ``lte``
- 2
- 2


:Array Type:

.. list-table::

* - **Type**
- **Description**
* - :ref:`Command Argument<#/properties/Actions/items/properties/Behaviours/definitions/commandArgument>`
- An argument to a behaviour command.


.. toctree::
:maxdepth: 5
:hidden:

/reference/GDY/Actions/items/Behaviours/commandArgument/index
28 changes: 13 additions & 15 deletions docs/reference/GDY/Environment/Termination/End/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,26 +7,24 @@ End Conditions

:Description: If any of these conditions are met, the game will end.

.. list-table::
:Possible Values:

* - **Data Type**
- **YAML Key**
* - array
- ``End``
.. list-table::

* - **Value**
- **Type**
- **Description**
* - V1 Termination Conditions
- array
- V1 Termination Conditions
* - V2 Termination Conditions
- array
- V2 Termination Conditions

:Array Type:

.. list-table::

* - **Type**
- **Description**
* - :ref:`Termination Conditions<#/properties/Environment/properties/Termination/definitions/terminationCondition>`
- When a termination condition is met, the game will reset itself. If there are multiple players, the termination arguments are expanded internally "per player". This can be used to find the first player to a certain number of objects, or the first player to reach a certain score

* - **YAML Key**
* - ``End``

.. toctree::
:maxdepth: 5
:hidden:

/reference/GDY/Environment/Termination/terminationCondition/index
28 changes: 13 additions & 15 deletions docs/reference/GDY/Environment/Termination/Lose/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,26 +7,24 @@ Lose Conditions

:Description: If any of these conditions are met, the player associated with this condition will lose the game.

.. list-table::
:Possible Values:

* - **Data Type**
- **YAML Key**
* - array
- ``Lose``
.. list-table::

* - **Value**
- **Type**
- **Description**
* - V1 Termination Conditions
- array
- V1 Termination Conditions
* - V2 Termination Conditions
- array
- V2 Termination Conditions

:Array Type:

.. list-table::

* - **Type**
- **Description**
* - :ref:`Termination Conditions<#/properties/Environment/properties/Termination/definitions/terminationCondition>`
- When a termination condition is met, the game will reset itself. If there are multiple players, the termination arguments are expanded internally "per player". This can be used to find the first player to a certain number of objects, or the first player to reach a certain score

* - **YAML Key**
* - ``Lose``

.. toctree::
:maxdepth: 5
:hidden:

/reference/GDY/Environment/Termination/terminationCondition/index
28 changes: 13 additions & 15 deletions docs/reference/GDY/Environment/Termination/Win/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,26 +7,24 @@ Win Conditions

:Description: If any of these conditions are met, the player associated with this condition will win the game.

.. list-table::
:Possible Values:

* - **Data Type**
- **YAML Key**
* - array
- ``Win``
.. list-table::

* - **Value**
- **Type**
- **Description**
* - V1 Termination Conditions
- array
- V1 Termination Conditions
* - V2 Termination Conditions
- array
- V2 Termination Conditions

:Array Type:

.. list-table::

* - **Type**
- **Description**
* - :ref:`Termination Conditions<#/properties/Environment/properties/Termination/definitions/terminationCondition>`
- When a termination condition is met, the game will reset itself. If there are multiple players, the termination arguments are expanded internally "per player". This can be used to find the first player to a certain number of objects, or the first player to reach a certain score

* - **YAML Key**
* - ``Win``

.. toctree::
:maxdepth: 5
:hidden:

/reference/GDY/Environment/Termination/terminationCondition/index
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
.. _#/properties/Environment/properties/Termination/definitions/terminationConditionV1/properties/eq:

.. #/properties/Environment/properties/Termination/definitions/terminationConditionV1/properties/eq
Equals
======

:Description: Check if the arguments are equal

.. list-table::

* - **Data Type**
- **YAML Key**
- **Max Items**
- **Min Items**
* - array
- ``eq``
- 2
- 2


:Array Type:

.. list-table::

* - **Type**
- **Description**
* - :ref:`Termination Arguments<#/properties/Environment/properties/Termination/definitions/terminationConditionV1/definitions/terminationArgument>`
- An argument to the termination condition. If there are multiple players, then these arguments expand internally as "per player"


.. toctree::
:maxdepth: 5
:hidden:

/reference/GDY/Environment/Termination/terminationConditionV1/terminationArgument/index
Loading

0 comments on commit 1e77492

Please sign in to comment.