Blecki
commented
10 years ago I'm trying to decide whether I implement a tag or conditional text system (It would likely be similar to inform), or I just make descriptions optionally a function that returns the description. The latter is far more powerful, and far easier to implement, but it can make simple variations a pain to write. Consider these..
Here is one of your examples:
The door on the westward wall is [wide open[or]shut soundly], [[if open] revealing another nameplate displayed at eye level. Light pours in from the main hallway.]
Here's how it might look with tagging/conditional text:
Long = "... The door on the westward wall is [if Here.Links[west].Door.Open]wide open, revealing another nameplate displayed at eye level. Light pours in from the main hallway[else]shut soundly[end if]."Here's how it might look as a lambda function in C#
Long = (viewer, owner) => {
var builder = new StringBuilder();
builder.Append("...");
if (Links[west].Door.Open) builder.Append("The door on the westward wall is wide open, revealing another nameplate displayed at eye level. Light pours in from the main hallway.")
else builder.Append("The door on the westward wall is shut soundly.");
return builder.ToString();
};The second example is longer and more cumbersome in this case, but it is far more powerful. There's no need to implement a complex tagging or conditional text system which could (if Inform is any indication) become it's own mini programming language. On the other hand, a builder has to be able to do some rudimentary coding.
Trevoke
ghost
This issue is open for the discussion on WRITING STYLE, TONE, and VOICE. This is particularly aimed at rooms and the objects within them currently. Any implementation issues, especially involving code, should be posted in the 'Foundations' issue. Please remain on topic.
So here is a sample room I put together real quick tonight. I did take creative liberties in naming locations, and none of this is actually set in stone. This would be an office room in one of the buildings on a seaside street of the city. It's just an idea of my writing style and tone. I'm welcome to criticism and suggestions, and I'd also like to see some others throw together some examples so we can work on a voice we all agree on.
It always amazes me how long it can take to write a room when you've got so many nuances to adhere to.
I went for something short, but still descriptive to cover the entirety of the room. It definitely could be shortened further; there's a lot of non-critical details, but I feel that only adds. It could also be extended vastly, but again, I tried to meet a fine balance.
If some of the syntax seems a bit weird, that's probably because I'm used to writing in Inform 7 and just used that style for pointing out areas where things would change based on specific flags.
ROOM IGA Clinic, Campana's Office Pristine white walls, empty of decor sans a lonely, framed diploma complement the hardwood floors and immaculate glass desk. A window, taking up just over half of the wall, looks eastward toward the [empty] shoreline, [a full moon gleaming back]. The office is bare; a stack of folders sits atop the unopened box of a new filing cabinet in one corner, a small tree brimming with life in the other. A fluorescent bulb nestled within the fiberglass ceiling tiles illuminates the area; both it and the computer on the floor emit a gentle hum in the otherwise silent room. On the desk sits only a large monitor set off to the side, and an engraved nameplate.
The door on the westward wall is [wide open[or]shut soundly], [[if open] revealing another nameplate displayed at eye level. Light pours in from the main hallway.]
OBJECTS [nameplate]: A polished-gold plate set upon a rich rosewood base. Engraved in dark lettering it reads 'J.S. Campana'. [window]: Overlooking the eastern shoreline, [ocean_sky_random]. [plant]: Potted in a simple, slate-colored bowl, it stands about five feet tall with a head of large, vibrant leaves. [desk]: A smoky-colored glass resting upon thick metal framing. A sliding section is occupied by a keyboard. [monitor (while off)]: The screen is black. An orange LED glows softly along the black frame, indicating the computer is likely off. [monitor (while on, password not entered)]: The screen is displaying a login window atop a pale, blue background. The password field is empty, the key cursor flashing rhythmically, waiting for input. [light]: A hard plastic tile hides the fluorescent bulb lighting the room. [folders]: Stacked hastily atop a box, the manila folders are all empty. [box]: The box is unopened with giant text running along the sides: OFFICE PRO® 22'' VERTICAL FILING CABINET. [floor]: Polished, oak-colored strips run the length of the room, complementing the walls nicely. [wall]: Painted the brightest white, it is devoid of anything but the framed diploma [diploma]: A fancy, mahogany frame displays a prestigious diploma beneath a sheet of glass. It reads:
UNIVERSITY OF NEW ORTIAGO By authority of the board of trustees and upon recommendation of the faculty hereby confers upon JASON SADLER CAMPANA, M.D. the degree of DOCTOR OF PSYCHOLOGY
Following is a large emblem, embossed in gold, and several signatures.
Another option here would be to use some sort of tagging system. I read a good post on it earlier this year here. This might be more useful for someone like @Blecki to look at; I'm not sure how we wish to implement this system.