Skip to content
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

Update annotations of engine projectile methods #6399

Merged
merged 3 commits into from
Aug 9, 2024

Conversation

Garanas
Copy link
Member

@Garanas Garanas commented Aug 9, 2024

Description of the proposed changes

Document the support for method chaining of the projectile engine methods. I noticed this behavior as I was working on #6398.

Testing done on the proposed changes

I called every function and checked the output of the log with logging the instance. If the references match then the function supports method chaining.

LOG(self) -- returns memory reference
LOG("ChangeDetonateAboveHeight", self:ChangeDetonateAboveHeight(0)) -- returns nil
LOG("SetLifetime", self:SetLifetime(10)) -- returns memory reference

Checklist

  • Changes are annotated, including comments where useful
  • Changes are documented in the changelog for the next game version

@Garanas Garanas added the area: documentation related to documentation to preserve knowledge and practices label Aug 9, 2024
@Garanas Garanas merged commit f39f8cc into develop Aug 9, 2024
5 checks passed
@Garanas Garanas deleted the annotations/projectile-methods branch August 9, 2024 09:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: documentation related to documentation to preserve knowledge and practices
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant