Add EntityCollisionRulesChanged & SetEntityOwner natives by Kenzzer · Pull Request #1620 · alliedmodders/sourcemod

Kenzzer · 2021-10-27T20:18:40Z

Introduction

Alright, in that case I'll open a PR in the next couple of days!

Famous last words... or not!

First I'd like to apologise for not having made this PR earlier.

What changed ?

SetCollisionGroup signature has been removed, this signature was used by sdktools to call CBaseEntity::SetCollisionGroup.

void CBaseEntity::SetCollisionGroup( int collisionGroup )
{
	if ( (int)m_CollisionGroup != collisionGroup )
	{
		m_CollisionGroup = collisionGroup;
		CollisionRulesChanged();
	}
}

The main point, was to call CBaseEntity::CollisionRulesChanged after setting the collision group.

So instead now we go through CBaseEntity::SetEntityOwner, a virtual function which should ideally provide easier maintenance of gamedata (if ever needed) and easier support accross all source games.

void CBaseEntity::SetOwnerEntity( CBaseEntity* pOwner )
{
	if ( m_hOwnerEntity.Get() != pOwner )
	{
		m_hOwnerEntity = pOwner;

		CollisionRulesChanged();
	}
}

Bypassing the if statement is trivial, as m_hOwnerEntity is both a datamap and netprop. With this little hack, we get an easy access to CBaseEntity::CollisionRulesChanged.

The native SetEntityCollisionGroup has been rewritten to mimic what CBaseEntity::SetCollisionGroup does.
Added EntityCollisionRulesChanged as native, since we have an access to it.
And finally added SetEntityOwner as native, because we have to maintain that vtable offset in order to keep the other two natives working.

Final note

As said in introduction, I have not tested anything yet and I'd be very grateful if anyone could test this on csgo, css and l4d.
I also want to mention, that the vtable offsets for CSGO and Left 4 Dead 1 were guessed, there's a chance they're invalid. If someone can provide or confirm them that'd be helpful too!

I'm planning on testing this for CSGO & TF2 this weekend.

Kenzzer · 2021-10-27T20:20:06Z

@KyleSanderson tagging you (hope you don't mind), since you wanted to review this and I can't seem to be able to request reviews. Sorry for the 3 months delay!

Wend4r · 2021-10-27T20:37:41Z

I have a suggestion to add a GetEntityOwner() native by CBaseEntity::m_hOwnerEntity. Usually get it through netprop, but it would be more convenient to use the functionality of this PR

KyleSanderson

were you able to test over the weekend? I'm really optimistic about this PR as it's going to help a lot of people.

extensions/sdktools/vhelpers.cpp

KyleSanderson · 2021-11-02T00:31:23Z

extensions/sdktools/vnatives.cpp

+		// Returns false if CollisionRulesChanged hack isn't supported for this game
+		if (!CollisionRulesChanged(pEntity))
+		{
+			return pContext->ThrowNativeError("\"SetEntityCollisionGroup\" unsupported entity");


"is not supported on this engine." ? Something like that - it shouldn't be the same message if it fails the datamap lookup.

extensions/sdktools/vnatives.cpp

Kenzzer · 2021-11-02T11:26:16Z

were you able to test over the weekend?

Not yet, unfortunately time flew by without me noticing, I also need to come up with a good test plugin to ensure everything's fine. But I've built the ext for tf2 & csgo (linux) and setup my local server already, hopefully this shouldn't take much longer.

KyleSanderson · 2021-11-05T06:42:26Z

were you able to test over the weekend?

Not yet, unfortunately time flew by without me noticing, I also need to come up with a good test plugin to ensure everything's fine. But I've built the ext for tf2 & csgo (linux) and setup my local server already, hopefully this shouldn't take much longer.

Damn. Let us know when this is closer (I think we're close, too).

Kenzzer · 2021-11-17T22:20:46Z

The requested changes have been done, and the PR has been tested on TF2 both linux & windows.

Here's a test plugin for those interested to test this out on their own
(With the merge of dhooks, this works on stock SM)
collisionrules.txt
collisionrules.sp.txt

Here's the console output

I believe this time we're ready.

einyux · 2021-11-22T20:06:33Z

Like often a little too late, but I think it would have been better to keep the real function name "SetOwnerEntity()" instead of "SetEntityOwner()" :).

psychonic · 2021-11-22T21:06:32Z

Like often a little too late, but I think it would have been better to keep the real function name "SetOwnerEntity()" instead of "SetEntityOwner()" :).

SetEntityOwner is more in line with the rest of the SourceMod API. The full original function name is CBaseEntity::SetOwnerEntity, implying that you're operating on an entity to set it's owner entity. SetEntityOwner also implies that you're operating on an entity to set it's owner. The only part lost is that the owner is an entity, but I think that's better left implied rather than SetEntityOwnerEntity.

einyux · 2021-11-22T22:06:56Z

Indeed, I understand the issue for SetOwnerEntity().

However, I don't really see a problem with SetEntityOwnerEntity(), which is in line with CBaseEntity::SetOwnerEntity, knowing that CXX::SetOwner() exists too.

Here we're loosing the info that we're setting "m_hOwnerEntity" and not "m_hOwner".
Its not indicated in the sdktools_functions.inc either.

Add EntityCollisionRulesChanged & SetEntityOwner natives

21c63c4

psychonic added Needs Testing untested by author Feature Request user requested feature labels Oct 27, 2021

Kenzzer added 2 commits October 27, 2021 22:26

fix win build, and unpushed changes

1967b57

Fixed bad world loop

bfc671e

KyleSanderson self-requested a review November 1, 2021 23:02

KyleSanderson requested changes Nov 2, 2021

View reviewed changes

Kenzzer and others added 3 commits November 17, 2021 20:21

Merge branch 'alliedmodders:master' into master

e2e14bc

Requested changes + csgo offsets

286be4a

small copy paste mistake

c01a94f

Kenzzer requested a review from KyleSanderson November 17, 2021 22:21

Kenzzer added 2 commits November 17, 2021 23:26

Strip the debug log lines

391187b

Tiny clean up in comments

513e3db

KyleSanderson approved these changes Nov 22, 2021

View reviewed changes

KyleSanderson added 3 commits November 21, 2021 21:35

line

e1be61e

<dvander> try again

588e41f

sdktools: add default Param for owner.

348252c

KyleSanderson merged commit b38c982 into alliedmodders:master Nov 22, 2021

Alienmario mentioned this pull request Apr 21, 2022

Add recent gamedata for BMS, HL2DM #1756

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add EntityCollisionRulesChanged & SetEntityOwner natives#1620

Add EntityCollisionRulesChanged & SetEntityOwner natives#1620
KyleSanderson merged 11 commits intoalliedmodders:masterfrom
Kenzzer:master

Kenzzer commented Oct 27, 2021 •

edited

Loading

Uh oh!

Kenzzer commented Oct 27, 2021

Uh oh!

Wend4r commented Oct 27, 2021

Uh oh!

KyleSanderson left a comment

Uh oh!

Uh oh!

KyleSanderson Nov 2, 2021

Uh oh!

Uh oh!

Uh oh!

Kenzzer commented Nov 2, 2021 •

edited

Loading

Uh oh!

KyleSanderson commented Nov 5, 2021

Uh oh!

Kenzzer commented Nov 17, 2021 •

edited

Loading

Uh oh!

einyux commented Nov 22, 2021

Uh oh!

psychonic commented Nov 22, 2021

Uh oh!

einyux commented Nov 22, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Uh oh!

Conversation

Kenzzer commented Oct 27, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Introduction

What changed ?

Final note

Uh oh!

Kenzzer commented Oct 27, 2021

Uh oh!

Wend4r commented Oct 27, 2021

Uh oh!

KyleSanderson left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

KyleSanderson Nov 2, 2021

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Kenzzer commented Nov 2, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

KyleSanderson commented Nov 5, 2021

Uh oh!

Kenzzer commented Nov 17, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

einyux commented Nov 22, 2021

Uh oh!

psychonic commented Nov 22, 2021

Uh oh!

einyux commented Nov 22, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Kenzzer commented Oct 27, 2021 •

edited

Loading

Kenzzer commented Nov 2, 2021 •

edited

Loading

Kenzzer commented Nov 17, 2021 •

edited

Loading