matter-ecs / matter-types Goto Github PK

View Code? Open in Web Editor NEW

12.0 3.0 11.0 870 KB

License: MIT License

CSS 1.12% JavaScript 2.35% Luau 96.44% TypeScript 0.10%

matter-types's Introduction

Matter is a modern ECS library for Roblox.

Installation

Matter can be installed with Wally by including it as a dependency in your wally.toml file.

Matter = "matter-ecs/[email protected]"

Migration

If you're currently using the scope evaera/matter, prior versions are the same package. You can migrate by changing your wally.toml file to use the scope matter-ecs/matter.

Building

Before building, you'll need to install all dependencies using Wally.

You can then sync or build the project with Rojo. Matter contains several project files with different builds of the project. The default.project.json is the package build. The example.project.json is the example game build.

Contributing

Contributions are welcome, please make a pull request! Check out our contribution guide for further information.

Please read our code of conduct when getting involved.

Project Legacy

Matter was originally pioneered by @evaera. She laid the robust foundation for the work we continue today.

License

Matter is free software available under the MIT license. See the license for details.

matter-types's People

Contributors

Stargazers

Watchers

Forkers

hylianbasement noahwillcrow xuleos sasial-dev urbanindigo spencerdevv hazelmeow jacktabscode hy2k mathfox thefnox

matter-types's Issues

Community docs have been overwritten

Current behavior

The readme and other community docs got replaced during the last sync. This seems like a mistake since they currently instruct rbxts users to use this by installing with Wally, etc.

Proposed improvement

Revert to previous versions of these docs and consider most other non-src files for reverting as well to ensure mistakes aren't being made here. It seems like most non-src files are likely not needed to be updated/replaced.

Synthetic events are not allowed by the types

Loop:begin() does not allow synthetic events (any psuedo-event that provides :Connect()), despite Matter allowing it.

matter-types/lib/Loop.d.ts

Line 152 in 30d74ad

 public begin<T extends { [index: string]: RBXScriptSignal }>(events: T): { [P in keyof T]: RBXScriptConnection }; 

loopParameterNames

Missing Debugger.loopParameterNames type

Multiple function signatures are incorrectly marked as Entity<T> or AnyEntity instead of number

Entity<T> does accept numbers, but it is not the correct signature for any of these

QueryResult

https://github.com/Ukendio/Matter/blob/c43a2a95b32e8f21efcd087dd15166ab3878e6db/lib/World.d.ts#L124

https://eryn.io/matter/api/QueryResult#next

Debugger

https://github.com/Ukendio/Matter/blob/c43a2a95b32e8f21efcd087dd15166ab3878e6db/lib/debugger/debugger.d.ts#L36

https://eryn.io/matter/api/Debugger#findInstanceFromEntity

World

https://github.com/Ukendio/Matter/blob/c43a2a95b32e8f21efcd087dd15166ab3878e6db/lib/World.d.ts#L71

https://eryn.io/matter/api/World#despawn

https://github.com/Ukendio/Matter/blob/c43a2a95b32e8f21efcd087dd15166ab3878e6db/lib/World.d.ts#L77

https://eryn.io/matter/api/World#replace

https://github.com/Ukendio/Matter/blob/c43a2a95b32e8f21efcd087dd15166ab3878e6db/lib/World.d.ts#L81

https://eryn.io/matter/api/World#contains

https://github.com/Ukendio/Matter/blob/c43a2a95b32e8f21efcd087dd15166ab3878e6db/lib/World.d.ts#L83

https://github.com/Ukendio/Matter/blob/c43a2a95b32e8f21efcd087dd15166ab3878e6db/lib/World.d.ts#L88

https://eryn.io/matter/api/World#get

https://github.com/Ukendio/Matter/blob/c43a2a95b32e8f21efcd087dd15166ab3878e6db/lib/World.d.ts#L101

https://eryn.io/matter/api/World#insert

https://github.com/Ukendio/Matter/blob/c43a2a95b32e8f21efcd087dd15166ab3878e6db/lib/World.d.ts#L103

https://eryn.io/matter/api/World#remove

Update to upstream 0.8.2

Single entity overload type for `World:get()` was removed

Add :with to world query

the matter has .without

is it possible to add something like .withAll (from Unity ECS)

it filters all entities with this component but doesn't include it in the iterator

world.query(position_component).with(enemy_component)
-- will return all entities with position_component and enemy_component ,but dont pass enemy_component

this is useful for situations if you only need position_component and not the enemy_component

findInstanceFromEntity function signature should have number as first argument instead of AnyEntity

https://github.com/Ukendio/Matter/blob/e1cc52f3dbb7dd042b5903a322bd3f3a2f1ea425/lib/debugger/debugger.d.ts#L36

https://eryn.io/matter/api/Debugger#findInstanceFromEntity

QueryResult:snapshot has untyped iter metamethod

Currently it's typed as returning ReadonlyArray<[Entity<T>, ...T]>, but the return value actually has an __iter metamethod that interferes with things.

The metamethod lets you do this in Lua (the same as iterating a query without snapshotting it):

for entityId, health, player in world:query(Health, Player):snapshot() do

But in TS if we do something like .snapshot().mapFiltered(([id, health, player]) => {}), we'll generate something like:

local callback = function(_param)
    local id = _param[1]
    local cpn = _param[2]
    local player = _param[3]
end
-- ▼ ReadonlyArray.mapFiltered ▼
local _newValue = {}
local _length = 0
for _k, _v in querySnapshot do
    local _result = _arg0(_v, _k - 1, querySnapshot)
    if _result ~= nil then
        _length += 1
        _newValue[_length] = _result
    end
end
-- ▲ ReadonlyArray.mapFiltered ▲

And because of __iter, _k will end up being the id instead of the index and _v will be health, not [id, health, player], and so the callback will not get the value that the types think it will

Wrap returned component data with Readonly

Component data is immutable, but only for first scope. So I can easily edit 2-nd+ scope by accident. Is it by design, or it's impossible to wrap it to Readonly?
Ex:

SomeComponent({
someKey: []
});

const someComponent = world.get(...);
someComponent.someKey.push({});