New block families by pollend - merge to develop post-GCI #3149

Cervator · 2017-11-27T02:16:33Z

Update: Newer rebased PR available: #3343

Contains

New block family system by @pollend - see this Gist for some documentation and philosophy on the change as well as original PR #3085

How to test

Will need to experiment some with an existing block family or make a new one. Some directions in the Gist but more details for here would be good. Probably Rails would be the ultimate test case.

Outstanding before merging

This breaks backwards compatibility and is part of the v2.0.0 engine release. Some modules are impacted and should be updated with PRs that make the associated changes required by this PR. A task chain for GCI is based on this PR's branch and should be allowed to finish with additional improvements PRed to the branch before this is merged.

MarcinScIncubator
... more modules
Await end of GCI for final feedback and additional changes (should be merged into the newBlockFamilies branch

Additional comments in this PR for feedback/improvements would also be appreciated :-)

- Remove Block Factory/Family pattern - Implemented Dependency Injection pattern for block families - reimplemented basic block families

GooeyHub · 2017-11-27T02:24:51Z

Hooray Jenkins reported success with all tests good!

pollend · 2017-11-30T06:32:26Z

...java/org/terasology/world/block/entity/neighbourUpdate/NeighbourBlockFamilyUpdateSystem.java

@@ -69,6 +71,17 @@ public void largeBlockUpdateFinished(LargeBlockUpdateFinished event, EntityRef e
        }
    }

+    @ReceiveEvent(components = {BlockItemComponent.class})
+    public void onPlaceBlock(OnBlockItemPlaced event, EntityRef entity) {


so this was for the placement problems where a block is placed, but the neighboring blocks don't update. This would come with cables is signalling where if you placed a block the neighboring cables won't update to reflect the new connection.

I think there might be a problem with BlockItemComponent.class because I believe this would never call if the block does not have an item tied to it. This was once of the gci submits and I had to remove the BlockItemComponent for this to work correctly. https://gist.github.com/pollend/148d45ae964337358887b2ab1d4cfeaf

So would I do this instead:
@ReceiveEvent()
public void onPlaceBlock(OnBlockItemPlaced event, EntityRef entity) {
...

generalized event handler for OnBlockItemPlaced

pollend · 2017-12-01T16:13:24Z

engine/src/main/java/org/terasology/world/block/family/AbstractBlockFamily.java

@@ -29,13 +32,23 @@
    private BlockUri uri;
    private Set<String> categories = Sets.newHashSet();


This does not make much sense in the scope of families. these are already provided by the block itself.

GooeyHub · 2017-12-01T16:21:26Z

Hooray Jenkins reported success with all tests good!

Steampunkery · 2017-12-03T00:24:02Z

When you merge this PR, also merge this one into fences so it uses the new block families.

PS-Soundwave · 2017-12-05T14:16:45Z

Definitely a good cleanup of the previous system. Me, @pollend, and @Cervator have discussed these changes as well as future considerations extensively, and I've summarized what I got from it in a gist below. I of course cannot speak for them, but I attempted to accurately portray where we're at right now.

https://gist.github.com/PS-Soundwave/799fd55d34b06b092e7277654540299a

anuar2k · 2018-01-13T22:15:12Z

Terasology-Archived/MarcinScIncubator#2 took a try on the first entry on the list, @Cervator :P

Minor fixes to new block families' docs (merge to newBlockFamilies branch)

GooeyHub · 2018-01-24T17:59:16Z

Hooray Jenkins reported success with all tests good!

pollend · 2018-01-31T05:05:30Z

there are some secondary commits that will also need to be addressed:

#2907
#3180

…weak

GooeyHub · 2018-04-26T23:22:16Z

Hooray Jenkins reported success with all tests good!

…n refactor. Conflict vs #3221 in direction vs rotation stuff. Still one bit pending.

GooeyHub · 2018-04-27T02:34:59Z

Hooray Jenkins reported success with all tests good!

Cervator · 2018-04-27T03:07:00Z

Edit: See #3343 for newer comments - that PR is rebased and easier to test with modules

Been working on preparing this better as the base branch is pretty old at this point, making it hard to test some modules.

Merged in both #3221 and #3180 including conflict fixes (to the newBlockFamilies branch, not develop). This means existing module repo PRs that adjust for this PR may need slight additional tweaks on top. I'm looking at that next.

Some todos remain

Rotation still seems to need something to let unique rotation blocks place correctly facing a given direction. For instance all stair blocks place facing the same way, rather than the direction facing the player at placement time.
Code quality: https://github.com/MovingBlocks/Terasology/pull/3221/files#diff-ea4234b8e155dbfd65deb02f7b1b7605R229 should perhaps be a more narrowly defined Exception? Additional comment in the PR itself changed Direction to rotation #3221
Code quality: Excessive return at https://github.com/MovingBlocks/Terasology/pull/3221/files#diff-ea4234b8e155dbfd65deb02f7b1b7605R231

~~I might take a stab at rebasing this, but in a new branch + PR just in case.~~ - #3343

Related/updated module PRs

PRs exist but need more work

New block families Terasology/Signalling#17
Update for new block family system Terasology/Machines#25 - also clashes with the changes in changed Direction to rotation #3221 and is a bit more work than I can put in right now (complex family with all faces and an archetype, logic defines it all over several passes, hard to readily tweak)

Modules that still need a PR to fix related code

TutorialAssetSystem (and probably its wiki as well)
GrowingFlora
ItemPipes
LightAndShadow
Minesweeper - seemingly just needs a standard family update
ModularComputers - single method no longer matches a signature
Rails
Sample - special since it has several old families from GCI including PRs to update
StructuralTemplates

Unknown

Can't compile due to broken dependencies. Could be fine after dependencies fixed

Lost - probably OK, fails from GrowingFlora not building
NeoTTA - probably OK, fails from GrowingFlora not building
WoodAndStone - probably OK, fails from GrowingFlora not building

Also: potentially any module that uses block families the old school way in prefabs rather than define their own unique block families thus causing compilation errors (I haven't looked for those)

…rasology#3149)

Cervator · 2018-05-10T22:26:17Z

Block families

pollend · 2018-05-10T23:06:19Z

There is already a pr for this #3343.

…haul

Cervator · 2018-05-26T22:36:16Z

Closing as merged by #3343

pollend and others added 15 commits August 29, 2017 10:27

Implemented Tweaks to block families

8b62835

- Remove Block Factory/Family pattern - Implemented Dependency Injection pattern for block families - reimplemented basic block families

removed iml

f4bffd6

tweaked freeform supported annotation

7565f4c

added multi-connect family

0c2b584

added annotation inheirt and block update when block is placed

4a390f4

Fixed imports and cleaned up code

c814468

fixed block family registry

2739c83

fixed Headless enviroment

d832477

cleaned up block family and more imports

a9a1f25

fixed imports

01ce2b1

added java docs

b1703e5

fixed checkstyle errors

c4b6ce5

fixed checkstyle warning

ad924ae

Merge branch 'develop' into block-families-final

647a93d

Merge PR #3085 by @pollend - block family rework

c097e8d

Cervator added this to the v2.0.0 milestone Nov 27, 2017

pollend reviewed Nov 30, 2017

View reviewed changes

pollend and others added 2 commits November 30, 2017 13:04

generalized event handler for OnBlockItemPlaced

f946c01

Merge pull request #3153 from pollend/newfamily-placment

e265fb3

generalized event handler for OnBlockItemPlaced

pollend reviewed Dec 1, 2017

View reviewed changes

re-generalized multiconnect family.

2c05c41

pollend and others added 2 commits January 12, 2018 22:02

changed Direction to rotation

e125e29

Minor fixes to new block families' docs

61e5e3a

anuar2k and others added 2 commits January 13, 2018 23:52

Added an example to one annotation and fixed another one

45c5636

tweaks

66a2575

Steampunkery mentioned this pull request Jan 16, 2018

Fixes ST working with new block families Terasology/StructureTemplates#26

Closed

pollend mentioned this pull request Jan 23, 2018

Minor fixes to new block families' docs (merge to newBlockFamilies branch) #3224

Merged

Merge pull request #3224 from anuar2k/nbf_improve

8752b48

Minor fixes to new block families' docs (merge to newBlockFamilies branch)

Merge PR #3221 by @pollend to newBlockFamilies - direction/rotation t…

20c79f9

…weak

Cervator added 3 commits April 26, 2018 21:57

Merge PR #3180 by @PS-Soundwave into newBlockFamilies - initializatio…

f3896e0

…n refactor. Conflict vs #3221 in direction vs rotation stuff. Still one bit pending.

Resolve additional conflict from #3180 vs #3221

481379b

Minor code quality tweaks

c9f01b2

Cervator mentioned this pull request Apr 27, 2018

New block families Terasology/Fences#8

Merged

Cervator added a commit to Terasology-Archived/MarcinScIncubator that referenced this pull request Apr 27, 2018

Conflict fix related to MovingBlocks/Terasology#3149

0d07cf3

Cervator mentioned this pull request Apr 27, 2018

New block families Terasology-Archived/MarcinScIncubator#3

Merged

Cervator added a commit to Terasology/MultiBlock that referenced this pull request Apr 27, 2018

Adjustments for recent block family redo API changes (MovingBlocks/Te…

f81cff8

…rasology#3149)

Cervator mentioned this pull request Apr 27, 2018

New block families - rebased #3343

Merged

26 tasks

Cervator mentioned this pull request May 10, 2018

BlockManager returns Air block instead of null for block family if no side is defined #2984

Open

Cervator added a commit that referenced this pull request May 26, 2018

Merge PR #3343 (and #3149) by @pollend and others - block family over…

97e00cb

…haul

Cervator closed this May 26, 2018

Cervator deleted the newBlockFamilies branch May 26, 2018 22:36

skaldarnar removed the Api label May 15, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

New block families by pollend - merge to develop post-GCI #3149

New block families by pollend - merge to develop post-GCI #3149

Cervator commented Nov 27, 2017 •

edited

Loading

GooeyHub commented Nov 27, 2017

pollend Nov 30, 2017 •

edited

Loading

pollend Dec 1, 2017

GooeyHub commented Dec 1, 2017

Steampunkery commented Dec 3, 2017

PS-Soundwave commented Dec 5, 2017

anuar2k commented Jan 13, 2018

GooeyHub commented Jan 24, 2018

pollend commented Jan 31, 2018 •

edited

Loading

GooeyHub commented Apr 26, 2018

GooeyHub commented Apr 27, 2018

Cervator commented Apr 27, 2018 •

edited

Loading

Cervator commented May 10, 2018

pollend commented May 10, 2018

Cervator commented May 26, 2018

		@@ -29,13 +32,23 @@
		private BlockUri uri;
		private Set<String> categories = Sets.newHashSet();

New block families by pollend - merge to develop post-GCI #3149

New block families by pollend - merge to develop post-GCI #3149

Conversation

Cervator commented Nov 27, 2017 • edited Loading

Contains

How to test

Outstanding before merging

GooeyHub commented Nov 27, 2017

pollend Nov 30, 2017 • edited Loading

Choose a reason for hiding this comment

pollend Dec 1, 2017

Choose a reason for hiding this comment

GooeyHub commented Dec 1, 2017

Steampunkery commented Dec 3, 2017

PS-Soundwave commented Dec 5, 2017

anuar2k commented Jan 13, 2018

GooeyHub commented Jan 24, 2018

pollend commented Jan 31, 2018 • edited Loading

GooeyHub commented Apr 26, 2018

GooeyHub commented Apr 27, 2018

Cervator commented Apr 27, 2018 • edited Loading

Related/updated module PRs

PRs exist but need more work

Modules that still need a PR to fix related code

Unknown

Cervator commented May 10, 2018

pollend commented May 10, 2018

Cervator commented May 26, 2018

Cervator commented Nov 27, 2017 •

edited

Loading

pollend Nov 30, 2017 •

edited

Loading

pollend commented Jan 31, 2018 •

edited

Loading

Cervator commented Apr 27, 2018 •

edited

Loading