User:Button/BAMM - Revision history

Button: /* Button's Workspace */ docstrings

2015-07-31T22:05:52Z

Button's Workspace: docstrings

Show changes

Button: /* Button's Workspace */

2015-07-30T22:33:42Z

Button's Workspace

Button: /* Button's Workspace */

2015-07-30T22:33:24Z

Button's Workspace

Button: /* Button's Workspace */

2015-06-08T05:04:37Z

Button's Workspace

Show changes

Button: /* Button's Workspace */

2015-06-05T21:50:18Z

Button's Workspace

Show changes

Button at 22:17, 2 June 2015

2015-06-02T22:17:10Z

Button: /* Button's Workspace */

2015-06-01T22:19:39Z

Button's Workspace

Show changes

Button: /* Button's Workspace */ Came up with a solution for the GROWTH_PRINT $,$ vs $,& problem

2015-05-28T17:16:12Z

Button's Workspace: Came up with a solution for the GROWTH_PRINT $,$ vs $,& problem

Button: Created page with "== About == === Features === === Planned Features === == Usage Instructions == === Download === You can [https://github.com/BoomButton/DF-BAMM download the script] from G..."

2015-05-22T19:28:41Z

Created page with "== About == === Features === === Planned Features === == Usage Instructions == === Download === You can [https://github.com/BoomButton/DF-BAMM download the script] from G..."

New page

== About ==

=== Features ===

=== Planned Features ===

== Usage Instructions ==

=== Download ===

You can [https://github.com/BoomButton/DF-BAMM download the script] from GitHub.

=== Python 3 ===

=== Configuration ===

== Button's Workspace ==

Sometimes I'm on a computer I can't put a git client on.

<pre>class TreeNode():
"""Parent class for the other Node classes.

Contains default implementations of common Tree functionality.

Members:
self._parent = the parent TreeNode of this TreeNode. Any given subclass of TreeNode should only have TreeNodes of its own type as _parent.
self._tag = The string that this node represents. This should be overridden and re-defined by subclasses.
self._children = A dict of type string:TreeNode, where the key is the child's ._tag property.

Functions:
self.__init__(self,parent=None)
"""

def __init__(self,parent=None):
"""Create a TreeNode.

Sets self._parent to argument parent, initializes an empty dict for self._children, and sets self._tag = None.
"""
self._parent = parent
self._children = {}
self._tag = None
#if parent != None:
# parent.add_child(self)

def add_child(self, child_node):
"""Add a child to this TreeNode."""
self._children[child_node._tag] = child_node

def find_match(self, tag):
"""Find a TreeNode related to this TreeNode which has the given tag.

tag is a value corresponding to the ._tag field of TreeNode you're calling this on. REMEMBER: Different TreeNode subclasses have different formats of ._tags!

The return value is a TreeNode with the specified ._tag value, or None.

The TreeNodes searched are this node's immediate children, and its direct ancestors' immediate children.
"""
curr_node = self
matching_node = None
out_of_parents = False
while matching_node is None and not out_of_parents:
#matching_node = curr_node.get_template_match(tag)[0]
#if matching_node == None:
matching_node = curr_node.get_child(tag)
if curr_node._parent is None:
out_of_parents = True
else:
curr_node = curr_node._parent
return matching_node

def get_child(self, tag):
"""Return an immediate child with the given tag, or None if no such child exists."""
if tag in self._children.keys():
return self._children[tag]
else:
return None

class TemplateNode(TreeNode):
"""An implementation of TreeNode specialized for holding tag templates.

Members:
self._parent = the parent TemplateNode of this TemplateNode.
self._tag = the string representing a valid format of raw tag. Literals are themselves; colons separate tokens; $s indicate identifiers; ?s indicate graphics information; and &s indicate non-identifier, non-graphics information. For more fluidly-formatted tags, the following format indicates more than one tag:
x(#,#) , where the x is a $, ? or &, the #s are a min/max pair, and the max is optional. See templates.config
self._is_graphics_tag = The template config file is formatted in such a way that which tags are graphics tags is straightforward. This is a bool retaining that information. It is set to False by default, then later set to True where appropriate by the template loading function.
self._
"""</pre>

@@ Line 19: / Line 19: @@
 Sometimes I'm on a computer I can't put a git client on.
-# Modders' guide to BAMM! graphics references
+<pre># Modders' guide to BAMM! graphics references
 # Place your conversions in a file named bamm_gfx_<identifier here>.txt . The file should be encoded in codepage 437, the same as the Dwarf Fortress raws.
@@ Line 88: / Line 88: @@
 		else:
 			# Get a collection of all the targets that meet the reference

← Older revision		Revision as of 22:33, 30 July 2015
Line 18:		Line 18:

	Sometimes I'm on a computer I can't put a git client on.		Sometimes I'm on a computer I can't put a git client on.
		+
		+	# Modders' guide to BAMM! graphics references
		+	# Place your conversions in a file named bamm_gfx_<identifier here>.txt . The file should be encoded in codepage 437, the same as the Dwarf Fortress raws.
		+
		+	# Start by defining names for your target graphics elements.
		+	# These names must always start with @.
		+	# So if you want to reference the background color being used for the Lion creature token, you can do that with this definition:
		+	# CREATURE:LION\|COLOR::@lionbgcolor
		+	# or
		+	# CREATURE:LION\|COLOR::@lionbgcolor:
		+	# If you want to reference the whole color of the lion tile, which is a 3-argument value, you can add a number after the @, like this:
		+	# CREATURE:LION\|COLOR:@3lionfullcolor
		+	# Or you can declare references for each argument of the lion color individually:
		+	# CREATURE:LION\|COLOR:@lionfgcolor:@lionbgcolor:@lionbrightness
		+
		+	# The name is case-sensitive and can contain any character in the alphabet. Numbers are not allowed except immediately after the @. Special characters, including underscores, are not allowed.
		+
		+	# You can also create generic all-graphics-belonging-to-this-object referents this way:
		+	# CREATURE:LION\|@allLionTags
		+
		+	# BE AWARE: trying to define non-graphics or partially non-graphic referents won't work. Referent declarations which include non-graphic information will simply be ignored.
		+
		+	# OK, now that we have our referents, it's time to use them to modify raws.
		+
		+	# creature_modded.txt
		+	# [CREATURE:MODDED_LION]
		+	# @allLionTags
		+
		+	# This sets all of the modded lion's graphics equal to the lion's graphics, in any graphics set.
		+	# However, this "copy all" functionality couldn't be used to set properties belonging to a non-creature object:
		+
		+	# [INORGANIC:LIONSTONE] This won't work
		+	# @allLionTags This won't work
		+
		+	# In order to make lionstone the color of a lion, you'll need to reference the colors instead:
		+	# [INORGANIC:LIONSTONE]
		+	# [DISPLAY_COLOR:@3lionfullcolor]
		+
		+	# NB. References are always made to graphics as declared in the graphics source raws. If you declare a lion to use a deer's graphics, and a deer to use a lion's graphics, they'll swap, not have the same graphics.
		+
		+	# Eventually I intend to expand this to include the ability to apply these changes based on the properties of entries, but right now, this should be enough.
		+
		+	# TODO docstring
		+	def handle_graphics_references(graphics_root,def_file):
		+	# Runs after the graphics source has been pulled in
		+	# Modifies same
		+	global graphics_referents
		+	if graphics_refs is None:
		+	graphics_refs = [] # This is meant to be a dict, check syntax
		+	definitions_over_yet = False
		+	for line in def_file:
		+	actline = line.split('#')[0].strip()
		+	if len(actline) == 0:
		+	continue
		+	elif actline == defs_over # TODO declare this as a constant
		+	definitions_over_yet = True
		+	elif not definitions_over_yet:
		+	# load referent definition
		+	# If the referent name already exists in graphics_refs, write an error to the log and continue to the next line.
		+	# Otherwise, match it against a template
		+	# Then match it against the GRAPHICS NODES that meet that template
		+	# Not the bound node or the target node.
		+	# (TODO make each template node hold lists of objects that refer to it, by function.)
		+	# If a partial definition matches more than one object, keep track of all of them so they can be narrowed down later
		+	# If a full definition matches more than one object, write a warning to the logfile and choose one arbitrarily to go with.
		+	# If a full definition matches no graphics object, write a warning to the log and try it on target objects.
		+	# If a full definition matches neither graphics nor target, write an error to the log.
		+	# Put the mapping of referent name to an object storing the reference info into graphics_refs
		+	else:
		+	# Get a collection of all the targets that meet the reference

@@ Line 59: / Line 59: @@
          for item in properties[propname]:
              userlog.debug("\t%s", item)
 # TODO implement parameters with defaults (and update docstring)
@@ Line 90: / Line 89: @@
      modderslog.addHandler(modderhandler)
      modderslog.setLevel(logging.INFO)
 def _property_has_format_error(propkey, value):
@@ Line 106: / Line 104: @@
 	Otherwise, returns False.
 	"""
 </pre>

← Older revision		Revision as of 17:16, 28 May 2015
Line 87:		Line 87:
	self._		self._
	"""</pre>		"""</pre>
		+
		+	<pre>
		+	OBJECT:PLANT\|PLANT:$\|GROWTH:$\|GROWTH_PRINT:?(5,5):$(2,2):&(0,1)
		+	OBJECT:PLANT\|PLANT:$\|GROWTH:$\|GROWTH_PRINT:?(5,5):ALL:&(0,1)
		+	OBJECT:PLANT\|PLANT:$\|GROWTH:$\|GROWTH_PRINT:?(5,5):NONE:&(0,1)
		+
		+	def get_best_match(template_tokens_bag):
		+	if not template_tokens_bag: # empty bag returns false
		+	return None
		+	elif len(template_tokens_bag) == 1:
		+	return template_tokens_bag[0]
		+	else:
		+	best_currently = template_tokens_bag[0]
		+	best_tokens = 0
		+	for tag in template_tokens_bag:
		+	challenger_tokens = 0
		+	for token in tag:
		+	if token != '?' and token != '&' and token != '$':
		+	challenger_tokens = challenger-tokens + 1
		+	if challenger_tokens > best_tokens:
		+	best_currently = tag
		+	best_tokens = challenger_tokens
		+	return best_currently
		+
		+	</pre>