Zesstra | 5481d49 | 2021-04-08 20:07:06 +0200 | [diff] [blame] | 1 | SYNOPSIS |
| 2 | #include <lwobject_info.h> |
| 3 | |
| 4 | mixed lwobject_info(lwobject lwob, int what) |
| 5 | |
| 6 | DESCRIPTION |
| 7 | Returns some internal information about the lightweight |
| 8 | object <lwob>. The Argument <what> determines which |
| 9 | information is returned. |
| 10 | |
| 11 | It can be either a configuration option as given to |
| 12 | configure_object() or one of the following options: |
| 13 | |
| 14 | |
| 15 | |
| 16 | Lightweight Object Information: |
| 17 | |
| 18 | <what> == LI_LWOBJECT_REFS: |
| 19 | The number of references to <lwob>. |
| 20 | |
| 21 | <what> == LI_DATA_SIZE: |
| 22 | The total size of the values held in the object's variables, |
| 23 | scaled down according to the extend of data sharing. |
| 24 | |
| 25 | <what> == LI_DATA_SIZE_TOTAL: |
| 26 | The unmodified total size of the values held in the |
| 27 | object's variables |
| 28 | |
| 29 | |
| 30 | |
| 31 | Program Flags: |
| 32 | |
| 33 | <what> == LI_NO_INHERIT: |
| 34 | 1 if the program can't be inherited. |
| 35 | |
| 36 | <what> == LI_NO_CLONE: |
| 37 | 1 if the program/blueprint can't be cloned. |
| 38 | |
| 39 | <what> == LI_SHARE_VARIABLES: |
| 40 | 1 if lightweight objects of this program share their |
| 41 | initial variable values with the blueprint. |
| 42 | |
| 43 | |
| 44 | |
| 45 | Program Statistics: |
| 46 | |
| 47 | <what> == LI_PROG_REFS: |
| 48 | The number of references to <lwob>'s program. |
| 49 | |
| 50 | <what> == LI_NUM_FUNCTIONS: |
| 51 | The number of functions in the program. |
| 52 | |
| 53 | <what> == LI_NUM_VARIABLES: |
| 54 | The number of variables in the program. |
| 55 | |
| 56 | <what> == LI_NUM_STRINGS: |
| 57 | The number of strings in the program. |
| 58 | |
| 59 | <what> == LI_NUM_INHERITED: |
| 60 | The number of explicitely inherited programs. |
| 61 | |
| 62 | <what> == LI_NUM_INCLUDED: |
| 63 | The number of included files in the program. |
| 64 | |
| 65 | <what> == LI_SIZE_FUNCTIONS: |
| 66 | The size needed for the function structures. |
| 67 | Note that this does not include size of the function code. |
| 68 | |
| 69 | <what> == LI_SIZE_VARIABLES: |
| 70 | The size needed for the variable structures. |
| 71 | Note that this does not include size of the variable data, |
| 72 | See LI_DATA_SIZE/LI_DATA_SIZE_TOTAL for that. |
| 73 | |
| 74 | <what> == LI_SIZE_STRINGS: |
| 75 | The size needed for the string pointers. |
| 76 | |
| 77 | <what> == LI_SIZE_STRINGS_DATA: |
| 78 | The size needed for the string values, |
| 79 | scaled down according to the extend of data sharing. |
| 80 | |
| 81 | <what> == LI_SIZE_STRINGS_DATA_TOTAL: |
| 82 | The unmodified size needed for the string values. |
| 83 | |
| 84 | <what> == LI_SIZE_INHERITED: |
| 85 | The size needed for the inherit structures. |
| 86 | |
| 87 | <what> == LI_SIZE_INCLUDED: |
| 88 | The size needed for the include structures. |
| 89 | |
| 90 | <what> == LI_PROG_SIZE: |
| 91 | The size of the program structure. |
| 92 | |
| 93 | <what> == LI_PROG_SIZE_TOTAL: |
| 94 | The total size of the program. |
| 95 | |
| 96 | |
| 97 | HISTORY |
| 98 | Introduced in LDMud 3.6.5. |
| 99 | |
| 100 | SEE ALSO |
| 101 | configure_lwobject(E), object_info(E), interactive_info(E), |
| 102 | driver_info(E) |