Selecting Blocks
There are several functions in ruleset that are responsible for selecting certain blocks by condition. Blocks selectors are limited by blocks scope.
Blocks Selection Functions
Let's take this scene, for example, and apply various block selector rules. Selected blocks will be colored red.
We will be using next style script.
@tool
extends RoommateStyle
func _build_rulesets() -> void:
var ruleset := create_ruleset()
# block selection code goes here
ruleset.select_all_parts().surfaces.color.accumulate(Color.RED, 0.8)
select_all_blocks
Simply selects all blocks in the scope.
select_blocks_by_type
Select all blocks of certain type. For example, we will select all oblique blocks.
select_blocks_by_extreme
Select blocks by extreme positions in current scope.
If you pass 0 as a value for certain axis, it will be ignored, ie selection will be extruded along that axis. Number means how much rows will be selected from min/max positions.
select_edge_blocks
Block is selected if it's near edge. You pass RoommateSegment object to select_edge_blocks
var segment_left := RoommateSegment.new(Vector3i.LEFT, 0)
ruleset.select_edge_blocks([segment_left])
You can change max_steps parameter,
var segment_left := RoommateSegment.new(Vector3i.LEFT, 1)
ruleset.select_edge_blocks([segment_left])
If you pass multiple segments, block is selected if both of them are satisfied.
var segment_left := RoommateSegment.new(Vector3i.LEFT, 0)
var segment_down := RoommateSegment.new(Vector3i.DOWN, 0)
ruleset.select_edge_blocks([segment_left, segment_down])
There are select_edge_blocks_axis function. It produces same result as above example
select_interval_blocks
You can select blocks by interval.
a
select_inner_blocks
a
var segment_forward := RoommateSegment.new(Vector3.FORWARD, 0)
ruleset.select_inner_blocks([segment_forward])
a
var segment_forward := RoommateSegment.new(Vector3.FORWARD, 1)
ruleset.select_inner_blocks([segment_forward])
a
var segment_forward := RoommateSegment.new(Vector3.FORWARD, 0)
var segment_up := RoommateSegment.new(Vector3.UP, 0)
ruleset.select_inner_blocks([segment_forward, segment_up])
a
select_random_blocks
a
var rng := RandomNumberGenerator.new()
rng.seed = hash("Roommate is cool!")
ruleset.select_random_blocks(0.4, rng)
a
select_blocks
a
var prepare := func (blocks_scope: Dictionary) -> Dictionary:
var max_y: float = NAN
var min_y: float = NAN
for block_position in blocks_scope:
max_y = maxf(max_y, block_position.y)
min_y = minf(min_y, block_position.y)
return { "sin_center": roundi((max_y - min_y) / 2 + min_y) }
var is_block_selected := func (offset_position: Vector3i, block: RoommateBlock,
blocks_scope: Dictionary, prepared_vars: Dictionary) -> bool:
var sin_center := prepared_vars["sin_center"] as int
return (roundi(sin(offset_position.x)) + sin_center) == offset_position.y
ruleset.select_blocks(is_block_selected, prepare)
Blocks Selector Inclusion modes
asd
@tool
extends RoommateStyle
func _build_rulesets() -> void:
var ruleset := create_ruleset()
ruleset.select_blocks_by_extreme(Vector3(0, -1, -1))
ruleset.select_blocks_by_extreme(Vector3(0, -1, 1))
var selector := ruleset.select_blocks_by_extreme(Vector3(1, -1, 0))
# selector mode changing code goes here
ruleset.select_all_parts().surfaces.color.accumulate(Color.RED, 0.8)
include
a
a
exclude
a
invert
a
intersect
a
