Contingent Documentation

All development conversation and discussion takes place here

Moderator: Moderator

Post Reply
Message
Author
Doctornull
Sher'Tul Godslayer
Posts: 2402
Joined: Tue Jun 18, 2013 10:46 pm
Location: Ambush!

Contingent Documentation

#1 Post by Doctornull »

I've got some talents in my addon which change what they display based on what other talents the character knows.

For example, if you know the Stealth talent, then my talent Sloth will tell you "This talent can never break Stealth."

Is this a desirable thing?
Is there a better trigger condition?

Alternatives could be ...
- Do you have the Stealth category unlocked?
- Do you have the Stealth category visible?

The latter means Adventurers would always see everything, but maybe that's fine, they may need to see everything to make an informed choice.
Check out my addons: Nullpack (classes), Null Tweaks (items & talents), and New Gems fork.

Castler
Thalore
Posts: 153
Joined: Mon Mar 25, 2013 10:09 pm

Re: Contingent Documentation

#2 Post by Castler »

I guess whether or not contingent documentation is a good thing depends a bit on the details.

ToME's documentation is nearly always contingent to some extent, since it displays only the values at your current stats and talent level, rather than giving the details on the formulas involved. So, if the complexity of talents' descriptions is just too great, a little bit of conditional documentation might help clean it up a bit.

In general, though, ToME's design philosophy is to be transparent and give you as much information as you want up front. (For example, you can right-click -> Inspect creature to get full details on an opponent's stats and abilities. In many games, the only way to find out an opponent's abilities is by dying a few times.)

In particular, I believe a talent's tooltips should give enough information to let me make an informed decision. For example, if I don't know that Sloth doesn't break Stealth, I might never spend the category point to unlock Stealth.
Qi Daozei (QDZ) - an Oriental-themed fantasy game for T-Engine. ToME Tips - auto-generated spoilers for ToME.

HousePet
Perspiring Physicist
Posts: 6215
Joined: Sun Sep 09, 2012 7:43 am

Re: Contingent Documentation

#3 Post by HousePet »

Contingent documentation means you are hiding things from players. They tend to resent it when you give them surprises. :(
It also means you need spoiler knowledge to build a character, which is never a good thing.
My feedback meter decays into coding. Give me feedback and I make mods.

Doctornull
Sher'Tul Godslayer
Posts: 2402
Joined: Tue Jun 18, 2013 10:46 pm
Location: Ambush!

Re: Contingent Documentation

#4 Post by Doctornull »

Castler wrote:I guess whether or not contingent documentation is a good thing depends a bit on the details.
Absolutely agree. My addon should be easy to read, if you're interested in the specifics of what I do now.
Castler wrote:In particular, I believe a talent's tooltips should give enough information to let me make an informed decision. For example, if I don't know that Sloth doesn't break Stealth, I might never spend the category point to unlock Stealth.
Makes sense. So, for class talent trees, the category being visible should be the determining factor.

Thanks!
HousePet wrote:Contingent documentation means you are hiding things from players. They tend to resent it when you give them surprises. :(
It also means you need spoiler knowledge to build a character, which is never a good thing.
Yep, so I want to give them enough info to make a good decision, but not clutter up the screen with irrelevant info.

The question is: can I determine what information is irrelevant?
Check out my addons: Nullpack (classes), Null Tweaks (items & talents), and New Gems fork.

Nagyhal
Wyrmic
Posts: 282
Joined: Tue Feb 15, 2011 12:01 am

Re: Contingent Documentation

#5 Post by Nagyhal »

Do it.

In the addon I'm working on, bonus effects for a number of talents were not visible in the tooltip for the upgraded talent.

I've changed that, so in my case I'm moving from a lower level of information to a greater one. Nothing technically is hidden, as from the moment of character birth this information is given away in passive talent descriptions. The difference is that players can now view all active bonus effects from the convenient location of their action bars.

I think that if you understand that the loss of information you fear is actually the default state of most abilities in this game, then you'll feel a lot better about doing what you propose.

PureQuestion
Master Artificer
Posts: 726
Joined: Fri Feb 03, 2012 3:53 am

Re: Contingent Documentation

#6 Post by PureQuestion »

ToME tends to lean towards telling the player absolutely everything, even things this particular character can't use. The idea of hiding irrelevant information is good in theory, but in practice players tend to only read it once, and then assume that they know what it says; if it says something else for their next character, they probably won't think to check.

Doctornull
Sher'Tul Godslayer
Posts: 2402
Joined: Tue Jun 18, 2013 10:46 pm
Location: Ambush!

Re: Contingent Documentation

#7 Post by Doctornull »

PureQuestion wrote:ToME tends to lean towards telling the player absolutely everything, even things this particular character can't use. The idea of hiding irrelevant information is good in theory, but in practice players tend to only read it once, and then assume that they know what it says; if it says something else for their next character, they probably won't think to check.
This is a great point.

Thanks!
Check out my addons: Nullpack (classes), Null Tweaks (items & talents), and New Gems fork.

Post Reply