Skip to content

tweak(native-decls): update documentation for trains #3353

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

AvarianKnight
Copy link
Contributor

Goal of this PR

Cleanup the wording in the native declaration to make it less confusing, and add information about how this works with trains

NOTE: This native doesn't guarantee the persistence of the entity.

Is confusing wording, replaced with what is actually defined behavior (that the server will not delete the entity in its normal garbage collection)

This PR applies to the following area(s)

Server

Successfully tested on

N/A

Checklist

  • [N/A] Code compiles and has been tested successfully.
  • Code explains itself well and/or is documented.
  • My commit message explains what the changes do and what they are for.
  • No extra compilation warnings are added by these changes.

@Nobelium-cfx Nobelium-cfx added the ready-to-merge This PR is enqueued for merging label Apr 21, 2025
@github-actions github-actions bot added the triage Needs a preliminary assessment to determine the urgency and required action label Apr 21, 2025
**NOTE**: This native doesn't guarantee the persistence of the entity.
When used on trains, this native will recursively call onto all attached carriages.

**NOTE**: When used with `KeepEntity` (2) this native only guarantees that the ***server*** will not delete the entity, client requests to delete the entity will still work perfectly fine.
Copy link
Contributor

Choose a reason for hiding this comment

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

if entity is created serverside, won't sv_protectServerEntities convar prevent the client from deleting the entity?

If yes, this note may cause some misunderstanding.

Copy link
Contributor

@Ehbw Ehbw Apr 23, 2025

Choose a reason for hiding this comment

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

if entity is created serverside, won't sv_protectServerEntities convar prevent the client from deleting the entity?

If yes, this note may cause some misunderstanding.

At this moment trains are unable to be created on the server I misread. But yes, the client will be unable to delete it

Copy link
Contributor

Choose a reason for hiding this comment

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

GitHub is little funky with the comment creation, but I meant the line 30 exclusively.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ready-to-merge This PR is enqueued for merging triage Needs a preliminary assessment to determine the urgency and required action
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants