-
Mods are now organized as resources. Use the Mods link above to browse for or submit a mod, tool, or prefab.
The TFP Official Modding Forum Policy establishes the rules and guidelines for mod creators and mod users.
sphereii's DMT Mods
- Thread starter sphereii
- Start date
Chunkimunki
Refugee
Hi Sphereii, loving all your work and use 'em all. It's only a small matter but I also love upping Zed spawns plus Barrio's headshot modlet and going on a noggin poppin lark - sadly I think that the transmogrifier negates the modlet. How difficult would it be (if at all) to make them play nice?
Cheers
Cheers
sphereii
Survivor
Take a look in the transmogrifier's Config folder for the entityclasses.xml
Code:
<!-- Turn on head shots, and random speeds for entities-->
<append xpath="/entity_classes/entity_class[starts-with(@name, 'zombieTemplateMale')]" >
<property name="HeadShots" value="true" />
<property name="RandomSpeeds" value="true" />
<property name="RandomSize" value="true" />Chunkimunki
Refugee
OMG! It works like a charm! Thanks so much - can't believe a true 'legend' has just made lil ol'me's day! Cheers
Drconfused
Refugee
I came looking for this! Been wanting the headshots to work again!
ERROR: System.InvalidOperationException: The sequence contains no matching elements
by System.Linq.Enumerable.First [TSource] (IEnumerable`1 source, Func`2 predicate)
by AnimationChange.Patch (ModuleDefinition module)
by SevenDaysToDiePlugin.BuildAndRunPatchModsTask.RunPatcherMods ()
ERROR: Task Compile against patcher scripts failed
Getting this error when trying to build with SDX. Alpha 17.2
by System.Linq.Enumerable.First [TSource] (IEnumerable`1 source, Func`2 predicate)
by AnimationChange.Patch (ModuleDefinition module)
by SevenDaysToDiePlugin.BuildAndRunPatchModsTask.RunPatcherMods ()
ERROR: Task Compile against patcher scripts failed
Getting this error when trying to build with SDX. Alpha 17.2
Last edited by a moderator:
ok I am getting ERROR: System.InvalidOperationException: Sequence contains no matching element
at System.Linq.Enumerable.First[TSource](IEnumerable`1 source, Func`2 predicate)
at AnimationChange.Patch(ModuleDefinition module)
at SevenDaysToDiePlugin.BuildAndRunPatchModsTask.RunPatcherMods()
ERROR: Task Compile mod patcher scripts failed
when trying to build just the animation sdx for 17.2 what am I doing wrong?
at System.Linq.Enumerable.First[TSource](IEnumerable`1 source, Func`2 predicate)
at AnimationChange.Patch(ModuleDefinition module)
at SevenDaysToDiePlugin.BuildAndRunPatchModsTask.RunPatcherMods()
ERROR: Task Compile mod patcher scripts failed
when trying to build just the animation sdx for 17.2 what am I doing wrong?
sphereii
Survivor
sphereii
Survivor
SDX_Buffs
This SDX Mod adds additional Action events and Requirements that can be used in the buffs.xml.
MinEventActionAnimatorSpeedSDX
This class allows you to change the animation speed
Example Usage:
MinEventActionCreateItemSDX
This class allows you to get an item from a buff.
Example Usage:
MinEventActionGiveQuestSDX
This class allows you to give a Quest to a non-player character.
Example Usage:
MinEventActionModifySkillSDX
This class allows you to add (or subtract) points to a perk or skill
Example Usage:
MinEventActionPumpQuestSDX
Some new requirements and objectives added to the Quest system are not checked at regular intervals, such as if you have an Objective that progresses by a Buff. Adding a PumpQuest will cause each quest that the entity has to recheck all its objectives to see if it can progress.
Example Usage:
MinEventActionSkillPointSDX
This class allows you to add Skill Points to an entity via a buff
Example Usage:
MinEventActionSpawnBabySDX:
This class allows you to spawn an entity, or an entity from a spawn group, and sets a Mother cvar, linking the new entity to the original entity. This allows mothers to have babies that are linked to each other.
Example usage:
RequirementEveryXDaySDX:
This class adds a new requirement that triggers every day.
Example usage:
RequirementEveryXHourSDX:
This class adds a new requirement that triggers at the appointed time.
Example Usage:
RequirementOnSpecificBiomeSDX
This class adds a new requirement based on a biome name filter.
Example Usage:
RequirementSameFactionSDX
This class adds a new requirement based on the faction.
Example Usage:
MinEventActionAddBuffByFactionSDX
This class adds a new trigger event that filters based on faction. This allows us to filter certain AoE from affecting the same faction as we are.
Example Usage:
This SDX Mod adds additional Action events and Requirements that can be used in the buffs.xml.
MinEventActionAnimatorSpeedSDX
This class allows you to change the animation speed
Example Usage:
Code:
<triggered_effect trigger="onSelfBuffStart" action="AnimatorSpeedSDX, Mods" target="self" value="1" /> // normal speed
<triggered_effect trigger="onSelfBuffStart" action="AnimatorSpeedSDX, Mods" target="self" value="2" /> // twice the speedThis class allows you to get an item from a buff.
Example Usage:
Code:
<triggered_effect trigger="onSelfBuffRemove" action="CreateItemSDX, Mods" item="drinkJarCoffee" count="2"/>This class allows you to give a Quest to a non-player character.
Example Usage:
Code:
<triggered_effect trigger="onSelfBuffStart" action="GiveQuestSDX, Mods" target="self" quest="myNewQuest" />This class allows you to add (or subtract) points to a perk or skill
Example Usage:
Code:
<triggered_effect trigger="onSelfBuffStart" action="ModifySkillSDX, Mods" tag="skill_name" operation="add" value="1" /> // levels up skill_name by 1Some new requirements and objectives added to the Quest system are not checked at regular intervals, such as if you have an Objective that progresses by a Buff. Adding a PumpQuest will cause each quest that the entity has to recheck all its objectives to see if it can progress.
Example Usage:
Code:
<triggered_effect trigger="onSelfBuffStart" action="PumpQuestSDX, Mods" target="self" />This class allows you to add Skill Points to an entity via a buff
Example Usage:
Code:
<triggered_effect trigger="onSelfBuffStart" action="SkillPointSDX, Mods" target="self" value="2" /> // two Skill pointsThis class allows you to spawn an entity, or an entity from a spawn group, and sets a Mother cvar, linking the new entity to the original entity. This allows mothers to have babies that are linked to each other.
Example usage:
Code:
<triggered_effect trigger="onSelfBuffFinish" action="SpawnBabySDX, Mods" target="self" SpawnGroup="farmAnimalsCow" />This class adds a new requirement that triggers every day.
Example usage:
Code:
<requirement name="RequirementEveryXDaySDX, Mods" value="0"/> <!-- triggers on horde days -->
<requirement name="RequirementEveryXDaySDX, Mods" value="2"/> <!-- triggers every two days -->This class adds a new requirement that triggers at the appointed time.
Example Usage:
Code:
<requirement name="RequirementEveryXHourSDX, Mods" value="22"/> <!-- triggers at 22:00 hours -->This class adds a new requirement based on a biome name filter.
Example Usage:
Code:
<requirement name="RequirementOnSpecificBiomeSDX, Mods" biome="desert" />
<triggered_effect trigger="onSelfEnteredBiome" action="AddBuff" target="self" buff="bufffnamehere">
<requirement name="RequirementOnSpecificBiomeSDX, Mods" biome="desert" />
</triggered_effect>This class adds a new requirement based on the faction.
Example Usage:
Code:
<requirement name="RequirementSameFactionSDX, Mods" faction="animalsCows" /> <!-- Requirement will only pass if the entity belongs to this faction -->This class adds a new trigger event that filters based on faction. This allows us to filter certain AoE from affecting the same faction as we are.
Example Usage:
Code:
<triggered_effect trigger = "onSelfBuffUpdate" action="AddBuffByFactionSDX, Mods" target="selfAOE" range="4" buff="buffAnimalFertility" /> <!-- Only affects the same faction -->
<triggered_effect trigger = "onSelfBuffUpdate" action="AddBuffByFactionSDX, Mods" target="selfAOE" range="4" mustmatch="true" buff="buffAnimalFertility" /> <!-- Only affects other factions, not its own -->
Last edited by a moderator:
sphereii
Survivor
SDX_Quests
The follow classes have been added to allow more fine tuning of the Quest system, by introducing new Objectives and action types.
Note: The new Objectives are not tied into the official quest "pump" that gets triggered to check if the objective is checked. For this reason, the MinEventActionPumpQuestSDX was created, to pump the quest chains to see if the
objectives have been met.
ObjectiveBuffSDX
---------------------
This new Objective type allows you to set a condition on a buff before continuing. In the below example, in order to transition from Phase 1 to Phase 2, the entity must have the buff called "buffAnimalAdult".
Properties:
phase: Like in Vanilla.
buff: This is the buff that the entity must have before this phase will progress.
Example Usage:
ObjectiveGotoPOI
---------------------
This new Objective type allows you to target a particular prefab by name.
Properties:
PrefabName: This is the prefabName you wish to target, which is the filename without the extension.
Example Usage:
QuestActionGiveBuffSDX
---------------------
This new Action for the quest will give a buff to the recipient.
Properties:
type: This is the SDX Class of the GiveBuff
value: This is the buff you want to be applied
phase: Vanilla. Determines at which phase the buff is applied.
Example Usage:
RewardGiveNPCSDX
---------------------
This reward gives you the quest NPC to the player as a follower.
Properties:
type: This is the SDX Class of the GiveNPCSDX
id: If provided, a new NPC will be spawned from this entity group, and assigned to you. If no id is specified, the current NPC is assigned.
Example Usage:
RewardItemSDX
---------------------
This reward gives you target item.
Properties:
type: This is the SDX Class of the GiveNPCSDX
id: Provides the player with that item
value: Is the number of the item to provide.
Example Usage:
QuestActionSpawnEntitySDX
---------------------
This QuestAction allows you to spawn an entity, spawning it beside the SharedOwnerID's entity. Unlike SpawnEnemy, it won't automatically set the player or spawn entity trigger as an enemy. Like SpawnEnemy,
it can accept comma delimited entities in the id="animalFarmCow,zombieArlene".
Example Usage:
RewardQuestSDX
---------------------
This RewardQuest allows you to give a Quest to the SharedOwnerID entity. This is a non-Player reward.
Properties:
type: This is the SDX Class of the RewardQuestSDX
id: The quest name you want to give.
Example Usage:
Quest Line Example
-------------------
Here's an example of a Quest line that works based on buff progression.
As mentioned before, in order for the Objectives to properly fire, you need to use the MinEventActionPumpQuestSDX in the buffs. In the effect_group "Starting Effects", there's a PumpQuestSDX, Mods. This fires the refresh
call for each of the quests that belong to the entity to refresh and check their status.
The follow classes have been added to allow more fine tuning of the Quest system, by introducing new Objectives and action types.
Note: The new Objectives are not tied into the official quest "pump" that gets triggered to check if the objective is checked. For this reason, the MinEventActionPumpQuestSDX was created, to pump the quest chains to see if the
objectives have been met.
ObjectiveBuffSDX
---------------------
This new Objective type allows you to set a condition on a buff before continuing. In the below example, in order to transition from Phase 1 to Phase 2, the entity must have the buff called "buffAnimalAdult".
Properties:
phase: Like in Vanilla.
buff: This is the buff that the entity must have before this phase will progress.
Example Usage:
Code:
<objective type="BuffSDX, Mods">
<property name="phase" value="1" />
<property name="buff" value="buffAnimalAdult" />
</objective>---------------------
This new Objective type allows you to target a particular prefab by name.
Properties:
PrefabName: This is the prefabName you wish to target, which is the filename without the extension.
Example Usage:
Code:
<objective type="GotoPOISDX, Mods" value="500-800" phase="1">
<property name="completion_distance" value="50" />
<property name="PrefabName" value="prefabName" />
</objective>---------------------
This new Action for the quest will give a buff to the recipient.
Properties:
type: This is the SDX Class of the GiveBuff
value: This is the buff you want to be applied
phase: Vanilla. Determines at which phase the buff is applied.
Example Usage:
Code:
<action type="GiveBuff, Mods" value="buffAnimalPregnant" phase="3" />---------------------
This reward gives you the quest NPC to the player as a follower.
Properties:
type: This is the SDX Class of the GiveNPCSDX
id: If provided, a new NPC will be spawned from this entity group, and assigned to you. If no id is specified, the current NPC is assigned.
Example Usage:
Code:
<reward type="GiveNPCSDX, Mods" id="entityGroup" /> // Spawns in an entity from the group to be your NPC
<reward type="GiveNPCSDX, Mods" /> // Hires the current NPC---------------------
This reward gives you target item.
Properties:
type: This is the SDX Class of the GiveNPCSDX
id: Provides the player with that item
value: Is the number of the item to provide.
Example Usage:
Code:
<reward type="ItemSDX, Mods" id="casinoCoin" value="10" />---------------------
This QuestAction allows you to spawn an entity, spawning it beside the SharedOwnerID's entity. Unlike SpawnEnemy, it won't automatically set the player or spawn entity trigger as an enemy. Like SpawnEnemy,
it can accept comma delimited entities in the id="animalFarmCow,zombieArlene".
Example Usage:
Code:
<action type="SpawnEntitySDX, Mods" id="zombieBear" value="1" phase="3" /> <!-- This will spawn in an zombieBear entity during Phase 3 -->---------------------
This RewardQuest allows you to give a Quest to the SharedOwnerID entity. This is a non-Player reward.
Properties:
type: This is the SDX Class of the RewardQuestSDX
id: The quest name you want to give.
Example Usage:
Code:
<reward type="QuestSDX, Mods" id="Progression_Quest" />Quest Line Example
-------------------
Here's an example of a Quest line that works based on buff progression.
Code:
<quest id="Progression_Quest">
<property name="name_key" value="Progression_Quest" />
<property name="subtitle_key" value="Progression_Quest" />
<property name="description_key" value="Progression_Quest" />
<property name="icon" value="ui_game_symbol_zombie" />
<property name="repeatable" value="true" />
<property name="category_key" value="challenge" />
<property name="offer_key" value="Progression_Quest" />
<property name="difficulty" value="veryeasy" />
<!-- Before progressing, make sure the entity is at infection1 -->
<objective type="BuffSDX, Mods">
<property name="phase" value="1" />
<property name="buff" value="buffIllInfection1" />
</objective>
<!-- Before progressing, make sure the entity is at infection2 -->
<objective type="BuffSDX, Mods">
<property name="phase" value="2" />
<property name="buff" value="buffIllInfection2" />
</objective>
<!-- Before progressing, make sure the entity is at infection3 -->
<objective type="BuffSDX, Mods">
<property name="phase" value="3" />
<property name="buff" value="buffIllInfection3" />
</objective>
<!-- This will spawn in an zombieBear entity during Phase 3 -->
<action type="SpawnEntitySDX, Mods" id="zombieBear" value="1" phase="3" />
<!-- Once the entity is spawned, give back the same quest, and give it a casino coin for a good job. -->
<reward type="QuestSDX, Mods" id="buffProgression_Quest" />
<reward type="ItemSDX, Mods" id="casinoCoin" value="1" />
</quest>As mentioned before, in order for the Objectives to properly fire, you need to use the MinEventActionPumpQuestSDX in the buffs. In the effect_group "Starting Effects", there's a PumpQuestSDX, Mods. This fires the refresh
call for each of the quests that belong to the entity to refresh and check their status.
Code:
<buff name="buffInfectedAnimal1">
<stack_type value="ignore"/>
<duration value="50"/>
<effect_group name="Starting Effects">
<triggered_effect trigger="onSelfBuffStart" action="PumpQuestSDX, Mods" target="self" />
<triggered_effect trigger="onSelfBuffStart" action="RemoveBuff" target="self" buff="buffAnimalHarvestable" />
<triggered_effect trigger="onSelfBuffStart" action="RemoveBuff" target="self" buff="buffAnimalFertility" />
</effect_group>
<!-- Give the animal a chance to fight the infection -->
<effect_group name="Updates">
<triggered_effect trigger="onSelfBuffUpdate" action="RemoveBuff" target="self" buff="buffInfectedAnimal1" >
<requirement name="RandomRoll" seed_type="Random" target="self" min_max="0,100" operation="LTE" value="1"/>
</triggered_effect>
</effect_group>
<!-- handles the buffs that we are adding and removing together-->
<effect_group name="General Matched buffs">
<triggered_effect trigger="onSelfBuffStart" action="AttachParticleEffectToEntity" particle="p_onFire" local_offset="0,-.2,0" parent_transform="Hips"/>
<triggered_effect trigger="onSelfBuffFinish" action="RemoveParticleEffectFromEntity" particle="p_onFire"/>
<triggered_effect trigger="onSelfBuffRemove" action="RemoveParticleEffectFromEntity" particle="p_onFire"/>
</effect_group>
<effect_group name="Exit Buffs">
<triggered_effect trigger="onSelfBuffFinish" action="AddBuff" target="self" buff="buffInfectedAnimal2" />
<triggered_effect trigger="onSelfBuffRemove" action="AddBuff" target="self" buff="buffAnimalHarvestable" />
</effect_group>
</buff>sphereii
Survivor
SDX_Dialogs
The SDX Dialog adds in new actions and triggers used for the dialogs.xml, as well as include new UI controllers.
DialogActionExecuteCommandSDX
This class executes commands in the EntityAliveSDX.cs class. These commands must be added to the switch statement in EntityAliveSDX.cs to be effective.
Example Usage:
DialogActionOpenDialogSDX
This class allows us to open up a new window
Example Usage:
DialogRequirementHiredSDX
This class allows us to filter on if the statement should be visible, depending on if its hired or not.
Example Usage:
DialogRequirementPatrolSDX
This class shows or hides if the "Patrol" option is visible. If it does not have Patrol Coordinates (provided through the "Follow me for your patrol route" task"), then it won't show.'
Example Usage:
The SDX Dialog adds in new actions and triggers used for the dialogs.xml, as well as include new UI controllers.
DialogActionExecuteCommandSDX
This class executes commands in the EntityAliveSDX.cs class. These commands must be added to the switch statement in EntityAliveSDX.cs to be effective.
Example Usage:
Code:
<response id="FollowMe" text="Follow me" >
<requirement type="HiredSDX, Mods" requirementtype="Hide"/>
<action type="ExecuteCommandSDX, Mods" id="FollowMe" />
</response>This class allows us to open up a new window
Example Usage:
Code:
<response id="Hire" text="I am interested in hiring you." >
<requirement type="HiredSDX, Mods" requirementtype="Hide" value="not"/>
<action type="OpenDialogSDX, Mods" id="Hire" />
</response>This class allows us to filter on if the statement should be visible, depending on if its hired or not.
Example Usage:
Code:
<response id="FollowMe" text="Follow me" >
<requirement type="HiredSDX, Mods" requirementtype="Hide"/> <!-- This hides the entry if its not Hired. -->
<action type="ExecuteCommandSDX, Mods" id="FollowMe" />
</response>
<response id="Hire" text="I am interested in hiring you." >
<requirement type="HiredSDX, Mods" requirementtype="Hide" value="not"/> <!-- The value="not" flips the condition, so will only show if its not hired. -->
<action type="OpenDialogSDX, Mods" id="Hire" />
</response>This class shows or hides if the "Patrol" option is visible. If it does not have Patrol Coordinates (provided through the "Follow me for your patrol route" task"), then it won't show.'
Example Usage:
Code:
<response id="Patrol" text="Patrol your route" >
<requirement type="PatrolSDX, Mods" requirementtype="Hide" />
<action type="ExecuteCommandSDX, Mods" id="Patrol" />
</response>sphereii
Survivor
EntityAliveSDX
This is the new base class, which inherits from EntityNPC and all the sub classes. It has new features, such as allowing them to be hired and execute your orders.
NPCs can accept orders by interacting with them and selecting one of pre-made options. Using a combination of XML dialog settings and code, some dialog options will not appear unless they make sense. For example,
when you first meet an NPC, you will not be able to give them orders.
NPCs can be hired either by paying their Hire Cost, completing a quest line, or have some sort of incenntive for them to follow.
Using the new Maslow AI Task, along with the buff system, NPCs can consume food and water.
Hiring NPCs
Each unique NPC can have its own hiring cost and currency, available through the XML properties. By default, this is 1000 casino Coins. The HireCurrency is any available Item, and that item will be removed
from your inventory when you hire them.
Examples
Default:
Unique Item:
Currently, all NPCs are permanent hires. Once NPCs are hired, your entity ID is stored with the entity as a cvar "Leader". As soon as they are hired, they'll begin to follow you, and try to keep pace with your speed.
Initially, unhired NPCs will only show a few options in the dialog. However, when they are hired, they can do more for you.
Orders
Options can be filtered through using the SDX_Dialog class that adds new conditions to show statements based on if they are hired. Not all NPCs need to support all the tasks.
Here's a sample Dialog XML that show's the Hire option, if the NPC is not hired, and will show ShowMe and StayHere orders if it is hired.
Sample Dialog
Recommended AI Tasks
-------------------
The following AI tasks were used in testing well rounded NPCs. It is recommended taht you start off with this AI Tasks, and then customize as needed.
Maslow
-------------------
Losely modelled around Maslow's Hierachy of Needs, the NPCs have requirements based on a combination of buffs and a new AI task. This buff is applied through the entityclass entry, and controls the NPCs' food and
drink requirements. Over time, the NPCs will get hungry and thirsty, and, using the EAIMaslowLevel1SDX class, will seek out food and water through its configuration.
Food and Water
NPCs will look for food and water through their configured bins. Triggered by the HungryBuffs and ThirstyBuffs, the AI task will seek out food and water as needed, and consume it. Once satisfied, it'll continue
to wander.
Each entity can be configured to eat a certain food type. The NPCs will scan for the FoodBins, then search inside and consume one of the listed food items. The value of food they recieve is hard coded in the EAIMaslowLevel1
class initially, since some food items may not be have a food value, such as the hayBaleBlock. All foods satisfy the same amount of hunger.
Once an entity becomes too hungry or thirsty, it will start taking damage until it eventually dies.
Sanitation
As an optional feature, NPCs can be affected by a sanitation system. Over time, a sanitation level rises through a buff. Once this value reaches a threshold, the entity will need to use the bathroom. If
a bathroom is not available, they will do their business on the ground.
If sanitation is turned on, the entity will search for a ToiletBlocks that is nearby. If found, it will go to the ToiletBlock and reset its sanitation level. This is useful for NPCs, but might not work out so well for animals.
If an entity does not have a toilet block, it will eventually drop a SanitationBlock. This will be useful in the future for different types of fertilizer.
By default, it is disabled.
Home Block
If configured, a Homeblock may be placed which will reset the entity's Home location. The blocks listed here will set the entity's Home Position, allow it to patrol around it using the vanilla Territorial AI task
Starting Buffs
NPCs are controlled mainly through the buff system. The default buffs are listed on the entity class, and are used to start off its hunger / thirsty stats, it's sanitation stats, etc.
Names
Each entity may have one or more names, configured through the XML files. When the ntity is first spawned in, a name is randomly picked by the XML. The entity will be known as "Name the EntityName" in log files, along
with its entity ID.
This is the new base class, which inherits from EntityNPC and all the sub classes. It has new features, such as allowing them to be hired and execute your orders.
NPCs can accept orders by interacting with them and selecting one of pre-made options. Using a combination of XML dialog settings and code, some dialog options will not appear unless they make sense. For example,
when you first meet an NPC, you will not be able to give them orders.
NPCs can be hired either by paying their Hire Cost, completing a quest line, or have some sort of incenntive for them to follow.
Using the new Maslow AI Task, along with the buff system, NPCs can consume food and water.
Hiring NPCs
Each unique NPC can have its own hiring cost and currency, available through the XML properties. By default, this is 1000 casino Coins. The HireCurrency is any available Item, and that item will be removed
from your inventory when you hire them.
Examples
Default:
Code:
<property name="HireCost" value="1000"/>
<property name="HireCurrency" value="casinoCoin"/>
Code:
<property name="HireCost" value="1"/>
<property name="HireCurrency" value="BloomsFamilyHeirloom_1"/>Initially, unhired NPCs will only show a few options in the dialog. However, when they are hired, they can do more for you.
Orders
Code:
ShowMe - This displays information about the entity in a tool tip window, and in the console. This will show you their health, name, and hunger levels.
ShowAffection - This just displays a tool tip. TODO: have it positively impact the entity
FollowMe - The entity will follow you, keeping a distance of 3 to 5 spaces behind you. They'll try to match your walk and run speed.
Stayhere - The entity will stay in place
GuardHere - The entity will stand in your place, facing your initial direction. This will set the GuardPosition, allow the guard to return to that spot after a fight.
Wander - The entity will walk around the area
SetPatrol - The entity will begin following your foot steps, recording them as Patrol Coordinates
Patrol - The entity, if it has Patrol Coordinates, will begin tracing the coordinates back and forth. This option only shows if it has Patrol Coordinates
Hire - If unhired, the entity will allow you to hire them. Their cost depends on their XML settings.
OpenInventory - This will open their inventory
Loot - This tells the entity to Loot the POI you are in now.Here's a sample Dialog XML that show's the Hire option, if the NPC is not hired, and will show ShowMe and StayHere orders if it is hired.
Sample Dialog
Code:
<response id="Hire" text="I am interested in hiring you." >
<requirement type="HiredSDX, Mods" requirementtype="Hide" value="not"/>
<action type="OpenDialogSDX, Mods" id="Hire" />
</response>
<response id="FollowMe" text="Follow me" >
<requirement type="HiredSDX, Mods" requirementtype="Hide"/>
<action type="ExecuteCommandSDX, Mods" id="FollowMe" />
</response>
<response id="ShowMe" text="Show Me your inventory" >
<requirement type="HiredSDX, Mods" requirementtype="Hide" />
<action type="ExecuteCommandSDX, Mods" id="OpenInventory" />
</response>
<response id="StayHere" text="Stay here" >
<requirement type="HiredSDX, Mods" requirementtype="Hide" />
<action type="ExecuteCommandSDX, Mods" id="StayHere" />
</response>-------------------
The following AI tasks were used in testing well rounded NPCs. It is recommended taht you start off with this AI Tasks, and then customize as needed.
Code:
<property name="AITask-1" value="BreakBlock"/>
<property name="AITask-2" value="Territorial"/>
<property name="AITask-3" value="ApproachAndAttackSDX, Mods" param1="Entity,0" param2="" />
<property name="AITask-4" value="ApproachAndFollowTargetSDX, Mods" param1="Leader,foodCornOnTheCob"/>
<property name="AITask-5" value="PatrolSDX, Mods"/>
<property name="AITask-6" value="MaslowLevel1SDX, Mods"/>
<property name="AITask-7" value="Look"/>
<property name="AITask-8" value="WanderSDX, Mods"/>
<property name="AITask-9" value="" />
<property name="AITarget-1" value="SetAsTargetIfHurtSDX, Mods" param1="Entity"/>
<property name="AITarget-2" value="SetAsTargetIfLeaderAttackedSDX, Mods" param1="Entity"/>
<property name="AITarget-3" value="SetAsTargetNearestEnemySDX, Mods" param1="Entity,80"/>
<property name="AITarget-4" value="" />-------------------
Losely modelled around Maslow's Hierachy of Needs, the NPCs have requirements based on a combination of buffs and a new AI task. This buff is applied through the entityclass entry, and controls the NPCs' food and
drink requirements. Over time, the NPCs will get hungry and thirsty, and, using the EAIMaslowLevel1SDX class, will seek out food and water through its configuration.
Food and Water
NPCs will look for food and water through their configured bins. Triggered by the HungryBuffs and ThirstyBuffs, the AI task will seek out food and water as needed, and consume it. Once satisfied, it'll continue
to wander.
Code:
<!-- which containers to look for food in -->
<property name="FoodBins" value="cntSecureStorageChest,cntStorageChest" />
<!-- what it can drink out of -->
<property name="WaterBins" value="water,waterMoving,waterStaticBucket,waterMovingBucket,terrWaterPOI" />
<!-- Default thirsty and hungry buffs -->
<property name="ThirstyBuffs" value="buffStatusThirsty1,buffStatusThirsty2" />
<property name="HungryBuffs" value="buffStatusHungry1,buffStatusHungry2" />class initially, since some food items may not be have a food value, such as the hayBaleBlock. All foods satisfy the same amount of hunger.
Once an entity becomes too hungry or thirsty, it will start taking damage until it eventually dies.
Code:
<!-- Food items and bins that this entity will eat, if using the right AI Task -->
<property name="FoodItems" value="hayBaleBlock,resourceYuccaFibers,foodCropYuccaFruit,foodCornBread,foodCornOnTheCob,foodCornMeal,foodCropCorn,foodCropGraceCorn"/>As an optional feature, NPCs can be affected by a sanitation system. Over time, a sanitation level rises through a buff. Once this value reaches a threshold, the entity will need to use the bathroom. If
a bathroom is not available, they will do their business on the ground.
If sanitation is turned on, the entity will search for a ToiletBlocks that is nearby. If found, it will go to the ToiletBlock and reset its sanitation level. This is useful for NPCs, but might not work out so well for animals.
If an entity does not have a toilet block, it will eventually drop a SanitationBlock. This will be useful in the future for different types of fertilizer.
By default, it is disabled.
Code:
<property name="ToiletBlocks" value="cntToilet01,cntToilet02,cntToilet03" />
<property name="SanitationBlock" value="terrDirt" /> <!-- Poop block. If ToiletBlocks is configured, it'll use those rather than generate this block. -->If configured, a Homeblock may be placed which will reset the entity's Home location. The blocks listed here will set the entity's Home Position, allow it to patrol around it using the vanilla Territorial AI task
Code:
<!-- This is the block it'll call home -->
<property name="HomeBlocks" value="cntCowHomeBlock,hayBaleBlock"/>NPCs are controlled mainly through the buff system. The default buffs are listed on the entity class, and are used to start off its hunger / thirsty stats, it's sanitation stats, etc.
Code:
<!-- The starting buffs. Semi-colon delimited! Example for Animal Buffs -->
<property name="Buffs" value="buffAnimalStatusCheck;buffStatusCheck;buffAnimalBaby;buffSanitationStatusCheck;buffAnimalCow" />Each entity may have one or more names, configured through the XML files. When the ntity is first spawned in, a name is randomly picked by the XML. The entity will be known as "Name the EntityName" in log files, along
with its entity ID.
Code:
<property name="Names" value="Bully,Duke,Hydro,Homer,Earl,Disel,Horns,Armor,Bob,Sampson,Tank,Kristof,Angus,Midnight,Nitrous,Red Bull,Moogan Freeman,Meatloaf,T-Bone,Mooshu,Leonardo DiCowprio,Cheeseburger,LovaBull,Hugh Heifer,Moossolini,Grassyella,Moo Rock,Rick Raws The Sause Bause,SteakHouse" />sphereii
Survivor
EAITasks and EAITargets
The SDX_EAITasks class introduces new AI tasks for entities to perform. Some of the tasks were changed so they rely on entity factions, rather than specifying the enemies through their Entity classes.
EAIApproachAndFollowTargetSDX
This AI task is useful for getting followers, based on potential incentives.
Incentives can be a block name that you are holding, an item name that you are holding, a buff, or a CVar value. You do not need to specify which
type of incentive it is. The class will go through all the various combinations to try to identify which of your incentives is active.
For the cvar checks, it stored the EntityID of the target. For example, Leader is the one who has hired the entity, so it's the player.entityID. For Mother,
it's the entity ID of the mother that spawned it.
Parameters:
Param1: This parameter is the target's incentive
Param2: Not Used
Example Usage:
EAIPatrolSDX
This AI Task is useful for asking followers and NPCs to patrol a path for you, once they are hired.
To set a patrol task, the Order must be SetPatrol. By default, this is set through opening up a dialog chat by interacting with the NPC. Once SetPatrol is set, walk the path you want the entity to follow. The entity will record every step you make.
Once the path is set, interact with them again, and ask them to Patrol. They will turn around and retrace their steps to their starting position, and start looping back and forth until interrupted.
Parameters:
Param1: Not Used
Param2: Not Used
Example Usage:
EAIWanderSDX
This AI Task is useful for assigning to NPCs and animals alike. By default, the base Wander Ai task will begin attacking a block that is in front of it. The WanderSDX task stops the entity from wandering in the direction that its stuck in, rather than trying to break through. Very useful for farm animals that you don't want to break out of your fences.
Parameters:
Param1: Not Used
Param2: Not Used
Example Usage:
EAIMaslowLevel1SDX
This AI Task enables rules based on losely on Maslow laws. It allows the entity to react to its own stats, including seeking food and water if hungry or thirsty, sanitation needs, and even farm-animal production, such as laying an egg or producing milk from a cow.
Parameters:
Param1: Not Used
Param2: Not Used
Example Usage:
EAILootLocationSDX
This AI task is useful for assinging to NPCs who will help you loot a POI with you. They will scan for all the loot containers in the bounds of a prefab, and start searching them. You may intereact with the NPC and ask to see their Inventory to see what they have picked up.
This is experimental, and not recommended.
Parameters:
Param1: Not Used
Param2: Not Used
Example Usage:
EAISetAsTargetIfHurtSDX
This AI Target helps assign whether there is an revenge target if something attacks it. However, if its your leader, you forgive them...
Parameters:
Param1: Vanille: This sets a filter based on what type of Entity is allowed to be targetted.
Param2: Not Used
Example Usage:
EAISetAsTargetIfLeaderAttackedSDX
This AI Target helps assign whether the Leader, if assigned, is being attacked and if they should become the attack target of the entity.
Parameters:
Param1: Vanille: This sets a filter based on what type of Entity is allowed to be targetted.
Param2: Not Used
Example Usage:
EAISetAsTargetNearestEnemySDX
This AI Target helps assign whether any entities that are close by belong to an enemy faction, and attacks accordingly.
Parameters:
Param1: Vanille: This sets a filter based on what type of Entity is allowed to be targetted.
Param2: Not Used
Example Usage:
The SDX_EAITasks class introduces new AI tasks for entities to perform. Some of the tasks were changed so they rely on entity factions, rather than specifying the enemies through their Entity classes.
EAIApproachAndFollowTargetSDX
This AI task is useful for getting followers, based on potential incentives.
Incentives can be a block name that you are holding, an item name that you are holding, a buff, or a CVar value. You do not need to specify which
type of incentive it is. The class will go through all the various combinations to try to identify which of your incentives is active.
For the cvar checks, it stored the EntityID of the target. For example, Leader is the one who has hired the entity, so it's the player.entityID. For Mother,
it's the entity ID of the mother that spawned it.
Parameters:
Param1: This parameter is the target's incentive
Param2: Not Used
Example Usage:
Code:
<property name="AITask-4" value="ApproachAndFollowTargetSDX, Mods" param1="Mother,Leader,hayBaleBlock,foodCornOnTheCob"/>This AI Task is useful for asking followers and NPCs to patrol a path for you, once they are hired.
To set a patrol task, the Order must be SetPatrol. By default, this is set through opening up a dialog chat by interacting with the NPC. Once SetPatrol is set, walk the path you want the entity to follow. The entity will record every step you make.
Once the path is set, interact with them again, and ask them to Patrol. They will turn around and retrace their steps to their starting position, and start looping back and forth until interrupted.
Parameters:
Param1: Not Used
Param2: Not Used
Example Usage:
Code:
<property name="AITask-3" value="PatrolSDX, Mods"/>This AI Task is useful for assigning to NPCs and animals alike. By default, the base Wander Ai task will begin attacking a block that is in front of it. The WanderSDX task stops the entity from wandering in the direction that its stuck in, rather than trying to break through. Very useful for farm animals that you don't want to break out of your fences.
Parameters:
Param1: Not Used
Param2: Not Used
Example Usage:
Code:
<property name="AITask-9" value="WanderSDX, Mods"/>This AI Task enables rules based on losely on Maslow laws. It allows the entity to react to its own stats, including seeking food and water if hungry or thirsty, sanitation needs, and even farm-animal production, such as laying an egg or producing milk from a cow.
Parameters:
Param1: Not Used
Param2: Not Used
Example Usage:
Code:
<property name="AITask-7" value="MaslowLevel1SDX, Mods"/>This AI task is useful for assinging to NPCs who will help you loot a POI with you. They will scan for all the loot containers in the bounds of a prefab, and start searching them. You may intereact with the NPC and ask to see their Inventory to see what they have picked up.
This is experimental, and not recommended.
Parameters:
Param1: Not Used
Param2: Not Used
Example Usage:
Code:
<property name="AITarget-5" value="LootLocationSDX, Mods" />This AI Target helps assign whether there is an revenge target if something attacks it. However, if its your leader, you forgive them...
Parameters:
Param1: Vanille: This sets a filter based on what type of Entity is allowed to be targetted.
Param2: Not Used
Example Usage:
Code:
<property name="AITarget-1" value="SetAsTargetIfHurtSDX, Mods" param1="Entity"/> <!-- Anything that attakcs it, can be attacked back -->This AI Target helps assign whether the Leader, if assigned, is being attacked and if they should become the attack target of the entity.
Parameters:
Param1: Vanille: This sets a filter based on what type of Entity is allowed to be targetted.
Param2: Not Used
Example Usage:
Code:
<property name="AITarget-3" value="SetAsTargetIfLeaderAttackedSDX, Mods" param1="Entity"/> <!-- Anything that attakcs the leader, can be attacked back -->This AI Target helps assign whether any entities that are close by belong to an enemy faction, and attacks accordingly.
Parameters:
Param1: Vanille: This sets a filter based on what type of Entity is allowed to be targetted.
Param2: Not Used
Example Usage:
Code:
<property name="AITarget-4" value="SetAsTargetNearestEnemySDX, Mods" param1="Entity"/> <!-- It will attack anything it hates, as defined by the NPC factions -->sphereii
Survivor
Spawn From Entity
This class attempts to provide an entity spawning mechanism based on an entity. Rather than using the block spawner, this entity will spawn in a specified group of entities, assign a leader to them. It's designed to be a Herd or Bandit / NPC group spawner
EntityAliveEventSpawnerSDX
This Entity class has a SpawnSettings class, that has properties for Leader and Follower entities. The Leader will spawn in first, then the Followers will spawn in, assigning their Leader ID to Leader entity. This will
cause the followers to follow their leader, and treat them as such. If the leader gets attacked, for example, the followers will defend it.
Properties:
Example Usage:
This class attempts to provide an entity spawning mechanism based on an entity. Rather than using the block spawner, this entity will spawn in a specified group of entities, assign a leader to them. It's designed to be a Herd or Bandit / NPC group spawner
EntityAliveEventSpawnerSDX
This Entity class has a SpawnSettings class, that has properties for Leader and Follower entities. The Leader will spawn in first, then the Followers will spawn in, assigning their Leader ID to Leader entity. This will
cause the followers to follow their leader, and treat them as such. If the leader gets attacked, for example, the followers will defend it.
Properties:
Code:
Leader: This specifies which entity will be the leader.
value: This is either a single entity name, or multiple ones, separated by commas. Note: There can only be one leader.
Followers: This specifies the follow entities in its value attribute. The value for follower may also be a single entitygroup reference, rather than entity class.
Param1: Param1 is used in the name="Follower-*" to determine how many entities to spawn
Code:
<entity_class name="invisibleCowHerdSpawner">
<property name="Mesh" value="Gore/gore_block1_bonesPrefab"/>
<property name="ModelType" value="Custom"/>
<property name="Prefab" value="Backpack"/>
<property name="Class" value="EntityAliveEventSpawnerSDX, Mods"/>
<property name="Parent" value="Animals"/>
<property name="TimeStayAfterDeath" value="1"/>
<property name="IsEnemyEntity" value="false"/>
<property name="LootListOnDeath" value="4"/>
<property name="Faction" value="animals"/>
<property class="SpawnSettings" >
<property name="Leader" value="animalBull" />
<property name="Followers" value="animalCow,animalCow,animalCow,animalCow" />
</property>
</entity_class>
<entity_class name="invisibleCowHerdSpawner2">
<property name="Mesh" value="Gore/gore_block1_bonesPrefab"/>
<property name="ModelType" value="Custom"/>
<property name="Prefab" value="Backpack"/>
<property name="Class" value="EntityAliveEventSpawnerSDX, Mods"/>
<property name="Parent" value="Animals"/>
<property name="TimeStayAfterDeath" value="1"/>
<property name="IsEnemyEntity" value="false"/>
<property name="LootListOnDeath" value="4"/>
<property name="Faction" value="animals"/>
<property class="SpawnSettings" >
<property name="Leader" value="animalBull" />
<property name="Followers" value="animalCow" param1="2,4"/> <!-- entity with a range -->
</property>
</entity_class>