Release Notes for 626

Hello! Last week we had an internal release, but we still have release notes to share! :slight_smile:

54 Likes

You guys are so cool, thanks

12 Likes


RIP

Edit: It works on my phone, but not on pc.

8 Likes

Yes finally!! No more hacky ways to create meshparts and no more relying on SpecialMeshes!

15 Likes

Insert.CreateMeshPartAsync can now be used by regulars scripts as shown by @weakroblox35:

However, when trying to use this function at runtime in either studio or in-game it says it cannot run yet. It doesn’t matter whether it’s ran on the client or server, it gives the same error.

Is the function just currently disabled or is there still engine limitations that will be addressed with a future beta or update?

6 Likes

It says Pending is the patch notes, that’s why it’s not working yet, it hasn’t been added yet.

12 Likes

Not bad updates! Great job guys! When are we going to get a big one though? Like addition of some instances that the community wants for years now and yet we don’t have them.

6 Likes

I don’t know how to feel about this. What is the change intended to address? I wouldn’t otherwise anticipate this behavior of :Destroy(), had not I stumbled across this release note.

8 Likes

No clue if its an issue now but it started recently but turning my camera left and right has sort of delay on the higher FPS settings with the new client, is this on purpose or a bug?

If a video is needed I am willing to provide.

6 Likes

Originally, calling Destroy didn’t clean up whatever the module returned(?) I suspect this change actually gives a chance for it to be cleaned up if what it returns is no longer in use.

For example, a car model with modules under it gets destroyed, all of its return stuff would still linger in memory(?) Now with this, there’s a chance (which I presume means if the returned stuff isn’t being used by other scripts) for it to be garbage collected.

The (?)'s are there because I can’t remember where I got that info from, but I believe it to be true.

7 Likes

It’s been my appreciation that modulescript results have always been collected (and I can observably support this). How I interpret the change, is that :Destroy() will now try to stop the modulescript from persisting its result. And so, despite keeping a reference to the instance, scripters will no longer be able to require the destroyed module, if its result was not maintained elsewhere.

5 Likes

Why I assume this was changed, is so that the cyclic references caused by a modulescript returning a table that references back to the modulescript instance itself, can be broken. But when would this happen in practice?

4 Likes

627 was published before 626? Two in one day? Marvellous!

6 Likes

When will be Editable Mesh with collisions ?

5 Likes

Developers often have issues with module script memory leaks, like in this topic Memory leak: Modulescripts never Garbage Collected after Destroy()'d and all references are removed.
We receive other reports similar to that and many people are actually surprised that Destroy doesn’t free memory.

In practice, not a lot of developers require destroyed modules and those who do (for example by using HDAdmin) require them after calling Destroy, which this change doesn’t address as it’s not the common memory leak situation.

Common case is that any ModuleScript result containing any functions is never garbage collected, even if the ModuleScript is destroyed.

local module = {}

module.t = table.create(100000, 1) -- some big data

-- every function holds a reference to 'script' because getfenv can be called on it
function module.foo() return 1 end

return module

Since modules are often used to return functions, this is an issue for experiences cloning modules or just having modules in StarterPlayerScripts.

11 Likes

This is substantially more problematic than I’d hoped.

Why I suppose I was a bit put-off, is because integrating obscure edge-case treatments like these into :Destroy(), seems like more of a patch than a fix. We just can’t always expect that instances leaving the world, will even reliably be destroyed to begin with. So what we have, is a growing number of design issues, that can evidently only be solved by this ever expanding generic cleanup method, that only mostly is called when it should be.

Even after this change goes through, one example of a prominent exception, would be fallen models. Currently, contrary to what the property ‘FallenPartsDestroyHeight’ might suggest, fallen parts do not appear to be destroyed by the engine. This would imply that any physically simulated models containing modulescripts, wouldn’t be at all addressed by this measure.

4 Likes

Regarding InsertService.CreateMeshPartAsync, I just want to clarify on whether or not there are any rate limits with this request. Would it be safe to use this method extensively in game?

3 Likes

TL;DR: Fire away, you’re probably not going to hit any limits with sane usage patterns.

I’m sure there is some rate limit as far as the server requesting assets but you’ll almost certainly run into computational limits first especially if you’re using CollisionFidelity = precise because it has to compute the collision geometry for each loaded mesh. It’s an async API which does the work in the background but the requests to generate collision geometry will start backing up and taking longer to return eventually if you try to load too many meshes all at once.

So if you’re trying to load hundreds of meshes right at startup you may want to reconsider that for performance reasons: If the meshes represent static geometry it would be better to generate the MeshParts for them ahead of time rather than slowing down startup dynamically generating all that collision geometry.

(IIRC the asset request limit is something in the many thousands of unique assets per minute)

9 Likes

I would be using CollisionFidelity = box.

My use case is actually a custom streaming system, in my game I have “props” which are duplicates of some reference object (i.e: a hundred copies of a tree point to a single reference tree); when I stream the world, when a reference object is needed, I send over a serialized version of the tree. The only two things I can’t serialize is MeshPart (can’t set MeshId in runtime) and SurfaceAppearance (same thing).

So I would be sending this serialized data to the client, reconstructing the object client-side, and hopefully, I’ll be able to call InsertService.CreateMeshPartAsync on the client too.

Currently, I have this streaming stuff working but without serialization, and the bandwidth costs of sending the instances, as well as the clientside and serverside CPU cost of cloning the reference object to be sent (using the parent to PlayerGui hack for selective replication), are a big issue. By sending serialized data thats compressed to my needs, I can avoid both costs; on the client, I still have to clone the objects but that can be amortized over several frames + instance recycling

6 Likes

Ah, yeah. In that case you’re good to go. You would likely run out of memory to store the loaded assets before hitting the raw asset request limit.

8 Likes