setBirdMovementEnabled
Client-side
Freezes one managed bird in place or lets it fly again.
Syntax
bool setBirdMovementEnabled(bird theBird, bool enabled)Arguments
theBirdbirdManaged bird element.
enabledboolWhether the bird moves.
Returns
true when applied; false for an invalid element.
Ownership and lifecycle
A bird belongs to the client resource that created it and is removed when that resource stops. Birds fade near their render distance instead of being destroyed, and a dimension or interior mismatch hides them while keeping the element alive.
Important behavior
- Freezing one bird leaves the rest of the flock flying, which is how a single bird is pulled out of a formation.
OOP aliases
bird:setMovementEnabled(enabled)bird.movementEnabled
Where this comes from
SOURCECLuaBirdDefs.cppClient/mods/deathmatch/logic/luadefs/CLuaBirdDefs.cpp INTRODUCED / EXTENDED23fedfbc9Read the commit and why the change was made TEST RESOURCE bird-test test-resources/bird-test
RELATED NEON APIS
Read the system guide →