Skip to content

fully remove obsolete methods in mapgridcomponent#6476

Open
slarticodefast wants to merge 1 commit intospace-wizards:masterfrom
slarticodefast:cleanup-mapgrid
Open

fully remove obsolete methods in mapgridcomponent#6476
slarticodefast wants to merge 1 commit intospace-wizards:masterfrom
slarticodefast:cleanup-mapgrid

Conversation

@slarticodefast
Copy link
Member

It's been obsolete for more than 2 years, time to remove it.
Content does not use it anymore.
If someone still uses it it's an easy fix since it's just a direct replacement with the corresponding MapSystem API method.

Partially addresses #6468

Comment on lines +17 to +21
/// <summary>
/// Component marking a grid entity, which are the "floor" in space other entities can be placed on.
/// Grids can have their own physics and move around in space while players or other entities move on them.
/// Examples for grids are the station, shuttles or asteroids.
/// </summary>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
/// <summary>
/// Component marking a grid entity, which are the "floor" in space other entities can be placed on.
/// Grids can have their own physics and move around in space while players or other entities move on them.
/// Examples for grids are the station, shuttles or asteroids.
/// </summary>
/// <summary>
/// <para>
/// Provides a tile grid as part of an entity, with APIs to manipulate it provided on <see cref="MapSystem"/>.
/// Grids function as the optional second level in the physics hierarchy, and implicitly provide physics and the ability to collide with one-another.
/// </para>
/// <para>
/// Map grids are an unbounded 2D grid composed of <see cref="Tile"/>s,
/// which have their properties defined by <see cref="ITileDefinition"/> inheriting prototypes.
/// A tile with the id 0 is automatically assumed to be the "empty" tile and is the default state of any tile that has not been assigned to.
/// </para>
/// <para>
/// Collision is automatically generated from set grid tiles (excluding tiles with id 0, i.e. empty).
/// Map grids have an implied additional level of physics acceleration structures,
/// functioning as an optimization for games that rely on moving grids regularly by avoiding the need to update the grids' children.
/// </para>
/// </summary>

This isn't content, so no content-specific documentation.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for writing this up.
But could we at least keep some kind of simple introductory sentence to explain what a grid is and what the component is actually doing?
Because while this kind of documentation is intended for engine contributors, it is also completely useless for new contributors to content development, who won't understand what most of these words mean without diving into tons of engine code.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you can think of a good introduction, sure, but it cannot be SS14-specific.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is the word "space" SS14 specific? :godo:
Because that is kinda the best way to describe it

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is the word "space" SS14 specific? :godo: Because that is kinda the best way to describe it

Space for describing the wider map is fine.

@Tayrtahn Tayrtahn added the T: Cleanup Type: Code cleanup label Mar 23, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

T: Cleanup Type: Code cleanup

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants