RestorePosition (script event)

Game class

This event operates on an instance of the game class type {{{gameclass}}}

Description

Returns this entity to the position stored in the “origin” spawn arg.

Usage

void restorePosition()

Parameters

This script event does not accept parameters.

Examples

 
$my_entity.restorePosition();

Notes

This script event does not return any values.

This is the position the entity was spawned in unless the “origin” key is changed. Note that there is no guarantee that the entity won’t be stuck in another entity when moved, so care should be taken to make sure that isn’t possible.