Osiris/API/CharacterAddToParty - Revision history

Tinkerer: Mention alternatives to use

2018-04-12T06:22:59Z

Mention alternatives to use

← Older revision		Revision as of 06:22, 12 April 2018
Line 6:		Line 6:
	Turning a character into a [[Osiris/API/CharacterRecruitCharacter\|player]] or [[Osiris/API/CharacterAssignToUser\|assigning it to a user]] automatically adds it to the correct party. Since all characters of a single [[Osiris/API/CharacterGetReservedUserID\|user]] must be in the same party and since all characters in a party must be [[Osiris/API/CharacterIsPlayer\|player-controlled]], there is no valid use case to explicitly assign a character to a party.		Turning a character into a [[Osiris/API/CharacterRecruitCharacter\|player]] or [[Osiris/API/CharacterAssignToUser\|assigning it to a user]] automatically adds it to the correct party. Since all characters of a single [[Osiris/API/CharacterGetReservedUserID\|user]] must be in the same party and since all characters in a party must be [[Osiris/API/CharacterIsPlayer\|player-controlled]], there is no valid use case to explicitly assign a character to a party.
	===== Notes =====		===== Notes =====
	* /		* Use [[Osiris/API/AddToParty\|AddToParty]] instead to assign all characters controlled by a particular user to a different party, [[Osiris/API/LeaveParty\|LeaveParty]] to put all of those characters into a new party, or [[Osiris/API/CharacterAssignToUser\|CharacterAssignToUser]] to assign a character to a different user (and hence also their, potentially different, party).
	===== See Also =====		===== See Also =====
	* [[Osiris/API/AddToParty\|AddToParty]]		* [[Osiris/API/AddToParty\|AddToParty]]

Tinkerer at 15:05, 19 December 2017

2017-12-19T15:05:12Z

← Older revision		Revision as of 15:05, 19 December 2017
Line 21:		Line 21:
	* [[Osiris/API/LeaveParty\|LeaveParty]]		* [[Osiris/API/LeaveParty\|LeaveParty]]

	[[Category:Osiris Calls]]		[[Category:Osiris Calls\|CharacterAddToParty]]

Tinkerer: This call should never be used.

2017-11-30T09:55:19Z

This call should never be used.

← Older revision		Revision as of 09:55, 30 November 2017
Line 2:		Line 2:
	* call '''CharacterAddToParty'''(''(CHARACTERGUID)'''''_Character''', ''(CHARACTERGUID)'''''_PartyCharacter''')		* call '''CharacterAddToParty'''(''(CHARACTERGUID)'''''_Character''', ''(CHARACTERGUID)'''''_PartyCharacter''')
	===== Description =====		===== Description =====
	~~Adds the~~ character ~~'''_Character'''~~ to ~~'''_PartyCharacter''''s~~ [[Osiris/API/~~AddToParty~~\|party]].		Deprecated. This is a remnant from DOS1 and should not be used in DOS2.

			Turning a character into a [[Osiris/API/CharacterRecruitCharacter\|player]] or [[Osiris/API/CharacterAssignToUser\|assigning it to a user]] automatically adds it to the correct party. Since all characters of a single [[Osiris/API/CharacterGetReservedUserID\|user]] must be in the same party and since all characters in a party must be [[Osiris/API/CharacterIsPlayer\|player-controlled]], there is no valid use case to explicitly assign a character to a party.
	===== Notes =====		===== Notes =====
	* ~~This call will not do anything if '''_Character''' or '''_PartyCharacter''' is NULL, if '''_PartyCharacter''' is not in any party, or if '''_Character''' is already in another party.~~		* /
	* '''_Character''' must be global.
	* Since characters are automatically added to a party when they get [[Osiris/API/CharacterAssignToUser\|assigned to a user]] or [[Osiris/API/CharacterRecruitCharacter\|recruited]]/[[Osiris/API/CharacterMakePlayer\|made a player]], normally you should never use need nor use this call.
	** This call should only be used to add [[Osiris/API/CharacterIsPlayer\|player-controlled characters]] to a new party after they have been removed from one with [[Osiris/API/CharacterRemoveFromParty\|CharacterRemoveFromParty]]. This '''''must''''' be done in the same [[Osiris_Overview#Osiris_Frames\|frame]] as the one in which the character was removed.
	** Use [[Osiris/API/CharacterRecruitCharacter\|CharacterRecruitCharacter]] instead to recruit NPCs into a party (and make them a player-controlled character at the same time).
	===== See Also =====		===== See Also =====
	* [[Osiris/API/AddToParty\|AddToParty]]		* [[Osiris/API/AddToParty\|AddToParty]]

Tinkerer: More clarifications about (non-)usage of this call

2017-11-29T21:03:49Z

More clarifications about (non-)usage of this call

← Older revision		Revision as of 21:03, 29 November 2017
Line 3:		Line 3:
	===== Description =====		===== Description =====
	Adds the character '''_Character''' to '''_PartyCharacter''''s [[Osiris/API/AddToParty\|party]].		Adds the character '''_Character''' to '''_PartyCharacter''''s [[Osiris/API/AddToParty\|party]].

	~~Normally, you should never use need nor use this call.~~
	===== Notes =====		===== Notes =====
	* This call will not do anything if '''_Character''' or '''_PartyCharacter''' is NULL, if '''_PartyCharacter''' is not in any party, or if '''_Character''' is already in another party.		* This call will not do anything if '''_Character''' or '''_PartyCharacter''' is NULL, if '''_PartyCharacter''' is not in any party, or if '''_Character''' is already in another party.
	* '''_Character''' must be global.		* '''_Character''' must be global.
	* This ~~API~~ should only be used to add [[Osiris/API/CharacterIsPlayer\|player-controlled characters]] to a new party after they have been removed from one with [[Osiris/API/CharacterRemoveFromParty\|CharacterRemoveFromParty]]. This '''''must''''' be done in the same [[Osiris_Overview#Osiris_Frames\|frame]] as the one in which the character was removed.		* Since characters are automatically added to a party when they get [[Osiris/API/CharacterAssignToUser\|assigned to a user]] or [[Osiris/API/CharacterRecruitCharacter\|recruited]]/[[Osiris/API/CharacterMakePlayer\|made a player]], normally you should never use need nor use this call.
	* Use [[Osiris/API/CharacterRecruitCharacter\|CharacterRecruitCharacter]] instead to recruit NPCs into a party (and make them a player-controlled character at the same time).		** This call should only be used to add [[Osiris/API/CharacterIsPlayer\|player-controlled characters]] to a new party after they have been removed from one with [[Osiris/API/CharacterRemoveFromParty\|CharacterRemoveFromParty]]. This '''''must''''' be done in the same [[Osiris_Overview#Osiris_Frames\|frame]] as the one in which the character was removed.
			** Use [[Osiris/API/CharacterRecruitCharacter\|CharacterRecruitCharacter]] instead to recruit NPCs into a party (and make them a player-controlled character at the same time).
	===== See Also =====		===== See Also =====
	* [[Osiris/API/AddToParty\|AddToParty]]		* [[Osiris/API/AddToParty\|AddToParty]]
	* [[Osiris/API/CharacterAddToPlayerCharacter\|CharacterAddToPlayerCharacter]]		* [[Osiris/API/CharacterAddToPlayerCharacter\|CharacterAddToPlayerCharacter]]
			* [[Osiris/API/CharacterAssignToUser\|CharacterAssignToUser]]
	* [[Osiris/API/CharacterIsPartyMember\|CharacterIsPartyMember]]		* [[Osiris/API/CharacterIsPartyMember\|CharacterIsPartyMember]]
	* [[Osiris/API/CharacterIsInPartyWith\|CharacterIsInPartyWith]]		* [[Osiris/API/CharacterIsInPartyWith\|CharacterIsInPartyWith]]

Tinkerer at 14:28, 29 November 2017

2017-11-29T14:28:04Z

← Older revision		Revision as of 14:28, 29 November 2017
Line 9:		Line 9:
	* '''_Character''' must be global.		* '''_Character''' must be global.
	* This API should only be used to add [[Osiris/API/CharacterIsPlayer\|player-controlled characters]] to a new party after they have been removed from one with [[Osiris/API/CharacterRemoveFromParty\|CharacterRemoveFromParty]]. This '''''must''''' be done in the same [[Osiris_Overview#Osiris_Frames\|frame]] as the one in which the character was removed.		* This API should only be used to add [[Osiris/API/CharacterIsPlayer\|player-controlled characters]] to a new party after they have been removed from one with [[Osiris/API/CharacterRemoveFromParty\|CharacterRemoveFromParty]]. This '''''must''''' be done in the same [[Osiris_Overview#Osiris_Frames\|frame]] as the one in which the character was removed.
	* Use [[Osiris/API/CharacterRecruitCharacter\|CharacterRecruitCharacter]] instead to recruit NPCs into a party (and make them a player).		* Use [[Osiris/API/CharacterRecruitCharacter\|CharacterRecruitCharacter]] instead to recruit NPCs into a party (and make them a player-controlled character at the same time).
	===== See Also =====		===== See Also =====
	* [[Osiris/API/AddToParty\|AddToParty]]		* [[Osiris/API/AddToParty\|AddToParty]]

Tinkerer: Clarified that this is no substitute for CharacterRecruitCharacter, and updated usage notes

2017-11-29T14:27:46Z

Clarified that this is no substitute for CharacterRecruitCharacter, and updated usage notes

← Older revision		Revision as of 14:27, 29 November 2017
Line 8:		Line 8:
	* This call will not do anything if '''_Character''' or '''_PartyCharacter''' is NULL, if '''_PartyCharacter''' is not in any party, or if '''_Character''' is already in another party.		* This call will not do anything if '''_Character''' or '''_PartyCharacter''' is NULL, if '''_PartyCharacter''' is not in any party, or if '''_Character''' is already in another party.
	* '''_Character''' must be global.		* '''_Character''' must be global.
	* ~~The difference~~ with [[Osiris/API/~~CharacterRecruitCharacter~~\|~~CharacterRecruitCharacter~~]] ~~is that this call does~~ ''~~not~~'' ~~turn '''_Character''' into a player character (although~~ '''~~_Character~~''' ~~can~~ be ~~a player character). In principle,~~ the ~~underlying routine supports adding individual totems, summons and plain NPCs to~~ the ~~party (as long as they are global,~~ which ~~makes it rather impractical for totems and summons)~~.		* This API should only be used to add [[Osiris/API/CharacterIsPlayer\|player-controlled characters]] to a new party after they have been removed from one with [[Osiris/API/CharacterRemoveFromParty\|CharacterRemoveFromParty]]. This '''''must''''' be done in the same [[Osiris_Overview#Osiris_Frames\|frame]] as the one in which the character was removed.
	** Adding NPCs to a party is not supported though, and will result in unpredictable behaviour. Doing so will probably trigger an assert or failure in future versions.		* Use [[Osiris/API/CharacterRecruitCharacter\|CharacterRecruitCharacter]] instead to recruit NPCs into a party (and make them a player).
	** The only scenario in which this call is useful, and indeed mandatory, is if you remove a [[Osiris/API/~~CharacterIsPlayer~~\|~~player-controlled character~~]] ~~from a party using [[Osiris/API/CharacterRemoveFromParty\|CharacterRemoveFromParty]] first. You then must add it~~ to a ~~new~~ party ~~again in the same frame, or many things may go wrong~~ (~~the engine assumes~~ player ~~characters are always in a party~~).
	===== See Also =====		===== See Also =====
	* [[Osiris/API/AddToParty\|AddToParty]]		* [[Osiris/API/AddToParty\|AddToParty]]

Tinkerer: Fixed parameter types

2017-11-29T12:28:28Z

Fixed parameter types

← Older revision		Revision as of 12:28, 29 November 2017
Line 1:		Line 1:
	===== Full Definition(s) =====		===== Full Definition(s) =====
	* call '''CharacterAddToParty'''(''(~~INTEGER~~)'''''_Character''', ''(~~INTEGER~~)'''''_PartyCharacter''')		* call '''CharacterAddToParty'''(''(CHARACTERGUID)'''''_Character''', ''(CHARACTERGUID)'''''_PartyCharacter''')
	===== Description =====		===== Description =====
	Adds the character '''_Character''' to '''_PartyCharacter''''s [[Osiris/API/AddToParty\|party]].		Adds the character '''_Character''' to '''_PartyCharacter''''s [[Osiris/API/AddToParty\|party]].
Line 9:		Line 9:
	* '''_Character''' must be global.		* '''_Character''' must be global.
	* The difference with [[Osiris/API/CharacterRecruitCharacter\|CharacterRecruitCharacter]] is that this call does ''not'' turn '''_Character''' into a player character (although '''_Character''' can be a player character). In principle, the underlying routine supports adding individual totems, summons and plain NPCs to the party (as long as they are global, which makes it rather impractical for totems and summons).		* The difference with [[Osiris/API/CharacterRecruitCharacter\|CharacterRecruitCharacter]] is that this call does ''not'' turn '''_Character''' into a player character (although '''_Character''' can be a player character). In principle, the underlying routine supports adding individual totems, summons and plain NPCs to the party (as long as they are global, which makes it rather impractical for totems and summons).
	** Adding ~~non-player~~ NPCs to a party is not supported though, and will result in unpredictable behaviour. Doing so will probably trigger an assert or failure in future versions.		** Adding NPCs to a party is not supported though, and will result in unpredictable behaviour. Doing so will probably trigger an assert or failure in future versions.
	** The only scenario in which this call is useful, and indeed mandatory, is if you remove a [[Osiris/API/CharacterIsPlayer\|player-controlled character]] from a party using [[Osiris/API/CharacterRemoveFromParty\|CharacterRemoveFromParty]] first. You then must add it to a new party again in the same frame, or many things may go wrong (the engine assumes player characters are always in a party).		** The only scenario in which this call is useful, and indeed mandatory, is if you remove a [[Osiris/API/CharacterIsPlayer\|player-controlled character]] from a party using [[Osiris/API/CharacterRemoveFromParty\|CharacterRemoveFromParty]] first. You then must add it to a new party again in the same frame, or many things may go wrong (the engine assumes player characters are always in a party).
	===== See Also =====		===== See Also =====

Tinkerer: Mention that this call is normally never needed.

2017-11-29T11:51:18Z

Mention that this call is normally never needed.

← Older revision		Revision as of 11:51, 29 November 2017
Line 3:		Line 3:
	===== Description =====		===== Description =====
	Adds the character '''_Character''' to '''_PartyCharacter''''s [[Osiris/API/AddToParty\|party]].		Adds the character '''_Character''' to '''_PartyCharacter''''s [[Osiris/API/AddToParty\|party]].

			Normally, you should never use need nor use this call.
	===== Notes =====		===== Notes =====
	* This call will not do anything if '''_Character''' or '''_PartyCharacter''' is NULL, if '''_PartyCharacter''' is not in any party, or if '''_Character''' is already in another party.		* This call will not do anything if '''_Character''' or '''_PartyCharacter''' is NULL, if '''_PartyCharacter''' is not in any party, or if '''_Character''' is already in another party.

Tinkerer: Mention use-case for CharacterAddToParty

2017-11-29T11:50:25Z

Mention use-case for CharacterAddToParty

← Older revision		Revision as of 11:50, 29 November 2017
Line 8:		Line 8:
	* The difference with [[Osiris/API/CharacterRecruitCharacter\|CharacterRecruitCharacter]] is that this call does ''not'' turn '''_Character''' into a player character (although '''_Character''' can be a player character). In principle, the underlying routine supports adding individual totems, summons and plain NPCs to the party (as long as they are global, which makes it rather impractical for totems and summons).		* The difference with [[Osiris/API/CharacterRecruitCharacter\|CharacterRecruitCharacter]] is that this call does ''not'' turn '''_Character''' into a player character (although '''_Character''' can be a player character). In principle, the underlying routine supports adding individual totems, summons and plain NPCs to the party (as long as they are global, which makes it rather impractical for totems and summons).
	** Adding non-player NPCs to a party is not supported though, and will result in unpredictable behaviour. Doing so will probably trigger an assert or failure in future versions.		** Adding non-player NPCs to a party is not supported though, and will result in unpredictable behaviour. Doing so will probably trigger an assert or failure in future versions.
			** The only scenario in which this call is useful, and indeed mandatory, is if you remove a [[Osiris/API/CharacterIsPlayer\|player-controlled character]] from a party using [[Osiris/API/CharacterRemoveFromParty\|CharacterRemoveFromParty]] first. You then must add it to a new party again in the same frame, or many things may go wrong (the engine assumes player characters are always in a party).
	===== See Also =====		===== See Also =====
	* [[Osiris/API/AddToParty\|AddToParty]]		* [[Osiris/API/AddToParty\|AddToParty]]

Tinkerer: Mention that adding non-player NPCs to a party is not supported.

2017-11-29T08:53:51Z

Mention that adding non-player NPCs to a party is not supported.

← Older revision		Revision as of 08:53, 29 November 2017
Line 7:		Line 7:
	* '''_Character''' must be global.		* '''_Character''' must be global.
	* The difference with [[Osiris/API/CharacterRecruitCharacter\|CharacterRecruitCharacter]] is that this call does ''not'' turn '''_Character''' into a player character (although '''_Character''' can be a player character). In principle, the underlying routine supports adding individual totems, summons and plain NPCs to the party (as long as they are global, which makes it rather impractical for totems and summons).		* The difference with [[Osiris/API/CharacterRecruitCharacter\|CharacterRecruitCharacter]] is that this call does ''not'' turn '''_Character''' into a player character (although '''_Character''' can be a player character). In principle, the underlying routine supports adding individual totems, summons and plain NPCs to the party (as long as they are global, which makes it rather impractical for totems and summons).
			** Adding non-player NPCs to a party is not supported though, and will result in unpredictable behaviour. Doing so will probably trigger an assert or failure in future versions.
	===== See Also =====		===== See Also =====
	* [[Osiris/API/AddToParty\|AddToParty]]		* [[Osiris/API/AddToParty\|AddToParty]]

← Older revision		Revision as of 21:03, 29 November 2017
Line 3:		Line 3:
	===== Description =====		===== Description =====
	Adds the character '''_Character''' to '''_PartyCharacter''''s [[Osiris/API/AddToParty\|party]].		Adds the character '''_Character''' to '''_PartyCharacter''''s [[Osiris/API/AddToParty\|party]].

	~~Normally, you should never use need nor use this call.~~
	===== Notes =====		===== Notes =====
	* This call will not do anything if '''_Character''' or '''_PartyCharacter''' is NULL, if '''_PartyCharacter''' is not in any party, or if '''_Character''' is already in another party.		* This call will not do anything if '''_Character''' or '''_PartyCharacter''' is NULL, if '''_PartyCharacter''' is not in any party, or if '''_Character''' is already in another party.
	* '''_Character''' must be global.		* '''_Character''' must be global.
	* This ~~API~~ should only be used to add [[Osiris/API/CharacterIsPlayer\|player-controlled characters]] to a new party after they have been removed from one with [[Osiris/API/CharacterRemoveFromParty\|CharacterRemoveFromParty]]. This '''''must''''' be done in the same [[Osiris_Overview#Osiris_Frames\|frame]] as the one in which the character was removed.		* Since characters are automatically added to a party when they get [[Osiris/API/CharacterAssignToUser\|assigned to a user]] or [[Osiris/API/CharacterRecruitCharacter\|recruited]]/[[Osiris/API/CharacterMakePlayer\|made a player]], normally you should never use need nor use this call.
	* Use [[Osiris/API/CharacterRecruitCharacter\|CharacterRecruitCharacter]] instead to recruit NPCs into a party (and make them a player-controlled character at the same time).		** This call should only be used to add [[Osiris/API/CharacterIsPlayer\|player-controlled characters]] to a new party after they have been removed from one with [[Osiris/API/CharacterRemoveFromParty\|CharacterRemoveFromParty]]. This '''''must''''' be done in the same [[Osiris_Overview#Osiris_Frames\|frame]] as the one in which the character was removed.
			** Use [[Osiris/API/CharacterRecruitCharacter\|CharacterRecruitCharacter]] instead to recruit NPCs into a party (and make them a player-controlled character at the same time).
	===== See Also =====		===== See Also =====
	* [[Osiris/API/AddToParty\|AddToParty]]		* [[Osiris/API/AddToParty\|AddToParty]]
	* [[Osiris/API/CharacterAddToPlayerCharacter\|CharacterAddToPlayerCharacter]]		* [[Osiris/API/CharacterAddToPlayerCharacter\|CharacterAddToPlayerCharacter]]
			* [[Osiris/API/CharacterAssignToUser\|CharacterAssignToUser]]
	* [[Osiris/API/CharacterIsPartyMember\|CharacterIsPartyMember]]		* [[Osiris/API/CharacterIsPartyMember\|CharacterIsPartyMember]]
	* [[Osiris/API/CharacterIsInPartyWith\|CharacterIsInPartyWith]]		* [[Osiris/API/CharacterIsInPartyWith\|CharacterIsInPartyWith]]