IMM_HOUSEEDIT
Keywords: IMM_HOUSEEDIT, WIZ_HOUSEEDIT
=== STAFF MANUAL ===
Usage: houseedit list
houseedit show [<#>]
houseedit create [<owner>]
houseedit <#> set owner <name | 0>
houseedit <#> set policy <Rent | Mortgage | Owned>
houseedit <#> set payment <amount>
houseedit <#> set owed <amount>
houseedit <#> set paid <amount>
houseedit <#> addroom [<vid>]
houseedit <#> removeroom [<vid>]
houseedit <#> resetpaymentdue
houseedit <#> markpaymentpaid
houseedit <#> delete [<confirmation>]
Description:
Administrative front end for the house system. Every
command is routed through a house ID (shown by houseedit list),
and every modification is written straight to the house's data
file, so changes survive reboots. All destructive actions are
logged to the staff wiznet as "(GC) HOUSE <id>: <name> <action>".
Read-Only Subcommands:
list .................... List every house with its ID,
owner, and current status. Available
to any staff -- no houses permission
required.
show [<#>] .............. Dump a single house's details. If
you omit the ID, the room you are
standing in is used; if the room is
not part of any house, the command
reports "No house found, and you are
not in a house.". Available to any
staff.
Creation:
create [<owner>] ........ Allocate a new house record and
print its new ID. If an owner name is
supplied, the owner is set in the same
step. Houses created without an owner
are left unassigned until a subsequent
set owner.
Owner / Policy / Money:
All set subcommands require you to be physically standing
in the house you are editing. The game enforces this with:
As a safety precaution, you must actually be
in the house to use this command.
set owner <name> ........ Transfer ownership. The last
payment date is reset and the new
owner is removed from the guest list
if they were on it. Passing 0 as the
name clears ownership entirely.
set policy <type> ...... Choose between Rent, Mortgage,
or Owned. The game prints a reminder
to double-check the matching money
fields after changing the policy.
set payment <amount> ... Set the weekly payment. Must be
a non-negative integer.
set owed <amount> ...... Set the remaining balance owed.
Non-negative.
set paid <amount> ...... Set the amount paid to date.
Non-negative.
Room Membership:
addroom [<vid>] ........ Attach a room to the house. Omit
the vid to add your current room. The
room must not already belong to any
other house.
removeroom [<vid>] ..... Detach a room. Omit the vid to
remove your current room. The room
must currently belong to this house.
Payment Shortcuts:
resetpaymentdue ........ Force the next payment to be due
immediately. Useful for testing rent
cycles. You must be inside the house.
markpaymentpaid ........ Mark the next payment as already
made. You must be inside the house.
Deletion:
delete .................. Two-step confirmation. The first
invocation prints a confirmation code
-- the house's memory address in hex
-- and a warning to notify and
reimburse the owner:
WARNING: Before deleting a house, please make
sure to notify the player, and reimburse them
if necessary.
To delete house <#>, type the following command:
houseedit <#> delete <code>
Echoing the exact code back runs the deletion. The house's
data file is renamed to <filename>.deleted rather than
erased, so the record can be recovered out-of-band if a
mistake is made.
Restrictions:
- list and show are available to any staff member.
- Every other subcommand requires the Houses staff
permission. Staff without it see only the list/show usage
block.
- All set subcommands, resetpaymentdue, and
markpaymentpaid further require you to stand inside
the house you are editing.
Related Helpfiles: HOUSES
=== END MANUAL ===