Wishes: Difference between revisions

34 bytes removed ,  16:51, 4 November 2020
m
Elevate heading levels to make it easier to find sections while scrolling/skimming
m (add intro text to "Spawning Things" section)
m (Elevate heading levels to make it easier to find sections while scrolling/skimming)
Line 3: Line 3:
A wish is a command that can be executed by the player through a console accessible with a key binding (by default not bound). They are generally considered debug commands, but may also be of use setting up special runs or for whatever else the player would like to use them for.
A wish is a command that can be executed by the player through a console accessible with a key binding (by default not bound). They are generally considered debug commands, but may also be of use setting up special runs or for whatever else the player would like to use them for.


== Binding the wish command ==
= Binding the wish command =


To bind wishing to a key combination:
To bind wishing to a key combination:
Line 17: Line 17:
Now it should be possible to wish from the main view.
Now it should be possible to wish from the main view.


== Usage Notes ==
= Usage Notes =


Most wish commands are strictly case-sensitive. Keep that in mind when using any of the wishes below. For example, wishing <code>dismember:Tail</code> will dismember your tail (if you have a tail), but wishing <code>Dismember:Tail</code> will spawn a [[schematics drafter]] because the latter wish does not exactly match a wish command.
Most wish commands are strictly case-sensitive. Keep that in mind when using any of the wishes below. For example, wishing <code>dismember:Tail</code> will dismember your tail (if you have a tail), but wishing <code>Dismember:Tail</code> will spawn a [[schematics drafter]] because the latter wish does not exactly match a wish command.
Line 25: Line 25:
A very common problem that occurs when a wish goes wrong is that your character will gain an undesirable mutation with a name that is somewhat similar to your wish command. If this happens to you, use the <code>mutationbgone</code> wish to remove the mutation.
A very common problem that occurs when a wish goes wrong is that your character will gain an undesirable mutation with a name that is somewhat similar to your wish command. If this happens to you, use the <code>mutationbgone</code> wish to remove the mutation.


== List of wishes ==
= List of wishes =


Here wishes are sorted into headings based on what they do. Consider using the table of contents at the beginning of this article to jump to a topic of interest.
Here wishes are sorted into headings based on what they do. Consider using the table of contents at the beginning of this article to jump to a topic of interest.
Line 33: Line 33:
'''A note for modders:''' Unless otherwise mentioned, the logic for each wish is handled in the game's <code>Wishing</code> class.{{Code Reference | namespace = XRL.World.Capabilities | class = Wishing}}
'''A note for modders:''' Unless otherwise mentioned, the logic for each wish is handled in the game's <code>Wishing</code> class.{{Code Reference | namespace = XRL.World.Capabilities | class = Wishing}}


=== Special modes ===
== Special modes ==


All special modes are off by default. Once turned on, they remain in effect across game sessions until either they're turned off or the game is closed. They can be turned off by using the same wish that turned them on.
All special modes are off by default. Once turned on, they remain in effect across game sessions until either they're turned off or the game is closed. They can be turned off by using the same wish that turned them on.
Line 56: Line 56:
One special mode, identified in the key mapping menu as {{Qud text|ExploreZone}}, is not accessible through a wish. To access it, follow the instructions for [[#Binding the wish command|binding the wish command]], but substitute {{Qud text|ExploreZone}} in place of {{Qud text|Wish}}. <code>ExploreZone</code> causes the entire zone the player body is in to remain revealed while it's active.
One special mode, identified in the key mapping menu as {{Qud text|ExploreZone}}, is not accessible through a wish. To access it, follow the instructions for [[#Binding the wish command|binding the wish command]], but substitute {{Qud text|ExploreZone}} in place of {{Qud text|Wish}}. <code>ExploreZone</code> causes the entire zone the player body is in to remain revealed while it's active.


=== Character stats and effects ===
== Character stats and effects ==


{{Wish|name=clean|synopsis=Remove all effects and stat penalties from the player body}}
{{Wish|name=clean|synopsis=Remove all effects and stat penalties from the player body}}
Line 126: Line 126:
{{Wish|name=xpverbose|usage=xpverbose:<amount>|synopsis=Grant XP but don't skip level-up popups}}
{{Wish|name=xpverbose|usage=xpverbose:<amount>|synopsis=Grant XP but don't skip level-up popups}}


=== Conversations ===
== Conversations ==


{{Wish|name=conv|usage=conv:<id>[:<speakerblueprint>]|synopsis=Start a conversation}}
{{Wish|name=conv|usage=conv:<id>[:<speakerblueprint>]|synopsis=Start a conversation}}
Line 132: Line 132:
{{Wish|name=convnode|usage=convnode:<id>:<startnode>[:<speakerblueprint>]|synopsis=Start a conversation at a specific node}}
{{Wish|name=convnode|usage=convnode:<id>:<startnode>[:<speakerblueprint>]|synopsis=Start a conversation at a specific node}}


=== Diseases and infections ===
== Diseases and infections ==


{{Wish|name=glotrotonset|synopsis=Give yourself glotrot onset}}
{{Wish|name=glotrotonset|synopsis=Give yourself glotrot onset}}
Line 154: Line 154:
{{Wish|name=curefungus|synopsis=Cure and clean all fungal infections}}
{{Wish|name=curefungus|synopsis=Cure and clean all fungal infections}}


=== Factions ===
== Factions ==


{{Wish|name=clearfactionmembership|synopsis=Clear player's faction membership}}
{{Wish|name=clearfactionmembership|synopsis=Clear player's faction membership}}
Line 164: Line 164:
{{Wish|name=wandermode|synopsis=Become neutral with all hostile factions}}
{{Wish|name=wandermode|synopsis=Become neutral with all hostile factions}}


=== Going places ===
== Going places ==


{{Wish|name=blink|synopsis=Teleport}}
{{Wish|name=blink|synopsis=Teleport}}
Line 189: Line 189:
{{Wish|name=zone|usage=zone:<id>|synopsis=Teleport to a zone based on its ID}}
{{Wish|name=zone|usage=zone:<id>|synopsis=Teleport to a zone based on its ID}}


=== Quests ===
== Quests ==


{{Wish|name=questdebug|synopsis=Open a dialog with quest options}}
{{Wish|name=questdebug|synopsis=Open a dialog with quest options}}
Line 227: Line 227:
{{Wish|name=markofdeath?|synopsis=Check if the mark of death is on or not}}
{{Wish|name=markofdeath?|synopsis=Check if the mark of death is on or not}}


=== Journal Secrets ===
== Journal Secrets ==


{{Wish|name=filljournal|synopsis=Fills the Chronology section of the journal with nonsense.}}
{{Wish|name=filljournal|synopsis=Fills the Chronology section of the journal with nonsense.}}
Line 256: Line 256:
}}
}}


=== Skills ===
== Skills ==


{{Wish|name=axer|synopsis=Add all [[Axe]] skills}}
{{Wish|name=axer|synopsis=Add all [[Axe]] skills}}
Line 272: Line 272:
{{Wish|name=smartass|synopsis=Add all [[Tinkering]] skills and recipes}}
{{Wish|name=smartass|synopsis=Add all [[Tinkering]] skills and recipes}}


=== Spawning things ===
== Spawning things ==


Entering any input that does not exactly match a wish command will perform a lexigraphic search (using a [https://en.wikipedia.org/wiki/Levenshtein_distance Levenshtein distance algorithm]) on object blueprints, mutations, quests, and zones, and attempt the best match it can find.{{Code Reference|namespace=XRL|class=WishSearcher|method=SearchForWish}} Matching on an object blueprint spawns that object; matching on a mutation grants that mutation; matching on a quest begins that quest; and matching on a zone teleports to that zone.
Entering any input that does not exactly match a wish command will perform a lexigraphic search (using a [https://en.wikipedia.org/wiki/Levenshtein_distance Levenshtein distance algorithm]) on object blueprints, mutations, quests, and zones, and attempt the best match it can find.{{Code Reference|namespace=XRL|class=WishSearcher|method=SearchForWish}} Matching on an object blueprint spawns that object; matching on a mutation grants that mutation; matching on a quest begins that quest; and matching on a zone teleports to that zone.
Line 328: Line 328:
{{Wish|name=maxmod|synopsis=Set the mod chance to 999|description=This results in all moddable items, such as weapons, spawning with the maximum number of [[Item Mods|mods]] (3).}}
{{Wish|name=maxmod|synopsis=Set the mod chance to 999|description=This results in all moddable items, such as weapons, spawning with the maximum number of [[Item Mods|mods]] (3).}}


=== Rolling dice ===
== Rolling dice ==


{{Wish|name=roll|usage=roll:<die expression>|synopsis=Roll dice based on a die expression}}
{{Wish|name=roll|usage=roll:<die expression>|synopsis=Roll dice based on a die expression}}
Line 342: Line 342:
{{Wish|name=rollmincached|usage=rollmincached:<dice expression>}}
{{Wish|name=rollmincached|usage=rollmincached:<dice expression>}}


=== Miscellaneous ===
== Miscellaneous ==


{{Wish|name=a|usage=a:<word>|synopsis=Returns "a" or "an" depending on the word entered.}}
{{Wish|name=a|usage=a:<word>|synopsis=Returns "a" or "an" depending on the word entered.}}
Line 527: Line 527:
{{Wish|name=xy|synopsis=Show the player's (X, Y) location}}
{{Wish|name=xy|synopsis=Show the player's (X, Y) location}}


=== Wishes with unlisted functions ===
== Wishes with unlisted functions ==


{{Missing info|What do these wishes do? How are they used?}}
{{Missing info|What do these wishes do? How are they used?}}
Line 555: Line 555:
{{Wish|name=testzoneparse|synopsis=Outputs Zone ID, parse result, and whether it matches on rebuild.}}
{{Wish|name=testzoneparse|synopsis=Outputs Zone ID, parse result, and whether it matches on rebuild.}}


== References ==
= References =


[[Category:Guides]]
[[Category:Guides]]
[[Category:Modding]]
[[Category:Modding]]