Boids.CreateFlock( entity,paramsTable ) Creates a flock of boids and binds it to the given entity. | Parameter | Description |
|---|---|
| entity | Valid entity table. |
| nType | Type of the flock, can be Boids.FLOCK_BIRDS,Boids.FLOCK_FISH,Boids.FLOCK_BUGS. |
| paramTable | Table with parameters for flock (Look at sample scripts). |
Boids.CreateFishFlock( entity,paramsTable ) Creates a fishes flock and binds it to the given entity. | Parameter | Description |
|---|---|
| entity | Valid entity table. |
| paramTable | Table with parameters for flock (Look at sample scripts). |
Boids.CreateBugsFlock( entity,paramsTable ) Creates a bugs flock and binds it to the given entity. | Parameter | Description |
|---|---|
| entity | Valid entity table. |
| paramTable | Table with parameters for flock (Look at sample scripts). |
Boids.SetFlockParams( entity,paramsTable ) Modifies parameters of the existing flock in the specified entity. | Parameter | Description |
|---|---|
| entity | Valid entity table containing flock. |
| paramTable | Table with parameters for flock (Look at sample scripts). |
Boids.EnableFlock( entity,paramsTable ) Enables/Disables flock in the entity. | Parameter | Description |
|---|---|
| entity | Valid entity table containing flock. |
| bEnable | true to enable or false to disable flock. |
Boids.SetFlockPercentEnabled( entity,paramsTable ) Used to gradually enable flock. Depending on the percentage more or less boid objects will be rendered in flock. | Parameter | Description |
|---|---|
| entity | Valid entity table containing flock. |
| nPercent | In range 0 to 100, 0 mean no boids will be rendered,if 100 then all boids will be rendered. |
Boids.SetAttractionPoint( entity,paramsTable ) Sets the one time attraction point for the boids | Parameter | Description |
|---|---|
| entity | Valid entity table containing flock. |
| point | The one time attraction point |
Boids.OnBoidHit( flockEntity,boidEntity,hit ) Events that occurs on boid hit. | Parameter | Description |
|---|---|
| flockEntity | Valid entity table containing flock. |
| boidEntity | Valid entity table containing boid. |
| hit | Valid entity table containing hit information. |
Boids.CanPickup( flockEntity, boidEntity ) Checks if the boid is pickable | Parameter | Description |
|---|---|
| flockEntity | Valid entity table containing flock. |
| boidEntity | Valid entity table containing boid. |
Boids.GetUsableMessage( flockEntity ) Gets the appropriate localized UI message for this flock | Parameter | Description |
|---|---|
| flockEntity | Valid entity table containing flock. |
Boids.OnPickup( flockEntity, boidEntity, bPickup, fThrowSpeed ) Forwards the appropriate pickup action to the boid object | Parameter | Description |
|---|---|
| flockEntity | Valid entity table containing flock. |
| boidEntity | Valid entity table containing boid. |
| bPickup | Pickup or drop/throw? |
| fThrowSpeed | value > 5.f will kill the boid by default (no effect on pickup action) |