Osiris/API/CharacterSetForceSynch - Revision history

Tinkerer at 07:38, 22 February 2019

2019-02-22T07:38:49Z

← Older revision		Revision as of 07:38, 22 February 2019
Line 2:		Line 2:
	* call '''CharacterSetForceSynch'''(''(CHARACTERGUID)'''''_Character''', ''(INTEGER)'''''_Bool''')		* call '''CharacterSetForceSynch'''(''(CHARACTERGUID)'''''_Character''', ''(INTEGER)'''''_Bool''')
	===== Description =====		===== Description =====
	Characters are only synchronised between the server (the game logic) and the client (the presentation) if at least one player character is "nearby" (currently: within 30 meters). This routine can be used to force '''_Character''' to be synchronised even if no player ~~character~~ are nearby, by passing '''1''' as '''_Bool'''. Once the character no longer needs to be force-synchronised, you can make its synchronisation again depend on the nearness of a player character by calling it with '''0''' as '''_Bool'''.		Characters are only synchronised between the server (the game logic) and the client (the presentation) if at least one player character is "nearby" (currently: within 30 meters). This routine can be used to force '''_Character''' to be synchronised even if no player characters are nearby, by passing '''1''' as '''_Bool'''. Once the character no longer needs to be force-synchronised, you can make its synchronisation again depend on the nearness of a player character by calling it with '''0''' as '''_Bool'''.
	===== Notes =====		===== Notes =====
	* Synchronisation is only important in special cases. For example, a character's linked ghost will only be visible if the character itself is active. So if the character's corpse is far away, you have to force synchronise it for its ghost to show up. Another use case is when forcing the camera to a location far away from the players, in which case you may have to force synch characters in that far-away location if you want them to be visible.		* Synchronisation is only important in special cases. For example, a character's linked ghost will only be visible if the character itself is active. So if the character's corpse is far away, you have to force synchronise it for its ghost to show up. Another use case is when forcing the camera to a location far away from the players, in which case you may have to force synch characters in that far-away location if you want them to be visible.

Tinkerer: CharacterSetForceSynch does not use an internal counter

2018-10-24T07:58:40Z

CharacterSetForceSynch does not use an internal counter

← Older revision		Revision as of 07:58, 24 October 2018
Line 9:		Line 9:
	* As the name and declaration imply, this cannot be used for items. You can use [[Osiris/API/ItemSetForceSynch\|ItemSetForceSynch]] for them instead, with the same caveats.		* As the name and declaration imply, this cannot be used for items. You can use [[Osiris/API/ItemSetForceSynch\|ItemSetForceSynch]] for them instead, with the same caveats.
	* Off-stage characters cannot be force-synchronised (it may appear to work, but will stop when saving/reloading).		* Off-stage characters cannot be force-synchronised (it may appear to work, but will stop when saving/reloading).
	* ~~This~~ call ~~increases~~ an internal counter ~~tied~~ to the ~~object every time you enable~~ force-~~synchronising and decreases it again when you disable it~~. ~~Force~~-synchronisation ~~only gets~~ disabled ~~when~~ the ~~counter is at zero (which is its initial~~ value).		* Unlike [[Osiris/API/CharacterSetForceUpdate\|CharacterSetForceUpdate]], this call does not use an internal counter to track the number of times force-synchornisation has been enabled/disabled. This means that force-synchronisation for the character is always immediately enabled/disabled based on the value passed to this routine.
	===== See Also =====		===== See Also =====
	* [[Osiris/API/CharacterSetForceUpdate\|CharacterSetForceUpdate]]		* [[Osiris/API/CharacterSetForceUpdate\|CharacterSetForceUpdate]]
	* [[Osiris/API/ItemSetForceSynch\|ItemSetForceSynch]]		* [[Osiris/API/ItemSetForceSynch\|ItemSetForceSynch]]

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

Tinkerer at 15:19, 19 December 2017

2017-12-19T15:19:22Z

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

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

Tinkerer at 10:28, 23 November 2017

2017-11-23T10:28:53Z

← Older revision		Revision as of 10:28, 23 November 2017
Line 9:		Line 9:
	* As the name and declaration imply, this cannot be used for items. You can use [[Osiris/API/ItemSetForceSynch\|ItemSetForceSynch]] for them instead, with the same caveats.		* As the name and declaration imply, this cannot be used for items. You can use [[Osiris/API/ItemSetForceSynch\|ItemSetForceSynch]] for them instead, with the same caveats.
	* Off-stage characters cannot be force-synchronised (it may appear to work, but will stop when saving/reloading).		* Off-stage characters cannot be force-synchronised (it may appear to work, but will stop when saving/reloading).
	* This call increases an internal counter every time you enable force-synchronising and decreases it again when you disable it. Force-synchronisation only gets disabled when the counter is at zero (which is its initial value).		* This call increases an internal counter tied to the object every time you enable force-synchronising and decreases it again when you disable it. Force-synchronisation only gets disabled when the counter is at zero (which is its initial value).
	===== See Also =====		===== See Also =====
	* [[Osiris/API/CharacterSetForceUpdate\|CharacterSetForceUpdate]]		* [[Osiris/API/CharacterSetForceUpdate\|CharacterSetForceUpdate]]

Tinkerer: ForceSynch does not require making a character active; mention that force-synching uses an internal counter

2017-11-23T10:27:47Z

ForceSynch does not require making a character active; mention that force-synching uses an internal counter

← Older revision		Revision as of 10:27, 23 November 2017
Line 4:		Line 4:
	Characters are only synchronised between the server (the game logic) and the client (the presentation) if at least one player character is "nearby" (currently: within 30 meters). This routine can be used to force '''_Character''' to be synchronised even if no player character are nearby, by passing '''1''' as '''_Bool'''. Once the character no longer needs to be force-synchronised, you can make its synchronisation again depend on the nearness of a player character by calling it with '''0''' as '''_Bool'''.		Characters are only synchronised between the server (the game logic) and the client (the presentation) if at least one player character is "nearby" (currently: within 30 meters). This routine can be used to force '''_Character''' to be synchronised even if no player character are nearby, by passing '''1''' as '''_Bool'''. Once the character no longer needs to be force-synchronised, you can make its synchronisation again depend on the nearness of a player character by calling it with '''0''' as '''_Bool'''.
	===== Notes =====		===== Notes =====
	* Synchronisation is only important in special cases. For example, a character's linked ghost will only be visible if the character itself is active. So if the character's corpse is far away, you have to force synchronise it for its ghost to show up. Another use case is when forcing the camera to a location far away from the players, in which case you may have to force synch ~~torches and other dynamic items~~ in that far-away location.		* Synchronisation is only important in special cases. For example, a character's linked ghost will only be visible if the character itself is active. So if the character's corpse is far away, you have to force synchronise it for its ghost to show up. Another use case is when forcing the camera to a location far away from the players, in which case you may have to force synch characters in that far-away location if you want them to be visible.
	* Forcing a character (or item) to synchronise does not automatically make it active, i.e., it does not make their behaviour scripts execute. If you want that, use [[Osiris/API/CharacterSetForceUpdate\|CharacterSetForceUpdate]] instead.		* Forcing a character (or item) to synchronise does not automatically make it active, i.e., it does not make their behaviour scripts execute. If you want that, use [[Osiris/API/CharacterSetForceUpdate\|CharacterSetForceUpdate]] instead.
	* Use this functionality very sparingly, as it can easily lead to a lot of unnecessary overhead.		* Use this functionality very sparingly, as it can easily lead to a lot of unnecessary overhead.
	* If this function is called while the character was inactive, it will '''''not''''' make it active. It will only keep the character active once it has become active due to a player being nearby, or if it receives an event.		* As the name and declaration imply, this cannot be used for items. You can use [[Osiris/API/ItemSetForceSynch\|ItemSetForceSynch]] for them instead, with the same caveats.
	* As the name and declaration imply, this cannot be used for items. You can use ~~'''~~ItemSetForceSynch~~'''~~ for them instead, with the same caveats.
	* Off-stage characters cannot be force-synchronised (it may appear to work, but will stop when saving/reloading).		* Off-stage characters cannot be force-synchronised (it may appear to work, but will stop when saving/reloading).
			* This call increases an internal counter every time you enable force-synchronising and decreases it again when you disable it. Force-synchronisation only gets disabled when the counter is at zero (which is its initial value).
	===== See Also =====		===== See Also =====
	* [[Osiris/API/CharacterSetForceUpdate\|CharacterSetForceUpdate]]		* [[Osiris/API/CharacterSetForceUpdate\|CharacterSetForceUpdate]]

Tinkerer at 13:11, 20 September 2017

2017-09-20T13:11:10Z

← Older revision		Revision as of 13:11, 20 September 2017
Line 4:		Line 4:
	Characters are only synchronised between the server (the game logic) and the client (the presentation) if at least one player character is "nearby" (currently: within 30 meters). This routine can be used to force '''_Character''' to be synchronised even if no player character are nearby, by passing '''1''' as '''_Bool'''. Once the character no longer needs to be force-synchronised, you can make its synchronisation again depend on the nearness of a player character by calling it with '''0''' as '''_Bool'''.		Characters are only synchronised between the server (the game logic) and the client (the presentation) if at least one player character is "nearby" (currently: within 30 meters). This routine can be used to force '''_Character''' to be synchronised even if no player character are nearby, by passing '''1''' as '''_Bool'''. Once the character no longer needs to be force-synchronised, you can make its synchronisation again depend on the nearness of a player character by calling it with '''0''' as '''_Bool'''.
	===== Notes =====		===== Notes =====
	* Synchronisation is only important in special cases. For example, a character's linked ghost will only be visible if the character itself is active. So if the character's corpse is far away, you have to force synchronise it for its ghost to show up.		* Synchronisation is only important in special cases. For example, a character's linked ghost will only be visible if the character itself is active. So if the character's corpse is far away, you have to force synchronise it for its ghost to show up. Another use case is when forcing the camera to a location far away from the players, in which case you may have to force synch torches and other dynamic items in that far-away location.
	* Forcing a character (or item) to synchronise does not automatically make it active, i.e., it does not make their behaviour scripts execute. If you want that, use [[Osiris/API/CharacterSetForceUpdate\|CharacterSetForceUpdate]] instead.		* Forcing a character (or item) to synchronise does not automatically make it active, i.e., it does not make their behaviour scripts execute. If you want that, use [[Osiris/API/CharacterSetForceUpdate\|CharacterSetForceUpdate]] instead.
	* Use this functionality very sparingly, as it can easily lead to a lot of unnecessary overhead.		* Use this functionality very sparingly, as it can easily lead to a lot of unnecessary overhead.

Tinkerer at 13:09, 20 September 2017

2017-09-20T13:09:50Z

← Older revision		Revision as of 13:09, 20 September 2017
Line 1:		Line 1:
	===== Full Definition(s) =====		===== Full Definition(s) =====
	* call '''CharacterSetForceSynch'''(''(CHARACTERGUID)'''''_Character''')		* call '''CharacterSetForceSynch'''(''(CHARACTERGUID)'''''_Character''', ''(INTEGER)'''''_Bool''')
	===== Description =====		===== Description =====
	Characters are only synchronised between the server (the game logic) and the client (the presentation) if at least one player character is "nearby" (currently: within 30 meters). This routine can be used to force '''_Character''' to be synchronised even if no player character are nearby, by passing '''1''' as '''_Bool'''. Once the character no longer needs to be force-synchronised, you can make its synchronisation again depend on the nearness of a player character by calling it with '''0''' as '''_Bool'''.		Characters are only synchronised between the server (the game logic) and the client (the presentation) if at least one player character is "nearby" (currently: within 30 meters). This routine can be used to force '''_Character''' to be synchronised even if no player character are nearby, by passing '''1''' as '''_Bool'''. Once the character no longer needs to be force-synchronised, you can make its synchronisation again depend on the nearness of a player character by calling it with '''0''' as '''_Bool'''.

Tinkerer: add link to CharacterSetForceUpdate

2017-09-09T16:26:05Z

add link to CharacterSetForceUpdate

← Older revision		Revision as of 16:26, 9 September 2017
Line 11:		Line 11:
	* Off-stage characters cannot be force-synchronised (it may appear to work, but will stop when saving/reloading).		* Off-stage characters cannot be force-synchronised (it may appear to work, but will stop when saving/reloading).
	===== See Also =====		===== See Also =====
			* [[Osiris/API/CharacterSetForceUpdate\|CharacterSetForceUpdate]]
	* [[Osiris/API/ItemSetForceSynch\|ItemSetForceSynch]]		* [[Osiris/API/ItemSetForceSynch\|ItemSetForceSynch]]

	[[Category:Osiris Calls]]		[[Category:Osiris Calls]]

Tinkerer: Corrected documentation to clarify that it does not result in a character's behaviour scripts executing

2017-09-09T16:25:35Z

Corrected documentation to clarify that it does not result in a character's behaviour scripts executing

← Older revision		Revision as of 16:25, 9 September 2017
Line 2:		Line 2:
	* call '''CharacterSetForceSynch'''(''(CHARACTERGUID)'''''_Character''')		* call '''CharacterSetForceSynch'''(''(CHARACTERGUID)'''''_Character''')
	===== Description =====		===== Description =====
	~~Reactions~~		Characters are only synchronised between the server (the game logic) and the client (the presentation) if at least one player character is "nearby" (currently: within 30 meters). This routine can be used to force '''_Character''' to be synchronised even if no player character are nearby, by passing '''1''' as '''_Bool'''. Once the character no longer needs to be force-synchronised, you can make its synchronisation again depend on the nearness of a player character by calling it with '''0''' as '''_Bool'''.
	~~from behaviour scripts~~ are only ~~active~~ if at least one player character
	is "nearby" (currently: within 30 meters). This routine can be used to
	force '''_Character'''~~'s reactions~~ to ~~remain active~~ even if no player character are nearby, by passing '''1''' as '''_Bool'''.
	Once the character~~'s behaviours~~ no longer ~~need~~ to ~~remain permanently active~~,
	you can make its ~~activity status~~ again depend on the nearness of a
	player character by calling it with '''0''' as '''_Bool'''.
	===== Notes =====		===== Notes =====
			* Synchronisation is only important in special cases. For example, a character's linked ghost will only be visible if the character itself is active. So if the character's corpse is far away, you have to force synchronise it for its ghost to show up.
			* Forcing a character (or item) to synchronise does not automatically make it active, i.e., it does not make their behaviour scripts execute. If you want that, use [[Osiris/API/CharacterSetForceUpdate\|CharacterSetForceUpdate]] instead.
	* Use this functionality very sparingly, as it can easily lead to a lot of unnecessary overhead.		* Use this functionality very sparingly, as it can easily lead to a lot of unnecessary overhead.
	* If this function is called while the character was inactive, it will '''''not''''' make it active. It will only keep the character active once it has become active due to a player being nearby, or if it receives an event.		* If this function is called while the character was inactive, it will '''''not''''' make it active. It will only keep the character active once it has become active due to a player being nearby, or if it receives an event.

Tinkerer at 16:01, 17 August 2017

2017-08-17T16:01:04Z

← Older revision		Revision as of 16:01, 17 August 2017
Line 13:		Line 13:
	* If this function is called while the character was inactive, it will '''''not''''' make it active. It will only keep the character active once it has become active due to a player being nearby, or if it receives an event.		* If this function is called while the character was inactive, it will '''''not''''' make it active. It will only keep the character active once it has become active due to a player being nearby, or if it receives an event.
	* As the name and declaration imply, this cannot be used for items. You can use '''ItemSetForceSynch''' for them instead, with the same caveats.		* As the name and declaration imply, this cannot be used for items. You can use '''ItemSetForceSynch''' for them instead, with the same caveats.
			* Off-stage characters cannot be force-synchronised (it may appear to work, but will stop when saving/reloading).
	===== See Also =====		===== See Also =====
	* [[Osiris/API/ItemSetForceSynch]]~~<u> </u>~~		* [[Osiris/API/ItemSetForceSynch\|ItemSetForceSynch]]

	[[Category:Osiris Calls]]		[[Category:Osiris Calls]]