weyne/dcs-retribution
1
0
Fork 0
mirror of https://github.com/dcs-retribution/dcs-retribution.git synced 2025-11-10 15:41:24 +00:00
Code Issues Packages Projects Releases Wiki Activity

Move briefing string literals to template

Browse Source
This commit is contained in:
walterroach 2020-11-05 15:36:07 -06:00
parent cdb16cc591
commit a8b59cc567
2 changed files with 58 additions and 116 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

119
gen/briefinggen.py
View File

@ -38,118 +38,7 @@ class FrontLineInfo:
self.enemy_zero: bool = self.enemy_base.base.total_armor == 0
self.advantage: bool = self.player_base.base.total_armor > self.enemy_base.base.total_armor
self.stance: CombatStance = self.player_base.stances[self.enemy_base.id]
@property
def _random_frontline_sentence(self) -> str:
"""Random sentences for start of situation briefing"""
templates = [
f"There are combats between {self.player_base.name} and {self.enemy_base.name}. ",
f"The war on the ground is still going on between {self.player_base.name} and {self.enemy_base.name}. ",
f"Our ground forces in {self.player_base.name} are opposed to enemy forces based in {self.enemy_base.name}. ",
f"Our forces from {self.player_base.name} are fighting enemies based in {self.enemy_base.name}. ",
f"There is an active frontline between {self.player_base.name} and {self.enemy_base.name}. ",
]
return random.choice(templates)
@property
def _zero_units_sentence(self) -> str:
"""Situation description if either side has zero units on a frontline"""
if self.player_zero:
return ("We do not have a single vehicle available to hold our position. The situation is critical, "
f"and we will lose ground inevitably betweeen {self.player_base.name} and {self.enemy_base.name}")
elif self.enemy_zero:
return ("The enemy forces have been crushed, we will be able to make significant progress"
f" toward {self.enemy_base.name}.")
return ""
@property
def _advantage_description(self) -> str:
"""Situation description for when player has a numerical advantage
Returns:
str
"""
if self.stance == CombatStance.AGGRESSIVE:
return (
"On this location, our ground forces will try to make "
"progress against the enemy. As the enemy is outnumbered, "
"our forces should have no issue making progress."
)
elif self.stance == CombatStance.ELIMINATION:
return (
"On this location, our ground forces will focus on the destruction of enemy"
f"assets, before attempting to make progress toward {self.enemy_base.name}. "
"The enemy is already outnumbered, and this maneuver might draw a final "
"blow to their forces."
)
elif self.stance == CombatStance.BREAKTHROUGH:
return (
"On this location, our ground forces will focus on progression toward "
f"{self.enemy_base.name}."
)
elif self.stance in [CombatStance.DEFENSIVE, CombatStance.AMBUSH]:
return (
"On this location, our ground forces will hold position. We are not expecting an enemy assault."
)
# TODO: Write a situation description for player RETREAT stance
elif self.stance == CombatStance.RETREAT:
return ""
else:
logging.warning("Briefing did not receive a known CombatStance")
return ""
@property
def _disadvantage_description(self) -> str:
"""Situation description for when player has a numerical disadvantage
Returns:
str
"""
if self.stance == CombatStance.AGGRESSIVE:
return (
"On this location, our ground forces will try an audacious "
"assault against enemies in superior numbers. The operation"
" is risky, and the enemy might counter attack."
)
elif self.stance == CombatStance.ELIMINATION:
return (
"On this location, our ground forces will try an audacious assault against "
"enemies in superior numbers. The operation is risky, and the enemy might "
"counter attack."
)
elif self.stance == CombatStance.BREAKTHROUGH:
return (
"On this location, our ground forces have been ordered to rush toward "
f"{self.enemy_base.name}. Wish them luck... We are also expecting a counter attack."
)
elif self.stance in [CombatStance.DEFENSIVE, CombatStance.AMBUSH]:
return (
"On this location, our ground forces have been ordered to hold still, "
"and defend against enemy attacks. An enemy assault might be iminent."
)
# TODO: Write a situation description for player RETREAT stance
elif self.stance == CombatStance.RETREAT:
return ""
else:
logging.warning("Briefing did not receive a known CombatStance")
return ""
@property
def brief(self) -> str:
"""Situation briefing string
Returns:
str
"""
if self._zero_units_sentence:
return self._zero_units_sentence
situation = self._random_frontline_sentence
if self.advantage:
situation += self._advantage_description
else:
situation += self._disadvantage_description
return situation
self.combat_stances = CombatStance
class MissionInfoGenerator:
"""Base type for generators of mission information for the player.
@ -238,10 +127,12 @@ class BriefingGenerator(MissionInfoGenerator):
env = Environment(
loader=FileSystemLoader("resources/briefing/templates"),
autoescape=select_autoescape(
disabled_extensions=("txt",),
disabled_extensions=("",),
default_for_string=True,
default=True,
)
),
trim_blocks=True,
lstrip_blocks=True,
)
self.template = env.get_template("briefingtemplate_EN.j2")

55
resources/briefing/templates/briefingtemplate_EN.j2
View File

@ -5,8 +5,59 @@ Most briefing information, including communications and flight plan information,
Current situation:
====================
{% if not frontlines %}There are currently no fights on the ground.{% endif %}{% if frontlines %}{% for frontline in frontlines %}
{{ frontline.brief }}
{% if not frontlines %}
There are currently no fights on the ground.
{% endif %}
{% if frontlines %}
{%+ for frontline in frontlines %}
{% if frontline.player_zero %}
We do not have a single vehicle available to hold our position. The situation is critical, and we will lose ground inevitably between {{ frontline.player_base.name }} and {{ frontline.enemy_base.name }}.
{% endif %}
{% if frontline.enemy_zero %}
The enemy forces have been crushed, we will be able to make significant progress toward {{ frontline.enemy_base.name }}
{% endif %}
{# Pick a random sentence to describe each frontline #}
{% set fl_sent1 %}There are combats between {{ frontline.player_base.name }} and {{frontline.enemy_base.name}}. {%+ endset %}
{% set fl_sent2 %}The war on the ground is still going on between {{frontline.player_base.name}} and {{frontline.enemy_base.name}}. {%+ endset %}
{% set fl_sent3 %}Our ground forces in {{frontline.player_base.name}} are opposed to enemy forces based in {{frontline.enemy_base.name}}. {%+ endset %}
{% set fl_sent4 %}Our forces from {{frontline.player_base.name}} are fighting enemies based in {{frontline.enemy_base.name}}. {%+ endset %}
{% set fl_sent5 %}There is an active frontline between {{frontline.player_base.name}} and {{frontline.enemy_base.name}}. {%+ endset %}
{% set frontline_sentences = [fl_sent1, fl_sent2, fl_sent3, fl_sent4, fl_sent5] %}
{{ frontline_sentences | random }}
{%- if frontline.advantage %}
{%- if frontline.stance == frontline.combat_stances.AGGRESSIVE %}
On this location, our ground forces will try to make progress against the enemy. As the enemy is outnumbered, our forces should have no issue making progress.
{% endif %}
{%- if frontline.stance == frontline.combat_stances.ELIMINATION %}
On this location, our ground forces will focus on the destruction of enemy assets, before attempting to make progress toward {{frontline.enemy_base.name}}. The enemy is already outnumbered, and this maneuver might draw a final blow to their forces."
{% endif %}
{%- if frontline.stance == frontline.combat_stances.BREAKTHROUGH %}
On this location, our ground forces will focus on progression toward {{ frontline.enemy_base.name }}
{% endif %}
{%- if frontline.stance in [frontline.combat_stances.DEFENSIVE, frontline.combat_stances.AMBUSH] %}
On this location, our ground forces will hold position. We are not expecting an enemy assault.
{% endif %}
{%- if frontline.stance == frontline.combat_stances.RETREAT %}
{# TODO: Write a retreat sentence #}
{% endif %}
{%- else %}
{%- if frontline.stance == frontline.combat_stances.AGGRESSIVE %}
On this location, our ground forces will try an audacious assault against enemies in superior numbers. The operation is risky, and the enemy might counter attack.
{% endif %}
{%- if frontline.stance == frontline.combat_stances.ELIMINATION %}
On this location, our ground forces will try an audacious assault against enemies in superior numbers. The operation is risky, and the enemy might counter attack.
{% endif %}
{%- if frontline.stance == frontline.combat_stances.BREAKTHROUGH %}
On this location, our ground forces have been ordered to rush toward {{frontline.enemy_base.name}}. Wish them luck... We are also expecting a counter attack.
{% endif %}
{%- if frontline.stance in [frontline.combat_stances.DEFENSIVE, frontline.combat_stances.AMBUSH] %}
On this location, our ground forces have been ordered to hold still, and defend against enemy attacks. An enemy assault might be iminent.
{% endif %}
{%- if frontline.stance == frontline.combat_stances.RETREAT %}
{# TODO: Write a retreat sentence #}
{% endif %}
{% endif %}
{% endfor %}{% endif %}
Your flights: