Denizen config.yml: Difference between revisions

From Citizens Wiki

No edit summary
No edit summary
Line 1: Line 1:
Below is the stock copy of the Denizen config.yml. Remember: Denizen does not write its own config, so one should be placed by hand. The easiest way to do that is by using the [[Start-Up Kit]].
<quote>The Denizen config.yml contains nodes to alter the stock behavior and look of Denizen. You'll notice that Denizen does not create its own config.yml. Why is this? Denizen stores its entire config inside memory, so it's not necessary to have a copy inside the Denizen folder unless you need to change the defaults. You can use the config.yml to override those defaults. Not having Denizen write to the config.yml itself (as well as scripts files) ensures that upon a /denizen reload, the config.yml, between a save and reload, is never changed when you don't want it to. This also keeps code comments inside the YML files stay intact, exactly the way you left them from last edit allowing you to leave yourself and others detailed notes and ideas.
This file can be reloaded from disk to Denizen memory at any time by using /denizen reload. Some changes in the config.yml may require a restart of the server. This includes interact_delay_in_ticks, but is not limited to that config node.
</quote>


{{codebox|height=300px|Default Denizen config.yml|<syntaxhighlight lang="yaml">
{{codebox|height=300px|Default Denizen config.yml|<syntaxhighlight lang="yaml">
Line 6: Line 8:
right_click_and_sneak_info_mode_enabled: true
right_click_and_sneak_info_mode_enabled: true


# Default time in seconds of cooldown set to Denizens when a trigger is triggered.
# Interact delay sets the pace of the 'Player Queue' and 'Denizen Queue'
default_click_cooldown_in_seconds: 2.0
# execution, which is where commands triggered by scripts are stored.
default_location_cooldown_in_seconds: 30.0
# Recommend 10-20.
default_proximity_cooldown_in_seconds: 15.0
default_death_cooldown_in_seconds: 0.0
default_damage_cooldown_in_seconds: 0.5
default_chat_cooldown_in_seconds: 2.0
 
# Denizen by default uses both right and left clicks to activate the click trigger
# if the damage trigger (left click) is disabled. Select false if you would prefer
# to have click triggers activate with the right mouse button only.
disabled_damage_trigger_instead_triggers_click: true
 
# Interact delay sets the pace of the 'Player Queues' execution,  
# which is where commands entries triggered by scripts are stored.
# Recommended setting is 5-15.
interact_delay_in_ticks: 10
interact_delay_in_ticks: 10
# Default engage timeout. When NPCs are set to ENGAGE, this is the default timeout
# that they DISENGAGE if not specified. (Default, 5 minutes)
engage_timeout_in_seconds: 150


# How long should the maximum line length be for multi-line text?
# How long should the maximum line length be for multi-line text?
multi_line_text_maximum_length: 55
multi_line_text_maximum_length: 55
# By default, players can talk to Denizens even if there are no
# chat triggers in the script. I believe this is best for RPG-type
# behavior. Change this to true if you would like chat near a
# Denizen to be global if there are no chat triggers for the
# script being triggered.
chat_globally_if_no_chat_triggers: false


# By default, players can talk to Denizens even if there are no
# By default, players can talk to Denizens even if there are no
Line 52: Line 30:
# triggers, but the player failed to match one.
# triggers, but the player failed to match one.
chat_globally_if_failed_chat_triggers: false
chat_globally_if_failed_chat_triggers: false
# Also.. if the Denizen happens to be un-interactable
# (Engaged, or not cooled-down, for instance), by default
# chat is still targeted to the NPC. You can turn this
# behavior off by changing this config node to true.
chat_globally_if_not_interactable: false


# Should players around the player interacting with the Denizen
# Should players around the player interacting with the Denizen
Line 73: Line 45:
player_to_npc_whisper_range_in_blocks: 2
player_to_npc_whisper_range_in_blocks: 2
npc_to_player_whisper_range_in_blocks: 3
npc_to_player_whisper_range_in_blocks: 3
proximity_trigger_range_in_blocks: 3
location_trigger_range_in_blocks: 1


# These nodes define how chatting, shouting, etc. is displayed
# These nodes define how chatting, shouting, etc. is displayed
Line 100: Line 70:
# Default texts that Denizens use when interacting. These
# Default texts that Denizens use when interacting. These
# can also be set per-denizen, which will override the
# can also be set per-denizen, which will override the
# defaults set below. See the Wiki for more information.
# defaults set below.
default_denizen_unavailable_text: "I'm busy at the moment, can't you see?"
default_no_requirements_met_text: Sorry, I have nothing else for you right now.
default_no_click_trigger_text: "I have nothing else for you right now."
default_no_damage_trigger_text: "Ouch! That hurts!"
default_no_chat_trigger_text: "Sorry, I don't understand."
</syntaxhighlight>
</syntaxhighlight>
}}
}}

Revision as of 18:20, 8 August 2012

<quote>The Denizen config.yml contains nodes to alter the stock behavior and look of Denizen. You'll notice that Denizen does not create its own config.yml. Why is this? Denizen stores its entire config inside memory, so it's not necessary to have a copy inside the Denizen folder unless you need to change the defaults. You can use the config.yml to override those defaults. Not having Denizen write to the config.yml itself (as well as scripts files) ensures that upon a /denizen reload, the config.yml, between a save and reload, is never changed when you don't want it to. This also keeps code comments inside the YML files stay intact, exactly the way you left them from last edit allowing you to leave yourself and others detailed notes and ideas. This file can be reloaded from disk to Denizen memory at any time by using /denizen reload. Some changes in the config.yml may require a restart of the server. This includes interact_delay_in_ticks, but is not limited to that config node. </quote>


Code: Default Denizen config.yml
{{{2}}}
Retrieved from ‘https://wiki.citizensnpcs.co/index.php?title=Denizen_config.yml&oldid=1968’