Inheritance diagram for obj_desc_time_x:
Public Member Functions | |
| time_x | get_intro_date () |
| time_x | get_retire_date () |
| bool | is_available (time_x time) |
| bool | is_future (time_x time) |
| bool | is_retired (time_x time) |
 Public Member Functions inherited from obj_desc_x | |
| string | get_name () |
| bool | is_equal (obj_desc_x other) |
| bool | is_valid () |
Detailed Description
Base class of object descriptors with intro / retire dates.
Definition at line 34 of file api_obj_desc.cc.
Member Function Documentation
◆ get_intro_date()
| time_x obj_desc_time_x::get_intro_date | ( | ) |
- Returns
- introduction date of this object
◆ get_retire_date()
| time_x obj_desc_time_x::get_retire_date | ( | ) |
- Returns
- retirement date of this object
◆ is_available()
| bool obj_desc_time_x::is_available | ( | time_x | time | ) |
- Parameters
-
time to test (0 means no timeline game)
- Returns
- true if available: introduction and retirement date checked
◆ is_future()
| bool obj_desc_time_x::is_future | ( | time_x | time | ) |
- Parameters
-
time to test (0 means no timeline game)
- Returns
- true if not available as intro date is in future
◆ is_retired()
| bool obj_desc_time_x::is_retired | ( | time_x | time | ) |
- Parameters
-
time to test (0 means no timeline game)
- Returns
- true if not available as retirement date already passed
The documentation for this class was generated from the following file:
