IsPlayerMovingIntoNewSpace

From GECK
Jump to: navigation, search


A function included in the GECK for Fallout 3.

Description

Returns 1 if the player is in the process of moving into a new space, i.e. fast traveling or moving through a load door.

The use of this function is a bit arcane, but you probably want to put it on any follow package which is conditionalized by the player's location. Say you have an NPC whose follow package on the player is conditionalized to not go into interiors or outside of Megaton. Trouble is, followers get moved before the player arrives, so they don't reevaluate that the target is in an interior or outside of Megaton until they and the player are already there -- so you'd get the NPC fast traveling with you, and then walking all the way back to Skingrad from whereever you happened to go.

This function returns true when the player is in the middle of loading into a new cell or fast travelling -- so if you put

IsPlayerMovingIntoNewSpace == 0

as a condition on the NPC's follow package, he reevaluates during the load and won't follow the player outside of Megaton or into interiors.

Syntax

[help]
(0, 1:int) IsPlayerMovingIntoNewSpace

Example

IsPlayerMovingIntoNewSpace == 0 

Notes

  • If used with scripting may only work within a MenuMode, OnLoad or similar block due to only returning 1 while the load screen is displayed.
  • Some caution should be used within a MenuMode block, may cause some scripting to be used when not actually in game, such as the main menu when used within a constantly running quest script. <needs to be verified>

See Also