Unreal Class Reference - Revision history

Plasma at 08:52, 25 May 2024

2024-05-25T08:52:26Z

← Older revision		Revision as of 08:52, 25 May 2024
Line 1:		Line 1:
			__FORCETOC__
	'''Unreal Classes'''		'''Unreal Classes'''

Plasma at 02:48, 18 May 2024

2024-05-18T02:48:29Z

← Older revision		Revision as of 02:48, 18 May 2024
Line 13:		Line 13:

	This is a quick attempt to describe the most important classes and variables in Unreal. It is currently very sparse but will be expanded over time.		This is a quick attempt to describe the most important classes and variables in Unreal. It is currently very sparse but will be expanded over time.


	== Engine.Object ==		== Engine.Object ==

Plasma at 02:48, 18 May 2024

2024-05-18T02:48:07Z

← Older revision		Revision as of 02:48, 18 May 2024
Line 140:		Line 140:

	== Game Startup ==		== Game Startup ==

			When programming new actor scripts, you need to be wary of the order in which actors that pre-exist in a level (at load time) are initialized, and the order in which new actors are initialized when they are spawned. The exact order of initialization is:

			*The actor object is created and its variables are initialized to their default values (if spawning an actor), or loaded from a file (if loading a pre-existing actor).
			*The actor's location, rotation, and owner are set.
			*If the actor is being spawned, its Spawn() event is called.
			*The actor's PreBeginPlay() event is called.
			*The actor's BeginPlay() event is called.
			*The actor's zone is set, and any ZoneChange messages are sent to the actor, and any ActorEntered messages are sent to its zone. Prior to this point, the actor is not in a valid zone, and you must not call the Move, MoveSmooth, SetLocation, or SetRotation functions, or any functions which call them.
			*The actor's PostBeginPlay() event is called.
			*The actor's SetInitialState() event is called.
			*If the actor hasn't set its base yet, its base is set.

Plasma at 02:47, 18 May 2024

2024-05-18T02:47:22Z

@@ Line 10: / Line 10: @@
-=== About this document ===
+'''About this document'''
 This is a quick attempt to describe the most important classes and variables in Unreal. It is currently very sparse but will be expanded over time.
@@ Line 59: / Line 59: @@
 == Engine.Actor ==

Plasma at 02:44, 18 May 2024

2024-05-18T02:44:20Z

@@ Line 15: / Line 15: @@
-=== Engine.Object ===
+== Engine.Object ==
 '''Purpose:'''
@@ Line 44: / Line 44: @@
 *SaveConfig: Saves the current values of all "config" variables to the Unreal.ini file.
 *ResetConfig: Resets the values of the "config" variables to the originals in the Default.ini file.

Plasma at 02:43, 18 May 2024

2024-05-18T02:43:15Z

← Older revision		Revision as of 02:43, 18 May 2024
Line 8:		Line 8:

	Audience: Level Designers, UnrealScript Programmers, C++ Programmers.		Audience: Level Designers, UnrealScript Programmers, C++ Programmers.


	=== About this document ===		=== About this document ===

	This is a quick attempt to describe the most important classes and variables in Unreal. It is currently very sparse but will be expanded over time.		This is a quick attempt to describe the most important classes and variables in Unreal. It is currently very sparse but will be expanded over time.


	=== Engine.Object ===		=== Engine.Object ===
Line 18:		Line 20:

	Serves as the base class of all objects in Unreal. All objects inherit from Object.		Serves as the base class of all objects in Unreal. All objects inherit from Object.


	'''Variables:'''		'''Variables:'''
Line 25:		Line 28:
	*Name: The object's name.		*Name: The object's name.
	*Class: The object's class.		*Class: The object's class.


			'''Functions:'''

			*Log: Writes a message to the log file, usually \Unreal\System\Unreal.log.
			*Warn: Writes a script warning to the log file, including the current script and function.
			*Localize: Returns a localized (internationally translated) string from a package's .int file.
			*GotoState: Sets the object's current state, None means no state. If no label is specified, the Begin label is gone to.
			*IsInState: Returns whether this object is in the specified state.
			*GetStateName: Returns the name of this object's current stae, None if none.
			*Enable: Enables a probe event. The only functions which work with Enable and Disable are: Spawned, Destroyed, GainedChild, LostChild, Trigger, UnTrigger, Timer, HitWall, Falling, Landed, ZoneChange, Touch, UnTouch, Bump, BeginState, EndState, BaseChange, Attach, Detach, ActorEntered, ActorLeaving, KillCredit, AnimEnd, EndedRotation, InterpolateEnd, EncroachingOn, EncroachedBy, FootZoneChange, HeadZoneChange, PainTimer, SpeechTimer, MayFall, Die, Tick, PlayerTick, Expired, SeePlayer, EnemyNotVisible, HearNoise, UpdateEyeHeight, SeeMonster, SeeFriend, SpecialHandling, BotDesireability.
			*Disable: Disables a probe event.
			*GetPropertyText: Converts the value of an arbirary variable to text.
			*SetPropertyText: Sets the value of an arbitrary variable from text.
			*SaveConfig: Saves the current values of all "config" variables to the Unreal.ini file.
			*ResetConfig: Resets the values of the "config" variables to the originals in the Default.ini file.

Plasma: Created page with "'''Unreal Classes''' Tim Sweeney Epic MegaGames, Inc. http://www.epicgames.com/ Audience: Level Designers, UnrealScript Programmers, C++ Programmers. === About this document === This is a quick attempt to describe the most important classes and variables in Unreal. It is currently very sparse but will be expanded over time. === Engine.Object === '''Purpose:''' Serves as the base class of all objects in Unreal. All objects inherit from Object. '''Variables:''..."

2024-05-18T02:42:30Z

Created page with "'''Unreal Classes''' Tim Sweeney Epic MegaGames, Inc. http://www.epicgames.com/ Audience: Level Designers, UnrealScript Programmers, C++ Programmers. === About this document === This is a quick attempt to describe the most important classes and variables in Unreal. It is currently very sparse but will be expanded over time. === Engine.Object === '''Purpose:''' Serves as the base class of all objects in Unreal. All objects inherit from Object. '''Variables:''..."

New page

'''Unreal Classes'''

Tim Sweeney

Epic MegaGames, Inc.

http://www.epicgames.com/

Audience: Level Designers, UnrealScript Programmers, C++ Programmers.

=== About this document ===

This is a quick attempt to describe the most important classes and variables in Unreal. It is currently very sparse but will be expanded over time.

=== Engine.Object ===

'''Purpose:'''

Serves as the base class of all objects in Unreal. All objects inherit from Object.

'''Variables:'''

*Parent: The object's parent object (for scoping).
*ObjectFlags: The object's flags, described in the Packages document.
*Name: The object's name.
*Class: The object's class.