StendhalScripting/LuaAPI: Difference between revisions

Jump to navigation Jump to search
Content deleted Content added
imported>AntumDeluge
quests: add descriptions
imported>AntumDeluge
quests.simple: add methods for SimpleQuest class
Line 300: Line 300:
: '''''properName:''''' Human-readable name to be displayed in travel log.
: '''''properName:''''' Human-readable name to be displayed in travel log.
: '''''npcName:''''' The NPC associated with the quest.
: '''''npcName:''''' The NPC associated with the quest.
: ''returns:'' <code>games.stendhal.server.maps.quests.SimpleQuestCreator.SimpleQuest</code> instance.
: ''returns:'' {{StendhalFile|master|src/games/stendhal/server/maps/quests/SimpleQuestCreator.java|SimpleQuest}} instance.


==== SimpleQuest Object ====
==== SimpleQuest Object ====

{{StendhalFile|master|src/games/stendhal/server/maps/quests/SimpleQuestCreator.java|games.stendhal.server.maps.quests.SimpleQuestCreator.SimpleQuest}}

Methods:

; ''<span style="color:green">setDescription</span>(descr)''
:
: '''''descr:''''' (<code>String</code>)

; ''<span style="color:green">setRepeatable</span>(delay)''
:
: '''''delay:''''' (<code>Integer</code>)

; ''<span style="color:green">setItemToCollect</span>(itemName, quantity)''
:
: '''''itemName:''''' (<code>String</code>)
: '''''quantity:''''' (<code>int</code>)

; ''<span style="color:green">setXPReward</span>(xp)''
:
: '''''xp:''''' (<code>int</code>)

; ''<span style="color:green">setKarmaReward</span>(karma)''
:
: '''''karma:''''' (<code>double</code>)

; ''<span style="color:green">setKarmaAcceptReward</span>(karma)''
:
: '''''karma:''''' (<code>double</code>)

; ''<span style="color:green">setKarmaRejectReward</span>(karma)''
:
: '''''karma:''''' (<code>double</code>)

; ''<span style="color:green">addItemReward</span>(itemName, quantity)''
:
: '''''itemName:''''' (<code>String</code>)
: '''''quantity:''''' (<code>int</code>) (optional)

; ''<span style="color:green">addStatReward</span>(id, amount)''
:
: '''''id:''''' (<code>String</code>) See IDs below.
: '''''amount:''''' (<code>int</code>)
:; ''IDs:''
:: '''''xp:'''''
:: '''''def:'''''
:: '''''atk:'''''
:: '''''ratk:'''''

; ''<span style="color:green">setVerboseReward</span>(verbose)''
:
: '''''verbose:''''' (<code>boolean</code>)

; ''<span style="color:green">setReply</span>(id, reply)''
:
: '''''id:''''' (<code>String</code>) See IDs below.
: '''''reply:''''' (<code>String</code>)
:; ''IDs:''
:: '''''request:'''''
:: '''''accept:'''''
:: '''''reject:'''''
:: '''''reward:'''''
:: '''''verbose_reward_prefix:'''''
:: '''''already_active:'''''
:: '''''missing:'''''
:: '''''no_repeat:'''''
:: '''''cooldown_prefix:'''''

; ''<span style="color:green">setRegion</span>(regionName)''
:
: '''''regionName:''''' (<code>String</code>)

Also inherits methods from {{StendhalFile|master|src/games/stendhal/server/maps/quests/AbstractQuest.java|AbstractQuest}}:


Example:
Example: