Prop

A generic carryable world object that can be rendered as a 3D model or billboarded sprite

Prop is a lightweight core engine primitive for physical or interactive objects.

Props can be rendered either as a 3D model or as a camera-facing billboard sprite. They can remain completely static, or optionally use lightweight physics when carried or dropped.

Prop physics is deliberately inexpensive. Physics is only actively simulated while the Prop is moving; once it comes to rest, it sleeps and no longer consumes active physics work. This keeps large numbers of Props from becoming a persistent workload on the LogicThread.

Props can also participate in Fio's entity I/O system, allowing them to act as gameplay objects without requiring custom scripting.

Properties:

• Model — 3D model used when rendering in model mode.
• Sprite — Billboard sprite used when rendering in billboard mode.
• Render Mode — Selects model or billboard rendering.
• Sprite Size — Size of the billboard sprite.
• Pickup Enabled — Allows the Prop to be picked up.
• Pickup Reach — Maximum distance at which the Prop can be picked up.
• Carry Distance — Distance between the player and the carried Prop.
• Carry Offset — Positional offset applied while carrying.
• Drop Velocity — Forward velocity applied when dropping the Prop.
• Drop Angular Velocity — Rotational velocity applied when dropping the Prop.
• Disabled — Disables the Prop.

Physics:

• Physics Enabled — Enables lightweight Prop physics.
• Mass — Physical mass of the Prop.
• Gravity — Applies gravity while the Prop is physically active.
• Friction — Controls friction against the floor.
• Linear Damping — Reduces linear movement over time.
• Angular Damping — Reduces rotational movement over time.
• Collision Shape — Defines the Prop's collision shape.
• Collision Size — Defines the dimensions of the collision volume.
• No Collision — Disables collision handling for the Prop.

Inputs

• Pickup — Picks up the Prop.
• Drop — Releases the Prop.

Outputs

• OnPickedUp — Fired when the Prop is picked up.
• OnDropped — Fired when the Prop is dropped.
• OnRest — Fired when the Prop comes to rest.