Osiris/API/ItemSetStoryItem - Revision history

Tinkerer: /* Full Definition(s) */

2021-07-12T09:51:26Z

Full Definition(s)

← Older revision		Revision as of 09:51, 12 July 2021
Line 1:		Line 1:
	===== Full Definition(s) =====		===== Full Definition(s) =====
	* call '''ItemSetStoryItem'''(''(~~CHARACTERGUID~~)'''''~~_Character~~''', ''(INTEGER)'''''_Bool''')		* call '''ItemSetStoryItem'''(''(ITEMGUID)'''''_Item''', ''(INTEGER)'''''_Bool''')

	===== Description =====		===== Description =====
	Sets or clears the ''story item'' flag on an item. When an item is a story item, the following special behaviours apply to it:		Sets or clears the ''story item'' flag on an item. When an item is a story item, the following special behaviours apply to it:

Tinkerer at 06:13, 8 April 2019

2019-04-08T06:13:18Z

← Older revision		Revision as of 06:13, 8 April 2019
Line 8:		Line 8:
	* NPCs will never consume the item (e.g. in combat)		* NPCs will never consume the item (e.g. in combat)
	* When a trader NPC dies, its inventory will normally be culled except for the top five most expensive items. Story items, however, will never be deleted in this process.		* When a trader NPC dies, its inventory will normally be culled except for the top five most expensive items. Story items, however, will never be deleted in this process.
	* The [[Osiris/API/TransferItemsToCharacter\|TransferItemsToCharacter]], [[Osiris/API/TransferItemsToParty\|TransferItemsToParty]], and [[Osiris/API/TransferItemsToUser\|TransferItemsToUser]] APIs will only transfer story items
	* It changes the alignment of the item to "Story", which is always forced to be neutral to all other alignments. This forced alignment change will be removed in future games, but not in DOS2		* It changes the alignment of the item to "Story", which is always forced to be neutral to all other alignments. This forced alignment change will be removed in future games, but not in DOS2
	===== Notes =====		===== Notes =====
	* An item can also be marked as a story item in the properties of the item via the editor's sidebar.		* An item can also be marked as a story item in the properties of the item via the editor's sidebar.
			* The [[Osiris/API/TransferItemsToCharacter\|TransferItemsToCharacter]], [[Osiris/API/TransferItemsToParty\|TransferItemsToParty]], and [[Osiris/API/TransferItemsToUser\|TransferItemsToUser]] APIs will only transfer story items
	===== See Also =====		===== See Also =====
	* [[Osiris/API/ItemIsStoryItem\|~~ItemGetIsStoryItem~~]]		* [[Osiris/API/ItemIsStoryItem\|ItemIsStoryItem]]
	* [[Osiris/API/TransferItemsToCharacter\|TransferItemsToCharacter]]		* [[Osiris/API/TransferItemsToCharacter\|TransferItemsToCharacter]]
	* [[Osiris/API/TransferItemsToParty\|TransferItemsToParty]]		* [[Osiris/API/TransferItemsToParty\|TransferItemsToParty]]

Tinkerer at 06:12, 8 April 2019

2019-04-08T06:12:52Z

← Older revision		Revision as of 06:12, 8 April 2019
Line 13:		Line 13:
	* An item can also be marked as a story item in the properties of the item via the editor's sidebar.		* An item can also be marked as a story item in the properties of the item via the editor's sidebar.
	===== See Also =====		===== See Also =====
	* [[Osiris/API/~~ItemGetIsStoryItem~~\|ItemGetIsStoryItem]]		* [[Osiris/API/ItemIsStoryItem\|ItemGetIsStoryItem]]
	* [[Osiris/API/TransferItemsToCharacter\|TransferItemsToCharacter]]		* [[Osiris/API/TransferItemsToCharacter\|TransferItemsToCharacter]]
	* [[Osiris/API/TransferItemsToParty\|TransferItemsToParty]]		* [[Osiris/API/TransferItemsToParty\|TransferItemsToParty]]

Tinkerer at 06:10, 8 April 2019

2019-04-08T06:10:58Z

← Older revision		Revision as of 06:10, 8 April 2019
Line 9:		Line 9:
	* When a trader NPC dies, its inventory will normally be culled except for the top five most expensive items. Story items, however, will never be deleted in this process.		* When a trader NPC dies, its inventory will normally be culled except for the top five most expensive items. Story items, however, will never be deleted in this process.
	* The [[Osiris/API/TransferItemsToCharacter\|TransferItemsToCharacter]], [[Osiris/API/TransferItemsToParty\|TransferItemsToParty]], and [[Osiris/API/TransferItemsToUser\|TransferItemsToUser]] APIs will only transfer story items		* The [[Osiris/API/TransferItemsToCharacter\|TransferItemsToCharacter]], [[Osiris/API/TransferItemsToParty\|TransferItemsToParty]], and [[Osiris/API/TransferItemsToUser\|TransferItemsToUser]] APIs will only transfer story items
	* It changes the alignment of the item to "Story", which is always forced to be neutral to all other alignments. This forced alignment change will be removed in future games, not in DOS2		* It changes the alignment of the item to "Story", which is always forced to be neutral to all other alignments. This forced alignment change will be removed in future games, but not in DOS2
	===== Notes =====		===== Notes =====
	* An item can also be marked as a story item in the properties of the item via the editor's sidebar.		* An item can also be marked as a story item in the properties of the item via the editor's sidebar.

Tinkerer at 15:18, 4 April 2019

2019-04-04T15:18:32Z

← Older revision		Revision as of 15:18, 4 April 2019
Line 9:		Line 9:
	* When a trader NPC dies, its inventory will normally be culled except for the top five most expensive items. Story items, however, will never be deleted in this process.		* When a trader NPC dies, its inventory will normally be culled except for the top five most expensive items. Story items, however, will never be deleted in this process.
	* The [[Osiris/API/TransferItemsToCharacter\|TransferItemsToCharacter]], [[Osiris/API/TransferItemsToParty\|TransferItemsToParty]], and [[Osiris/API/TransferItemsToUser\|TransferItemsToUser]] APIs will only transfer story items		* The [[Osiris/API/TransferItemsToCharacter\|TransferItemsToCharacter]], [[Osiris/API/TransferItemsToParty\|TransferItemsToParty]], and [[Osiris/API/TransferItemsToUser\|TransferItemsToUser]] APIs will only transfer story items
	* It changes the alignment of the item to "Story", which is always forced to be neutral to all other alignments. This will ~~change~~ in future games, not ~~for~~ DOS2		* It changes the alignment of the item to "Story", which is always forced to be neutral to all other alignments. This forced alignment change will be removed in future games, not in DOS2
	===== Notes =====		===== Notes =====
	* An item can also be marked as a story item in the properties of the item via the editor's sidebar.		* An item can also be marked as a story item in the properties of the item via the editor's sidebar.

Tinkerer at 15:18, 4 April 2019

2019-04-04T15:18:02Z

← Older revision		Revision as of 15:18, 4 April 2019
Line 3:		Line 3:
	===== Description =====		===== Description =====
	Sets or clears the ''story item'' flag on an item. When an item is a story item, the following special behaviours apply to it:		Sets or clears the ''story item'' flag on an item. When an item is a story item, the following special behaviours apply to it:
	* it cannot be marked as ~~junk~~, nor can any container that contains it be marked as ~~junk~~, nor can it be added to the ~~junk~~ when picking it up		* it cannot be marked as wares, nor can any container that contains it be marked as wares, nor can it be added to the wares when picking it up
	* it is marked as a quest item in the UI		* it is marked as a quest item in the UI
	* it cannot be traded to an NPC, and NPCs won't sell it either		* it cannot be traded to an NPC, and NPCs won't sell it either

Tinkerer: Documented ItemSetStoryItem

2019-04-04T15:12:09Z

Documented ItemSetStoryItem

New page

===== Full Definition(s) =====
* call '''ItemSetStoryItem'''(''(CHARACTERGUID)'''''_Character''', ''(INTEGER)'''''_Bool''')
===== Description =====
Sets or clears the ''story item'' flag on an item. When an item is a story item, the following special behaviours apply to it:
* it cannot be marked as junk, nor can any container that contains it be marked as junk, nor can it be added to the junk when picking it up
* it is marked as a quest item in the UI
* it cannot be traded to an NPC, and NPCs won't sell it either
* NPCs will never consume the item (e.g. in combat)
* When a trader NPC dies, its inventory will normally be culled except for the top five most expensive items. Story items, however, will never be deleted in this process.
* The [[Osiris/API/TransferItemsToCharacter|TransferItemsToCharacter]], [[Osiris/API/TransferItemsToParty|TransferItemsToParty]], and [[Osiris/API/TransferItemsToUser|TransferItemsToUser]] APIs will only transfer story items
* It changes the alignment of the item to "Story", which is always forced to be neutral to all other alignments. This will change in future games, not for DOS2
===== Notes =====
* An item can also be marked as a story item in the properties of the item via the editor's sidebar.
===== See Also =====
* [[Osiris/API/ItemGetIsStoryItem|ItemGetIsStoryItem]]
* [[Osiris/API/TransferItemsToCharacter|TransferItemsToCharacter]]
* [[Osiris/API/TransferItemsToParty|TransferItemsToParty]]
* [[Osiris/API/TransferItemsToUser|TransferItemsToUser]]

[[Category:Osiris Calls|ItemSetStoryItem]]