def res_cust_fizzler(base_inst: Entity, res: Property):
"""Customises the various components of a custom fizzler item.
This should be executed on the base instance. Brush and MakeLaserField
are not permitted on laserfield barriers.
When executed, the $is_laser variable will be set on the base.
Options:
* ModelName: sets the targetname given to the model instances.
* UniqueModel: If true, each model instance will get a suffix to
allow unique targetnames.
* Brush: A brush entity that will be generated (the original is
deleted.) This cannot be used on laserfields.
* Name is the instance name for the brush
* Left/Right/Center/Short/Nodraw are the textures used
* Keys are a block of keyvalues to be set. Targetname and
Origin are auto-set.
* Thickness will change the thickness of the fizzler if set.
By default it is 2 units thick.
* Outputs is a block of outputs (laid out like in VMFs). The
targetnames will be localised to the instance.
* MergeBrushes, if true will merge this brush set into one
entity for each fizzler. This is useful for non-fizzlers to
reduce the entity count.
* SimplifyBrush, if true will merge the three parts into one brush.
All sides will receive the "nodraw" texture at 0.25 scale.
* MaterialModify generates material_modify_controls to control
the brush. One is generated for each texture used in the brush.
This has subkeys 'name' and 'var' - the entity name and shader
variable to be modified. MergeBrushes must be enabled if this
is present.
* MakeLaserField generates a brush stretched across the whole
area.
* Name, keys and thickness are the same as the regular Brush.
* Texture/Nodraw are the textures.
* Width is the pixel width of the laser texture, used to
scale it correctly.
"""
model_name = res['modelname', None]
make_unique = res.bool('UniqueModel')
fizz_name = base_inst['targetname', '']
# search for the model instances
model_targetnames = (
fizz_name + '_modelStart',
fizz_name + '_modelEnd',
)
is_laser = False
for inst in vbsp.VMF.by_class['func_instance']:
if inst['targetname'] in model_targetnames:
if inst.fixup['skin', '0'] == '2':
is_laser = True
if model_name is not None:
if model_name == '':
inst['targetname'] = base_inst['targetname']
else:
inst['targetname'] = (base_inst['targetname'] + '-' +
model_name)
if make_unique:
inst.make_unique()
for key, value in base_inst.fixup.items():
inst.fixup[key] = value
base_inst.fixup['$is_laser'] = is_laser
new_brush_config = list(res.find_all('brush'))
if len(new_brush_config) == 0:
return # No brush modifications
if is_laser:
# This is a laserfield! We can't edit those brushes!
LOGGER.warning('CustFizzler executed on LaserField!')
return
# Record which materialmodify controls are used, so we can add if needed.
# Conf id -> (brush_name, conf, [textures])
modify_controls = {}
for orig_brush in (vbsp.VMF.by_class['trigger_portal_cleanser']
& vbsp.VMF.by_target[fizz_name + '_brush']):
orig_brush.remove()
for config in new_brush_config:
new_brush = orig_brush.copy()
# Unique to the particular config property & fizzler name
conf_key = (id(config), fizz_name)
if config.bool('SimplifyBrush'):
# Replace the brush with a simple one of the same size.
bbox_min, bbox_max = new_brush.get_bbox()
new_brush.solids = [
vbsp.VMF.make_prism(
bbox_min,
bbox_max,
mat=const.Tools.NODRAW,
).solid
]
should_merge = config.bool('MergeBrushes')
if should_merge and conf_key in FIZZ_BRUSH_ENTS:
# These are shared by both ents, but new_brush won't be added to
# the map. (We need it though for the widening code to work).
FIZZ_BRUSH_ENTS[conf_key].solids.extend(new_brush.solids)
else:
vbsp.VMF.add_ent(new_brush)
# Don't allow restyling it
vbsp.IGNORED_BRUSH_ENTS.add(new_brush)
new_brush.clear_keys() # Wipe the original keyvalues
new_brush['origin'] = orig_brush['origin']
new_brush['targetname'] = conditions.local_name(
base_inst,
config['name'],
)
# All ents must have a classname!
new_brush['classname'] = 'trigger_portal_cleanser'
conditions.set_ent_keys(
new_brush,
base_inst,
config,
)
for out_prop in config.find_children('Outputs'):
out = Output.parse(out_prop)
out.comma_sep = False
out.target = conditions.local_name(base_inst, out.target)
new_brush.add_out(out)
if should_merge: # The first brush...
FIZZ_BRUSH_ENTS[conf_key] = new_brush
mat_mod_conf = config.find_key('MaterialModify', [])
if mat_mod_conf:
try:
used_materials = modify_controls[id(mat_mod_conf)][2]
except KeyError:
used_materials = set()
modify_controls[id(mat_mod_conf)] = (
new_brush['targetname'], mat_mod_conf, used_materials)
# It can only parent to one brush, so it can't attach
# to them all properly.
if not should_merge:
raise Exception(
"MaterialModify won't work without MergeBrushes!")
else:
used_materials = None
laserfield_conf = config.find_key('MakeLaserField', None)
if laserfield_conf.value is not None:
# Resize the brush into a laserfield format, without
# the 128*64 parts. If the brush is 128x128, we can
# skip the resizing since it's already correct.
laser_tex = laserfield_conf['texture',
const.Special.LASERFIELD]
nodraw_tex = laserfield_conf['nodraw', const.Tools.NODRAW]
tex_width = laserfield_conf.int('texwidth', 512)
is_short = False
for side in new_brush.sides():
if side == const.Fizzler.SHORT:
is_short = True
break
if is_short:
for side in new_brush.sides():
if side == const.Fizzler.SHORT:
side.mat = laser_tex
side.uaxis.offset = 0
side.scale = 0.25
else:
side.mat = nodraw_tex
else:
# The hard part - stretching the brush.
convert_to_laserfield(
new_brush,
laser_tex,
nodraw_tex,
tex_width,
)
if used_materials is not None:
used_materials.add(laser_tex.casefold())
else:
# Just change the textures
for side in new_brush.sides():
try:
tex_cat = TEX_FIZZLER[side.mat.casefold()]
side.mat = config[tex_cat]
except (KeyError, IndexError):
# If we fail, just use the original textures
pass
else:
if used_materials is not None and tex_cat != 'nodraw':
used_materials.add(side.mat.casefold())
widen_amount = config.float('thickness', 2.0)
if widen_amount != 2:
for brush in new_brush.solids:
conditions.widen_fizz_brush(
brush,
thickness=widen_amount,
)
for brush_name, config, textures in modify_controls.values():
skip_if_static = config.bool('dynamicOnly', True)
if skip_if_static and base_inst.fixup['$connectioncount'] == '0':
continue
mat_mod_name = config['name', 'modify']
var = config['var', '$outputintensity']
if not var.startswith('$'):
var = '$' + var
for tex in textures:
vbsp.VMF.create_ent(
classname='material_modify_control',
origin=base_inst['origin'],
targetname=conditions.local_name(base_inst, mat_mod_name),
materialName='materials/' + tex + '.vmt',
materialVar=var,
parentname=brush_name,
)
def res_cust_fizzler(base_inst, res):
"""Customises the various components of a custom fizzler item.
This should be executed on the base instance. Brush and MakeLaserField
are ignored on laserfield barriers.
Options:
* ModelName: sets the targetname given to the model instances.
* UniqueModel: If true, each model instance will get a suffix to
allow unique targetnames.
* Brush: A brush entity that will be generated (the original is
deleted.)
* Name is the instance name for the brush
* Left/Right/Center/Short/Nodraw are the textures used
* Keys are a block of keyvalues to be set. Targetname and
Origin are auto-set.
* Thickness will change the thickness of the fizzler if set.
By default it is 2 units thick.
* MakeLaserField generates a brush stretched across the whole
area.
* Name, keys and thickness are the same as the regular Brush.
* Texture/Nodraw are the textures.
* Width is the pixel width of the laser texture, used to
scale it correctly.
"""
model_name = res['modelname', None]
make_unique = utils.conv_bool(res['UniqueModel', '0'])
fizz_name = base_inst['targetname', '']
# search for the model instances
model_targetnames = (
fizz_name + '_modelStart',
fizz_name + '_modelEnd',
)
is_laser = False
for inst in vbsp.VMF.by_class['func_instance']:
if inst['targetname', ''] in model_targetnames:
if inst.fixup['skin', '0'] == '2':
is_laser = True
if model_name is not None:
if model_name == '':
inst['targetname'] = base_inst['targetname']
else:
inst['targetname'] = (
base_inst['targetname'] +
'-' +
model_name
)
if make_unique:
inst.make_unique()
for key, value in base_inst.fixup.items():
inst.fixup[key] = value
new_brush_config = list(res.find_all('brush'))
if len(new_brush_config) == 0:
return # No brush modifications
if is_laser:
# This is a laserfield! We can't edit those brushes!
LOGGER.warning('CustFizzler excecuted on LaserField!')
return
for orig_brush in (
vbsp.VMF.by_class['trigger_portal_cleanser'] &
vbsp.VMF.by_target[fizz_name + '_brush']):
orig_brush.remove()
for config in new_brush_config:
new_brush = orig_brush.copy()
vbsp.VMF.add_ent(new_brush)
# Don't allow restyling it
vbsp.IGNORED_BRUSH_ENTS.add(new_brush)
new_brush.clear_keys() # Wipe the original keyvalues
new_brush['origin'] = orig_brush['origin']
new_brush['targetname'] = (
fizz_name +
'-' +
config['name', 'brush']
)
# All ents must have a classname!
new_brush['classname'] = 'trigger_portal_cleanser'
conditions.set_ent_keys(
new_brush, base_inst,
config,
)
laserfield_conf = config.find_key('MakeLaserField', None)
if laserfield_conf.value is not None:
# Resize the brush into a laserfield format, without
# the 128*64 parts. If the brush is 128x128, we can
# skip the resizing since it's already correct.
laser_tex = laserfield_conf['texture', 'effects/laserplane']
nodraw_tex = laserfield_conf['nodraw', 'tools/toolsnodraw']
tex_width = utils.conv_int(
laserfield_conf['texwidth', '512'], 512
)
is_short = False
for side in new_brush.sides():
if side.mat.casefold() == 'effects/fizzler':
is_short = True
break
if is_short:
for side in new_brush.sides():
if side.mat.casefold() == 'effects/fizzler':
side.mat = laser_tex
side.uaxis.offset = 0
side.scale = 0.25
else:
side.mat = nodraw_tex
else:
# The hard part - stretching the brush.
convert_to_laserfield(
new_brush,
laser_tex,
nodraw_tex,
tex_width,
)
else:
# Just change the textures
for side in new_brush.sides():
try:
side.mat = config[
TEX_FIZZLER[side.mat.casefold()]
]
except (KeyError, IndexError):
# If we fail, just use the original textures
pass
widen_amount = utils.conv_float(config['thickness', '2'], 2.0)
if widen_amount != 2:
for brush in new_brush.solids:
conditions.widen_fizz_brush(
brush,
thickness=widen_amount,
)
def res_cust_fizzler(base_inst: Entity, res: Property):
"""Customises the various components of a custom fizzler item.
This should be executed on the base instance. Brush and MakeLaserField
are not permitted on laserfield barriers.
When executed, the $is_laser variable will be set on the base.
Options:
* ModelName: sets the targetname given to the model instances.
* UniqueModel: If true, each model instance will get a suffix to
allow unique targetnames.
* Brush: A brush entity that will be generated (the original is
deleted.) This cannot be used on laserfields.
* Name is the instance name for the brush
* Left/Right/Center/Short/Nodraw are the textures used
* Keys are a block of keyvalues to be set. Targetname and
Origin are auto-set.
* Thickness will change the thickness of the fizzler if set.
By default it is 2 units thick.
* Outputs is a block of outputs (laid out like in VMFs). The
targetnames will be localised to the instance.
* MergeBrushes, if true will merge this brush set into one
entity for each fizzler. This is useful for non-fizzlers to
reduce the entity count.
* SimplifyBrush, if true will merge the three parts into one brush.
All sides will receive the "nodraw" texture at 0.25 scale.
* MaterialModify generates material_modify_controls to control
the brush. One is generated for each texture used in the brush.
This has subkeys 'name' and 'var' - the entity name and shader
variable to be modified. MergeBrushes must be enabled if this
is present.
* MakeLaserField generates a brush stretched across the whole
area.
* Name, keys and thickness are the same as the regular Brush.
* Texture/Nodraw are the textures.
* Width is the pixel width of the laser texture, used to
scale it correctly.
"""
model_name = res['modelname', None]
make_unique = res.bool('UniqueModel')
fizz_name = base_inst['targetname', '']
# search for the model instances
model_targetnames = (
fizz_name + '_modelStart',
fizz_name + '_modelEnd',
)
is_laser = False
for inst in vbsp.VMF.by_class['func_instance']:
if inst['targetname'] in model_targetnames:
if inst.fixup['skin', '0'] == '2':
is_laser = True
if model_name is not None:
if model_name == '':
inst['targetname'] = base_inst['targetname']
else:
inst['targetname'] = (
base_inst['targetname'] +
'-' +
model_name
)
if make_unique:
inst.make_unique()
for key, value in base_inst.fixup.items():
inst.fixup[key] = value
base_inst.fixup['$is_laser'] = is_laser
new_brush_config = list(res.find_all('brush'))
if len(new_brush_config) == 0:
return # No brush modifications
if is_laser:
# This is a laserfield! We can't edit those brushes!
LOGGER.warning('CustFizzler executed on LaserField!')
return
# Record which materialmodify controls are used, so we can add if needed.
# Conf id -> (brush_name, conf, [textures])
modify_controls = {}
for orig_brush in (
vbsp.VMF.by_class['trigger_portal_cleanser'] &
vbsp.VMF.by_target[fizz_name + '_brush']):
orig_brush.remove()
for config in new_brush_config:
new_brush = orig_brush.copy()
# Unique to the particular config property & fizzler name
conf_key = (id(config), fizz_name)
if config.bool('SimplifyBrush'):
# Replace the brush with a simple one of the same size.
bbox_min, bbox_max = new_brush.get_bbox()
new_brush.solids = [vbsp.VMF.make_prism(
bbox_min, bbox_max,
mat=const.Tools.NODRAW,
).solid]
should_merge = config.bool('MergeBrushes')
if should_merge and conf_key in FIZZ_BRUSH_ENTS:
# These are shared by both ents, but new_brush won't be added to
# the map. (We need it though for the widening code to work).
FIZZ_BRUSH_ENTS[conf_key].solids.extend(new_brush.solids)
else:
vbsp.VMF.add_ent(new_brush)
# Don't allow restyling it
vbsp.IGNORED_BRUSH_ENTS.add(new_brush)
new_brush.clear_keys() # Wipe the original keyvalues
new_brush['origin'] = orig_brush['origin']
new_brush['targetname'] = conditions.local_name(
base_inst,
config['name'],
)
# All ents must have a classname!
new_brush['classname'] = 'trigger_portal_cleanser'
conditions.set_ent_keys(
new_brush, base_inst,
config,
)
for out_prop in config.find_children('Outputs'):
out = Output.parse(out_prop)
out.comma_sep = False
out.target = conditions.local_name(
base_inst,
out.target
)
new_brush.add_out(out)
if should_merge: # The first brush...
FIZZ_BRUSH_ENTS[conf_key] = new_brush
mat_mod_conf = config.find_key('MaterialModify', [])
if mat_mod_conf:
try:
used_materials = modify_controls[id(mat_mod_conf)][2]
except KeyError:
used_materials = set()
modify_controls[id(mat_mod_conf)] = (
new_brush['targetname'],
mat_mod_conf,
used_materials
)
# It can only parent to one brush, so it can't attach
# to them all properly.
if not should_merge:
raise Exception(
"MaterialModify won't work without MergeBrushes!"
)
else:
used_materials = None
laserfield_conf = config.find_key('MakeLaserField', None)
if laserfield_conf.value is not None:
# Resize the brush into a laserfield format, without
# the 128*64 parts. If the brush is 128x128, we can
# skip the resizing since it's already correct.
laser_tex = laserfield_conf['texture', const.Special.LASERFIELD]
nodraw_tex = laserfield_conf['nodraw', const.Tools.NODRAW]
tex_width = laserfield_conf.int('texwidth', 512)
is_short = False
for side in new_brush.sides():
if side == const.Fizzler.SHORT:
is_short = True
break
if is_short:
for side in new_brush.sides():
if side == const.Fizzler.SHORT:
side.mat = laser_tex
side.uaxis.offset = 0
side.scale = 0.25
else:
side.mat = nodraw_tex
else:
# The hard part - stretching the brush.
convert_to_laserfield(
new_brush,
laser_tex,
nodraw_tex,
tex_width,
)
if used_materials is not None:
used_materials.add(laser_tex.casefold())
else:
# Just change the textures
for side in new_brush.sides():
try:
tex_cat = TEX_FIZZLER[side.mat.casefold()]
side.mat = config[tex_cat]
except (KeyError, IndexError):
# If we fail, just use the original textures
pass
else:
if used_materials is not None and tex_cat != 'nodraw':
used_materials.add(side.mat.casefold())
widen_amount = config.float('thickness', 2.0)
if widen_amount != 2:
for brush in new_brush.solids:
conditions.widen_fizz_brush(
brush,
thickness=widen_amount,
)
for brush_name, config, textures in modify_controls.values():
skip_if_static = config.bool('dynamicOnly', True)
if skip_if_static and base_inst.fixup['$connectioncount'] == '0':
continue
mat_mod_name = config['name', 'modify']
var = config['var', '$outputintensity']
if not var.startswith('$'):
var = '$' + var
for tex in textures:
vbsp.VMF.create_ent(
classname='material_modify_control',
origin=base_inst['origin'],
targetname=conditions.local_name(base_inst, mat_mod_name),
materialName='materials/' + tex + '.vmt',
materialVar=var,
parentname=brush_name,
)
