/datum/component/rename
The rename component.
This component is used to manage names and descriptions changed with the pen.
Atoms can only have one instance of this component at a time.
When a player renames or changes the description of an atom with a pen, this component gets applied to it. If a player resets the name and description, they will be reverted to their state before being changed and the component will be removed.
Vars | |
| custom_desc | The desc the player is applying to the parent. |
|---|---|
| custom_name | The name the player is applying to the parent. |
| original_desc | The desc before the player changed it. |
| original_name | The name before the player changed it. |
Procs | |
| InheritComponent | This proc will fire after the parent's name or desc is changed with a pen, which is trying to apply another rename component. Since the parent already has a rename component, it will remove the old one and apply the new one. The name and description changes will be merged or overwritten. |
| apply_rename | Saves the current name and description before changing them to the player's inputs. |
| revert_rename | Reverts the name and description to the state before they were changed. |
Var Details
custom_desc
The desc the player is applying to the parent.
custom_name
The name the player is applying to the parent.
original_desc
The desc before the player changed it.
original_name
The name before the player changed it.
Proc Details
InheritComponent
This proc will fire after the parent's name or desc is changed with a pen, which is trying to apply another rename component. Since the parent already has a rename component, it will remove the old one and apply the new one. The name and description changes will be merged or overwritten.
apply_rename
Saves the current name and description before changing them to the player's inputs.
revert_rename
Reverts the name and description to the state before they were changed.