WorldShifter Abstract Class

protected void Awake()

The World Shifter's Awake method, called by Unity. You cannot utilize Awake in your derived class, if you need to perform some sort of awake related logic, override the AwakeExtended method, which will be called by this classes Awake method. Also note that you do not need to call base.AwakeExtended(); from your AwakeExtended method, as this is a virtual empty method that does nothing unless you override it. Also note that this method is protected simply so that if you derive from this class, you will see an error when trying to add the Awake method.

protected virtual void AwakeExtended()

Can be overriden to perform logic that would normally go in Awake (which is used by the base class). Use this instead of implementing Awake! You do not need to call base.AwakeExtended if you override this, as the base method is empty.

protected abstract int CalculateNumberOfTransformsToBeShifted()

A method which should be overriden to return the total number of transforms that will be shifted by your implementation of the ShiftWorld coroutine. This is basically the number of times you will call the ShiftTransformAndFireEvents method, or the total transforms you will shift manually if you elect not to use that method. This is for use with the PreTransformShift and PostTransformShift events, so that the TotalTransformsInShiftCycle property in the event args can be set properly. If you don't intend to use these events, you don't need to worry about this method (just return 0).

Please note that this is not necessarily a count of the total number of transforms in your World, and some transforms may be children of other transforms, which are shifted automatically when their parents are shifted. Rather, this is a count of the total number of transforms that are shifted either manually by you (transform.position = transform.position + CurrentShiftAmount), or the total number of transforms shifted via the ShiftTransformAndFireEvents method.

Also note that the CurrentWorldToBeShifted and CurrentShiftAmount properties will be set prior to this method being called, so you can access them if you need to in order to determine the value returned.

Returns

int
The number of transforms that will be shifted.

public void FireTransformShiftedEvent(Transform transform, int transformNumberInShiftCycle)

Manually fire the TransformShifted event. You need to track and set the transformNumberInShiftCycle value, as automatic tracking is only available when using the ShiftTransformAndFireEvents method. If you use this method, you cannot use the ShiftTransformAndFireEvents method, as the two are mutually exclusive. You must also make sure to call the FirePreShiftTransformEvent method.

Ideally you would call this method immediately after manually shifting the transform's position.

Parameters

public void FireTransformShiftingEvent(Transform transform, int transformNumberInShiftCycle)

Manually fire the TransformShifting event. You need to track and set the transformNumberInShiftCycle value, as automatic tracking is only available when using the ShiftTransformAndFireEvents method. If you use this method, you cannot use the ShiftTransformAndFireEvents method, as the two are mutually exclusive. You must also make sure to call the FirePostShiftTransformEvent method.

Ideally you would call this method immediately before manually shifting the transform's position.

Parameters

protected void FireWorldShiftedEvent()

Fires the WorldShifted Event. You only need to call this if you've configured FireWorldShiftedEventAutomatically to return false in your custom World Shifter class.

protected void FireWorldShiftingEvent()

Fires the WorldShifting Event. You only need to call this if you've configured FireWorldShiftingEventAutomatically to return false in your custom World Shifter class.

public abstract bool IsConfiguredToMovePlayerFromActiveGrid(ActiveGrid activeGrid)

When overriden, executes a query to determine if the World Shifter has been configured to move the Player associated with the Active Grid. This is used by the Active Grid in certain situations to avoid double movements.

Parameters

Returns

bool
True if the World Shifter has been configured to move the player, false otherwise.

protected void OnDestroy()

The World Shifter's OnDestroy method, called by Unity. You cannot utilize OnDestroy in your derived class, if you need to perform some sort of OnDestroy related logic, override the OnDestroyExtended method, which will be called by this classes OnDestroy method. Also note that you do not need to call base.OnDestroyExtended(); from your OnDestroyExtended method, as this is a virtual empty method that does nothing unless you override it. Also note that this method is protected simply so that if you derive from this class, you will see an error when trying to add the OnDestroy method.

protected virtual void OnDestroyExtended()

Can be overriden to perform logic that would normally go in OnDestroy (which is used by the base class). Use this instead of implementing OnDestroy! You do not need to call base.OnDestroyExtended if you override this, as the base method is empty.

protected void ShiftTransformAndFireEvents(Transform transform)

First, it fires the TransformShifting event if there are any subscribers. Then, it shifts the position of the input transform by the value of CurrentShiftAmount. Finally, it fires the TransformShifted event if there are any subscribers.

This method should be called for each Transform that you wish to shift. You can elect to not use the method and shift the transforms yourself, however the TransformShifting and TransformShifted methods will not be fired automatically. In that case, you can manually call FireTransformShiftingEvent before you shift the transform and then FireTransformShiftedEvent after you shift the transform, or elect not to use the Transform Shift events at all. The method automatically increments the TransformShiftEventArgs.TransformNumberInShiftCycle so you don't need to worry about it.

If you utilize this method, you should not utilize the FireTransformShiftingEvent and FireTransformShiftedEvent methods, as they are mutually exclusive.

Parameters

public abstract IEnumerator<YieldInstruction> ShiftWorld()

When overridden by a derived class, shifts the world. You'll notice that this method is not passed any arguments. The World and shift amount are set prior to this method being called, and can be retrieved via the CurrentWorldToBeShifted and CurrentShiftAmount properties.

What transforms you shift in order to complete a 'World Shift' is entirely up to you.

Returns

IEnumerator<YieldInstruction>
An IEnumerator<YieldInstruction> that can be iterated over or used as a coroutine. See the YieldInstruction page for more info.

public void SubscribeToTransformShiftedEvent(UnityAction<System.Object, TransformShiftEventArgs> subscriber)

Subcribe to the TransformShifted event via code. Typically you would do this in the OnEnable method, and then call the UnsubscribeFromTransformShiftedEvent method in your OnDisable method.

Parameters

public void SubscribeToTransformShiftingEvent(UnityAction<System.Object, TransformShiftEventArgs> subscriber)

Subcribe to the TransformShifting event via code. Typically you would do this in the OnEnable method, and then call the UnsubscribeFromTransformShiftingEvent method in your OnDisable method.

Parameters

public void SubscribeToWorldShiftedEvent(UnityAction<System.Object, WorldShiftEventArgs> subscriber)

Subcribe to the WorldShifted event via code. Typically you would do this in the OnEnable method, and then call the UnsubscribeFromWorldShiftedEvent method in your OnDisable method.

Parameters

public void SubscribeToWorldShiftingEvent(UnityAction<System.Object, WorldShiftEventArgs> subscriber)

Subcribe to the WorldShifting event via code. Typically you would do this in the OnEnable method, and then call the UnsubscribeFromWorldShiftingEvent method in your OnDisable method.

Parameters

public void UnsubscribeFromTransformShiftedEvent(UnityAction<System.Object, TransformShiftEventArgs> subscriber)

Unsubcribe from the TransformShifted event via code. Typically you would subscribe in the OnEnable method of your script, and then unsubscribe in the OnDisable method.

Parameters

public void UnsubscribeFromTransformShiftingEvent(UnityAction<System.Object, TransformShiftEventArgs> subscriber)

Unsubcribe from the TransformShifting event via code. Typically you would subscribe in the OnEnable method of your script, and then unsubscribe in the OnDisable method.

Parameters

public void UnsubscribeFromWorldShiftedEvent(UnityAction<System.Object, WorldShiftEventArgs> subscriber)

Unsubcribe from the WorldShifted event via code. Typically you would subscribe in the OnEnable method of your script, and then unsubscribe in the OnDisable method.

Parameters

public void UnsubscribeFromWorldShiftingEvent(UnityAction<System.Object, WorldShiftEventArgs> subscriber)

Unsubcribe from the WorldShifting event via code. Typically you would subscribe in the OnEnable method of your script, and then unsubscribe in the OnDisable method.

Parameters