kPlayLoop Class Reference

Public Member Functions
const int	Ticks () const
	effected by gamespeed
const int	UnscaledTicks () const
	Not effected by GameSpeed.
void	TagActorForBossBar (kActor@ actor)
void	RemoveBossActor ()
void	CheckKeys ()
	Prints HUD messages to tell the player how many keys they've found on the current HUBID.
void	ChangeMap (const kStr &in mapName)
void	StartWarp (kActor@ actor, const int tagID, const int mapID)
void	StartFreeWarp (kActor@ actor, const kVec3 &in origin, const float yaw, const int sectorIndex, const int mapID)
void	HandlePlayerDeath (const bool loseLife=true)
	if loseLife is true and infinite lives cheat is off then player loses a life. if player lives is < 0 then GameOver is called. If has >= 0 lives left then will ChangeMap to the current set check point, or use the current map if no check point is set.
const bool	CheckWarping ()
	Checks if Warping or FreeWarping is in progress.
const bool	CanOpenPauseMenu ()
	Checks if it's okay to be able to open a menu.
const bool	CanOpenSaveMenu ()
	Checks if it's okay to be able to open the save menu.
const int	NewMapWarpTID ()
	Returns the warp TID the player warped to from another map. Returns -1 of didn't warp from another map. Check before OnPostBeginLevel.
void	ClearWarpInterpolation (void)
	Clearing the interpolation for kPuppet will also clear the warp interpolation.

Detailed Description

Definition at line 1363 of file t1_scriptAPI.cpp.

Member Function Documentation

CanOpenPauseMenu()

const bool kPlayLoop::CanOpenPauseMenu

(

)

Checks if it's okay to be able to open a menu.

CanOpenSaveMenu()

const bool kPlayLoop::CanOpenSaveMenu

(

)

Checks if it's okay to be able to open the save menu.

ChangeMap()

void kPlayLoop::ChangeMap

(

const kStr &in

mapName

)

CheckKeys()

void kPlayLoop::CheckKeys

(

)

Prints HUD messages to tell the player how many keys they've found on the current HUBID.

CheckWarping()

const bool kPlayLoop::CheckWarping

(

)

Checks if Warping or FreeWarping is in progress.

ClearWarpInterpolation()

void kPlayLoop::ClearWarpInterpolation

(

void

)

Clearing the interpolation for kPuppet will also clear the warp interpolation.

HandlePlayerDeath()

void kPlayLoop::HandlePlayerDeath

(

const bool

loseLife = true

)

if loseLife is true and infinite lives cheat is off then player loses a life. if player lives is < 0 then GameOver is called. If has >= 0 lives left then will ChangeMap to the current set check point, or use the current map if no check point is set.

NewMapWarpTID()

const int kPlayLoop::NewMapWarpTID

(

)

Returns the warp TID the player warped to from another map. Returns -1 of didn't warp from another map. Check before OnPostBeginLevel.

RemoveBossActor()

void kPlayLoop::RemoveBossActor

(

)

StartFreeWarp()

void kPlayLoop::StartFreeWarp	(	kActor@	actor,
		const kVec3 &in	origin,
		const float	yaw,
		const int	sectorIndex,
		const int	mapID )

StartWarp()

void kPlayLoop::StartWarp	(	kActor@	actor,
		const int	tagID,
		const int	mapID )

TagActorForBossBar()

void kPlayLoop::TagActorForBossBar

(

kActor@

actor

)

Ticks()

const int kPlayLoop::Ticks

(

)

const

effected by gamespeed

UnscaledTicks()

const int kPlayLoop::UnscaledTicks

(

)

const

Not effected by GameSpeed.