Mostly Harmless

Difference between revisions of "UE3:DebugCameraController (UDK)"

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
(Talk)
 
m (1 revision: class descriptions for UDK January update (part 1))
 
(One intermediate revision by one other user not shown)
Line 5: Line 5:
 
| parent3 = Actor
 
| parent3 = Actor
 
| parent4 = Object
 
| parent4 = Object
 +
| interface1 = Interface_NavigationHandle
 
}}
 
}}
 
{{autogenerated}}
 
{{autogenerated}}
Line 24: Line 25:
  
 
<!-- enter variable description -->
 
<!-- enter variable description -->
 +
 +
====bShowSelectedInfo====
 +
'''Type:''' [[bool]]
 +
 +
'''[[Variables#Modifiers|Modifiers]]:''' globalconfig
 +
 +
Whether to show information about the selected actor on the debug camera HUD.
 +
 +
'''Default value:''' True
  
 
====DrawFrustum====
 
====DrawFrustum====
Line 39: Line 49:
  
 
<!-- enter variable description -->
 
<!-- enter variable description -->
 +
 +
====PrimaryKey====
 +
'''Type:''' [[name]]
 +
 +
'''[[Variables#Modifiers|Modifiers]]:''' globalconfig
 +
 +
The key that triggers PrimarySelect().
 +
 +
'''Default value:''' 'LeftMouseButton'
 +
 +
====SecondaryKey====
 +
'''Type:''' [[name]]
 +
 +
'''[[Variables#Modifiers|Modifiers]]:''' globalconfig
 +
 +
The key that triggers SecondarySelect().
 +
 +
'''Default value:''' 'RightMouseButton'
 +
 +
====SelectedActor====
 +
'''Type:''' {{cl|Actor}}
 +
 +
<!-- enter variable description -->
 +
 +
====SelectedComponent====
 +
'''Type:''' {{cl|PrimitiveComponent}}
 +
 +
<!-- enter variable description -->
 +
 +
====UnselectKey====
 +
'''Type:''' [[name]]
 +
 +
'''[[Variables#Modifiers|Modifiers]]:''' globalconfig
 +
 +
The key that triggers Unselect().
 +
 +
'''Default value:''' 'Escape'
  
 
===Default values===
 
===Default values===
Line 101: Line 148:
  
 
<!-- enter function description -->
 
<!-- enter function description -->
 +
 +
====ShowDebugSelectedInfo====
 +
{{code|exec function '''ShowDebugSelectedInfo''' ()}}
 +
 +
<!-- enter function description -->
 +
 +
===Native functions===
 +
====ConsoleCommand====
 +
{{code|native function [[string]]&nbsp;'''ConsoleCommand''' ([[string]]&nbsp;'''Command''', optional&nbsp;[[bool]]&nbsp;'''bWriteToLog''')}}
 +
 +
'''Overrides:''' {{tl|ConsoleCommand|PlayerController|native functions}}
 +
 +
Overridden to potentially pipe commands to regular PlayerController
 +
 +
====PrimarySelect====
 +
{{code|native function '''PrimarySelect''' ({{tl|Vector|Object|structs}}&nbsp;'''HitLoc''', {{tl|Vector|Object|structs}}&nbsp;'''HitNormal''', {{tl|TraceHitInfo|Actor|structs}}&nbsp;'''HitInfo''')}}
 +
 +
Called when an actor has been selected with the primary key (e.g. left mouse button).
 +
 +
'''Parameters:'''
 +
* ''HitLoc'' - World-space position of the selection point.
 +
* ''HitNormal'' - World-space normal of the selection point.
 +
* ''HitInfo'' - Info struct for the selection point.
 +
 +
====SecondarySelect====
 +
{{code|native function '''SecondarySelect''' ({{tl|Vector|Object|structs}}&nbsp;'''HitLoc''', {{tl|Vector|Object|structs}}&nbsp;'''HitNormal''', {{tl|TraceHitInfo|Actor|structs}}&nbsp;'''HitInfo''')}}
 +
 +
Called when an actor has been selected with the secondary key (e.g. right mouse button).
 +
 +
'''Parameters:'''
 +
* ''HitLoc'' - World-space position of the selection point.
 +
* ''HitNormal'' - World-space normal of the selection point.
 +
* ''HitInfo'' - Info struct for the selection point.
 +
 +
====Unselect====
 +
{{code|native function '''Unselect''' ()}}
 +
 +
Called when the user pressed the unselect key, just before the selected actor is cleared.
  
 
===Events===
 
===Events===
Line 115: Line 200:
  
 
<!-- enter function description -->
 
<!-- enter function description -->
 +
 +
====NativeInputKey====
 +
{{code|function [[bool]]&nbsp;'''NativeInputKey''' ([[int]]&nbsp;'''ControllerId''', [[name]]&nbsp;'''Key''', {{tl|EInputEvent|Object}}&nbsp;'''Event''', [[float]]&nbsp;'''AmountDepressed''', [[bool]]&nbsp;'''bGamepad''')}}
 +
 +
Called from DebugCameraInput
 +
Process an input key event routed through unrealscript from another object. This method is assigned as the value for the
 +
OnRecievedNativeInputKey delegate so that native input events are routed to this unrealscript function.
 +
 +
'''Parameters:'''
 +
* ''ControllerId'' - the controller that generated this input key event
 +
* ''Key'' - the name of the key which an event occured for (KEY_Up, KEY_Down, etc.)
 +
* ''EventType'' - the type of event which occured (pressed, released, etc.)
 +
* ''AmountDepressed'' - for analog keys, the depression percent.
 +
 +
'''Returns:'''
 +
:true to consume the key event, false to pass it on.
  
 
====OnActivate====
 
====OnActivate====
Line 124: Line 225:
 
{{code|function '''OnDeactivate''' ({{cl|PlayerController}}&nbsp;'''PC''')}}
 
{{code|function '''OnDeactivate''' ({{cl|PlayerController}}&nbsp;'''PC''')}}
  
−
<!-- enter function description -->
+
Function called on deactivation debug camera controller
  
 
==States==
 
==States==

Latest revision as of 05:37, 17 January 2010

UDK Object >> Actor >> Controller >> PlayerController >> DebugCameraController
Package: 
Engine
Implemented interfaces: 
Interface_NavigationHandle
This class in other games:
UT3
This is an auto-generated page and may need human attention.
Please remove the {{autogenerated}} tag if the page seems reasonably complete or replace it with the {{expand}} tag if the page is not yet complete.

PCF Begin (Debug Camera) Debug Camera Controller

To turn it on, please press Alt+C or both (left and right) analogs on xbox pad After turning: WASD | Left Analog - moving Mouse | Right Analog - rotating Shift | XBOX_KeyB - move faster Q/E | LT/RT - move Up/Down Enter | XBOX_KeyA - to call "FreezeRendering" console command Alt+C | LeftThumbstick - to toggle debug camera

Properties[edit]

bIsFrozenRendering[edit]

Type: bool


bShowSelectedInfo[edit]

Type: bool

Modifiers: globalconfig

Whether to show information about the selected actor on the debug camera HUD.

Default value: True

DrawFrustum[edit]

Type: DrawFrustumComponent


OryginalControllerRef[edit]

Type: PlayerController


OryginalPlayer[edit]

Type: Player


PrimaryKey[edit]

Type: name

Modifiers: globalconfig

The key that triggers PrimarySelect().

Default value: 'LeftMouseButton'

SecondaryKey[edit]

Type: name

Modifiers: globalconfig

The key that triggers SecondarySelect().

Default value: 'RightMouseButton'

SelectedActor[edit]

Type: Actor


SelectedComponent[edit]

Type: PrimitiveComponent


UnselectKey[edit]

Type: name

Modifiers: globalconfig

The key that triggers Unselect().

Default value: 'Escape'

Default values[edit]

Property Value
bAlwaysTick True
bHidden False
bHiddenEd False
InputClass Class'Engine.DebugCameraInput'

Subobjects[edit]

CollisionCylinder[edit]

Class: Engine.CylinderComponent

Inherits from: PlayerController.CollisionCylinder

Property Value
ReplacementPrimitive None

Sprite[edit]

Class: Engine.SpriteComponent

Inherits from: PlayerController.Sprite

Property Value
ReplacementPrimitive None

Functions[edit]

Exec functions[edit]

MoreSpeed[edit]

exec function MoreSpeed ()


NormalSpeed[edit]

exec function NormalSpeed ()


SetFreezeRendering[edit]

exec function SetFreezeRendering ()


ShowDebugSelectedInfo[edit]

exec function ShowDebugSelectedInfo ()


Native functions[edit]

ConsoleCommand[edit]

native function string ConsoleCommand (string Command, optional bool bWriteToLog)

Overrides: PlayerController.ConsoleCommand

Overridden to potentially pipe commands to regular PlayerController

PrimarySelect[edit]

native function PrimarySelect (Object.Vector HitLoc, Object.Vector HitNormal, Actor.TraceHitInfo HitInfo)

Called when an actor has been selected with the primary key (e.g. left mouse button).

Parameters:

  • HitLoc - World-space position of the selection point.
  • HitNormal - World-space normal of the selection point.
  • HitInfo - Info struct for the selection point.

SecondarySelect[edit]

native function SecondarySelect (Object.Vector HitLoc, Object.Vector HitNormal, Actor.TraceHitInfo HitInfo)

Called when an actor has been selected with the secondary key (e.g. right mouse button).

Parameters:

  • HitLoc - World-space position of the selection point.
  • HitNormal - World-space normal of the selection point.
  • HitInfo - Info struct for the selection point.

Unselect[edit]

native function Unselect ()

Called when the user pressed the unselect key, just before the selected actor is cleared.

Events[edit]

PostBeginPlay[edit]

simulated event PostBeginPlay ()

Overrides: PlayerController.PostBeginPlay


Other instance functions[edit]

DisableDebugCamera[edit]

function DisableDebugCamera ()


NativeInputKey[edit]

function bool NativeInputKey (int ControllerId, name Key, Object.EInputEvent Event, float AmountDepressed, bool bGamepad)

Called from DebugCameraInput Process an input key event routed through unrealscript from another object. This method is assigned as the value for the OnRecievedNativeInputKey delegate so that native input events are routed to this unrealscript function.

Parameters:

  • ControllerId - the controller that generated this input key event
  • Key - the name of the key which an event occured for (KEY_Up, KEY_Down, etc.)
  • EventType - the type of event which occured (pressed, released, etc.)
  • AmountDepressed - for analog keys, the depression percent.

Returns:

true to consume the key event, false to pass it on.

OnActivate[edit]

function OnActivate (PlayerController PC)


OnDeactivate[edit]

function OnDeactivate (PlayerController PC)

Function called on deactivation debug camera controller

States[edit]

PlayerWaiting[edit]

Inherits from: PlayerController.PlayerWaiting

Modifiers: auto

PlayerWaiting.PlayerMove[edit]

function PlayerMove (float DeltaTime)

Overrides: PlayerController.BaseSpectating.PlayerMove


Retrieved from "https://wiki.beyondunreal.com/UE3:DebugCameraController_(UDK)?oldid=40791"