iKitchenSink Struct Reference
Interface to interact with a kitchen sink. More...
Public Member Functions
|virtual void||Drain ()=0|
|Drain the water from the sink. |
|virtual float||Fill (float amount)=0|
|Fill a certain amount of water into the sink. |
|virtual bool||GetShredderActive ()=0|
|Retrieve whether the shredder fitted to the drain was enabled. |
|virtual void||Insert (iBase *object)=0|
|Insert an object in the kitchen sink. |
|virtual bool||Remove (iBase *object)=0|
|Remove an object from the kitchen sink. |
|virtual void||SetShredderActive (bool enable)=0|
|Enable or disable the shredder fitted to the drain. |
Interface to interact with a kitchen sink.
- Iterator for contained objects.
Member Function Documentation
|virtual void iKitchenSink::Drain||(||)||
Drain the water from the sink.
- If small objects were inserted, they might get flushed away and (if a shredder is present and enabled) shredded.
|virtual float iKitchenSink::Fill||(||float||amount||)||
|virtual bool iKitchenSink::GetShredderActive||(||)||
Retrieve whether the shredder fitted to the drain was enabled.
|virtual void iKitchenSink::Insert||(||iBase *||object||)||
Insert an object in the kitchen sink.
|virtual bool iKitchenSink::Remove||(||iBase *||object||)||
Remove an object from the kitchen sink.
- Whether the removal succeeded. Failure usually means that it wasn't in the sink in first place.
|virtual void iKitchenSink::SetShredderActive||(||bool||enable||)||
Enable or disable the shredder fitted to the drain.
- May only work in American implementations.
The documentation for this struct was generated from the following file:
Generated for Crystal Space 2.1 by doxygen 1.6.1