setBirdTargetVelocity
Client-side
Sets where a managed bird should be heading and lets it ease toward it.
Syntax
bool setBirdTargetVelocity(bird theBird, Vector3 velocity)Arguments
theBirdbirdManaged bird element.
velocityVector3Desired velocity.
Returns
true when applied; false for an invalid element or value.
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
- This is what makes a flock turn as a group instead of snapping to a new heading.
OOP aliases
bird:setTargetVelocity(velocity)
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 →