Skip to content

Add Entity:ResetSequence overload #22

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Aug 13, 2023
Merged

Add Entity:ResetSequence overload #22

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions custom/Entity.ResetSequence.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---[SHARED] Plays an animation on the entity. This may not always work on engine entities.
---
--- This will not reset the animation on viewmodels, use Entity:SendViewModelMatchingSequence instead.
---
--- This will not work properly if called directly after calling Entity:SetModel. Consider waiting until the next Tick.
---
--- Will not work on players due to the animations being reset every frame by the base gamemode animation system. See GM:CalcMainActivity.
---
--- For custom scripted entities you will want to apply example from ENTITY:Think to make animations work.
---
---[(View on wiki)](https://wiki.facepunch.com/gmod/Entity:ResetSequence)
---@param sequence number The sequence to play. Also accepts strings.
---
--- If set to a string, the function will automatically call Entity:LookupSequence to retrieve the sequence ID as a number.
function Entity:ResetSequence(sequence) end

---[SHARED] Plays an animation on the entity. This may not always work on engine entities.
---
--- This will not reset the animation on viewmodels, use Entity:SendViewModelMatchingSequence instead.
---
--- This will not work properly if called directly after calling Entity:SetModel. Consider waiting until the next Tick.
---
--- Will not work on players due to the animations being reset every frame by the base gamemode animation system. See GM:CalcMainActivity.
---
--- For custom scripted entities you will want to apply example from ENTITY:Think to make animations work.
---
---[(View on wiki)](https://wiki.facepunch.com/gmod/Entity:ResetSequence)
---@param sequence string The sequence to play. Also accepts strings.
---
--- If set to a string, the function will automatically call Entity:LookupSequence to retrieve the sequence ID as a number.
function Entity:ResetSequence(sequence) end