Difference between revisions of "UE2:ONSPowerCore internal variables (UT2004)"

Revision as of 10:11, 17 May 2008 (edit) Wormbo (Talk | contribs) (Auto-generated page)		Revision as of 11:21, 3 July 2010 (edit) (undo) Wormbo (Talk | contribs) m (added descriptions) Newer edit →
Line 10:		Line 10:
	| parent7 = Object		| parent7 = Object
	}}		}}
−	{{autogenerated}}	+	{{expand}}
	==Internal variables==		==Internal variables==
	====BlueActiveSkins====		====BlueActiveSkins====
	'''Type:''' [[array]]<{{cl|Material}}>		'''Type:''' [[array]]<{{cl|Material}}>
−	<!-- enter variable description -->	+	{{tl|Skins||Actor properties}} for when the core/node is active and owned by the blue team.
	'''Default value, index 0:''' {{cl|Material}}'ONSstructureTextures.CoreGroup.COREDiffTEX'		'''Default value, index 0:''' {{cl|Material}}'ONSstructureTextures.CoreGroup.COREDiffTEX'
Line 24:		Line 24:
	'''Type:''' [[array]]<{{cl|Material}}>		'''Type:''' [[array]]<{{cl|Material}}>
−	<!-- enter variable description -->	+	{{tl|Skins||Actor properties}} for when the core/node is being built by the blue team.
	'''Default value, index 0:''' {{cl|FinalBlend}}'ONSstructureTextures.CoreConstructionBlue'		'''Default value, index 0:''' {{cl|FinalBlend}}'ONSstructureTextures.CoreConstructionBlue'
Line 33:		Line 33:
	'''Type:''' [[bool]]		'''Type:''' [[bool]]
−	<!-- enter variable description -->	+	Whether the core or node was previously under attack.
	====bPoweredByBlue====		====bPoweredByBlue====
	'''Type:''' [[bool]]		'''Type:''' [[bool]]
−	<!-- enter variable description -->	+	Whether the blue team built a link chain from their core to this node.
	====bPoweredByRed====		====bPoweredByRed====
	'''Type:''' [[bool]]		'''Type:''' [[bool]]
−	<!-- enter variable description -->	+	Whether the red team built a link chain from their core to this node.
	====bSevered====		====bSevered====
	'''Type:''' [[bool]]		'''Type:''' [[bool]]
−	<!-- enter variable description -->	+	Whether the node has a link chain to its owning team's core. Nodes owned by a team, but not linked to that teams power core will take damage while they are isolated.
	====bShowNodeBeams====		====bShowNodeBeams====
Line 55:		Line 55:
	'''[[Variables#Modifiers|Modifiers]]:''' globalconfig		'''[[Variables#Modifiers|Modifiers]]:''' globalconfig
−	<!-- enter variable description -->	+	Whether to show sky beams above nodes that can be attacked by the enemy team.
	'''Default value:''' True		'''Default value:''' True
Line 62:		Line 62:
	'''Type:''' [[bool]]		'''Type:''' [[bool]]
−	<!-- enter variable description -->	+	Whether this node or core is currently under attack by the enemy team.
	====CloseActors====		====CloseActors====
	'''Type:''' [[array]]<{{cl|Actor}}>		'''Type:''' [[array]]<{{cl|Actor}}>
−	<!-- enter variable description -->	+	A list of actors specifically associated with this node or core. Only contains actors of type {{cl|PlayerStart}}, {{cl|ONSVehicleFactory}}, {{cl|ONSStationaryWeaponPawn}} and {{cl|xTeamBanner}}. Clientsidely only team banners are in this list.
	====ConstructedEvent====		====ConstructedEvent====
Line 74:		Line 74:
	'''[[Static arrays|Array size]]:''' 2		'''[[Static arrays|Array size]]:''' 2
−	<!-- enter variable description -->	+	This event is triggered when the node has been successfully constructed.
	'''Default value, index 0:''' "red_powercore_constructed"		'''Default value, index 0:''' "red_powercore_constructed"
Line 83:		Line 83:
	'''Type:''' [[float]]		'''Type:''' [[float]]
−	<!-- enter variable description -->	+	How much time it took to construct the node. This value isn't actually used anywhere in the code, except that it is set to zero at the start of the construction process and updated until the node is either built or destroyed.
	====Constructor====		====Constructor====
	'''Type:''' {{cl|Controller}}		'''Type:''' {{cl|Controller}}
−	player who touched me to start construction	+	The player who initially started construction by touching the node.
	====CoreStage====		====CoreStage====
	'''Type:''' [[byte]]		'''Type:''' [[byte]]
−	<!-- enter variable description -->	+	The current status of the power core or node.
		+	; 0 - active: This node can unlock neutral or enemy nodes for attack or capture by the owning team
		+	; 1 - destroyed: This node or core was just destroyed. Power nodes will switch to the neutral stage after a short delay. A destroyed power core obviously ends the round.
		+	; 2 - constructing: This node is currently being constructed. It is owned by the constructing team, but does not power any of its associated actors or linked nodes yet.
		+	; 4 - neutral: The node is not owned by any team.
		+	; 5 - taken: Temporary stage right after a player touched an available neutral node. The node will switch to the constructing stage after a short delay.
		+	; 250 - invalid: An impossible CoreStage values used only in the {{tl|LastCoreStage}} variable to be different from any initial core stage.
		+	; 255 - disabled: This node is currently disabled because it is not linked to any other cores or nodes. Disabled nodes do not show up in the level or on the radar map, except for the link designer.
	====DestroyedEvent====		====DestroyedEvent====
Line 100:		Line 107:
	'''[[Static arrays|Array size]]:''' 4		'''[[Static arrays|Array size]]:''' 4
−	<!-- enter variable description -->	+	This event is triggered when the core or node is destroyed. As the default values suggest, index 0 and 1 apply to active nodes or cores, while index 2 and 3 apply to constructing power nodes.
	'''Default value, index 0:''' "red_powercore_destroyed"		'''Default value, index 0:''' "red_powercore_destroyed"
Line 113:		Line 120:
	'''Type:''' [[int]]		'''Type:''' [[int]]
−	base switch for ONSOnslaughtMessage	+	Message switch for {{cl|ONSOnslaughtMessage}} when the core or node is destroyed. The team index is added to this number to get the actual message switch.
	'''Default value:''' 14		'''Default value:''' 14
Line 127:		Line 134:
	'''[[Static arrays|Array size]]:''' 2		'''[[Static arrays|Array size]]:''' 2
−	<!-- enter variable description -->	+	The link distance to the power cores of both teams. This is used to determine the best power node to spawn from if the player didn't select any specific node.
	'''Default value, index 0:''' 255		'''Default value, index 0:''' 255
Line 136:		Line 143:
	'''Type:''' [[float]]		'''Type:''' [[float]]
−	<!-- enter variable description -->	+	The last time when someone healed this node.
	====LastAttackAnnouncementTime====		====LastAttackAnnouncementTime====
	'''Type:''' [[float]]		'''Type:''' [[float]]
−	<!-- enter variable description -->	+	The last time an attack on this node or core was announced. Audio announcements for attacks on the same node or core are only played every 10 seconds.
	====LastAttacker====		====LastAttacker====
	'''Type:''' {{cl|Pawn}}		'''Type:''' {{cl|Pawn}}
−	<!-- enter variable description -->	+	The player who last damaged this node or core. Used by the AI.
	====LastAttackExpirationTime====		====LastAttackExpirationTime====
	'''Type:''' [[float]]		'''Type:''' [[float]]
−	<!-- enter variable description -->	+	How long to consider the node or core as "under attack". Players may not respawn at nodes under attack.
	'''Default value:''' 5.0		'''Default value:''' 5.0
Line 158:		Line 165:
	'''Type:''' [[float]]		'''Type:''' [[float]]
−	<!-- enter variable description -->	+	The last time the attack message was sent. The message is sent only once every second for attacks on the same node or core.
	====LastAttackTime====		====LastAttackTime====
	'''Type:''' [[float]]		'''Type:''' [[float]]
−	<!-- enter variable description -->	+	The last time someone damaged this node or core.
	====LastCoreStage====		====LastCoreStage====
	'''Type:''' [[byte]]		'''Type:''' [[byte]]
−	<!-- enter variable description -->	+	The previous {{tl|CoreStage}}. Used only in {{tl|PostNetReceive||ONSPowerCore}}() to detect clientside core stage changes.
	'''Default value:''' 250		'''Default value:''' 250
Line 175:		Line 182:
	'''Type:''' {{cl|PlayerReplicationInfo}}		'''Type:''' {{cl|PlayerReplicationInfo}}
−	<!-- enter variable description -->	+	The last player who damaged this node.
	====LastDefenderTeamIndex====		====LastDefenderTeamIndex====
	'''Type:''' [[byte]]		'''Type:''' [[byte]]
−	<!-- enter variable description -->	+	Last value of {{tl|DefenderTeamIndex||GameObjective properties}}. Used only in {{tl|PostNetReceive||ONSPowerCore}}() to detect team changes clientsidely.
	'''Default value:''' 2		'''Default value:''' 2
Line 187:		Line 194:
	'''Type:''' {{cl|Controller}}		'''Type:''' {{cl|Controller}}
−	<!-- enter variable description -->	+	Last player who healed this power node.
	====LinkedNodes====		====LinkedNodes====
	'''Type:''' [[array]]<[[name]]>		'''Type:''' [[array]]<[[name]]>
−	<!-- enter variable description -->	+	The names of power nodes or cores this node or core is linked to in the power link setup.
	====NextCore====		====NextCore====
	'''Type:''' {{cl|ONSPowerCore}}		'''Type:''' {{cl|ONSPowerCore}}
−	link it :P  -- rjp	+	Next item in the circular [[linked list]] of all power nodes and cores.
	====NodeBeamEffect====		====NodeBeamEffect====
	'''Type:''' {{cl|Emitter}}		'''Type:''' {{cl|Emitter}}
−	<!-- enter variable description -->	+	The sky beam effect emitter.
	====NodeHealEffect====		====NodeHealEffect====
	'''Type:''' {{cl|ONSNodeHealEffect}}		'''Type:''' {{cl|ONSNodeHealEffect}}
−	<!-- enter variable description -->	+	The node heal effect emitter.
	====NodeNum====		====NodeNum====
	'''Type:''' [[int]]		'''Type:''' [[int]]
−	<!-- enter variable description -->	+	This power node's unique number in the level.
	====PowerLinks====		====PowerLinks====
	'''Type:''' [[array]]<{{cl|ONSPowerCore}}>		'''Type:''' [[array]]<{{cl|ONSPowerCore}}>
−	<!-- enter variable description -->	+	Power nodes and cores this node or core is linked to via the power link setup.
	====RedActiveSkins====		====RedActiveSkins====
	'''Type:''' [[array]]<{{cl|Material}}>		'''Type:''' [[array]]<{{cl|Material}}>
−	<!-- enter variable description -->	+	{{tl|Skins||Actor properties}} for when the core/node is active and owned by the red team.
	'''Default value, index 0:''' {{cl|Material}}'ONSstructureTextures.CoreGroup.COREDiffTEX'		'''Default value, index 0:''' {{cl|Material}}'ONSstructureTextures.CoreGroup.COREDiffTEX'
Line 231:		Line 238:
	'''Type:''' [[array]]<{{cl|Material}}>		'''Type:''' [[array]]<{{cl|Material}}>
−	<!-- enter variable description -->	+	{{tl|Skins||Actor properties}} for when the core/node is being built by the red team.
	'''Default value, index 0:''' {{cl|FinalBlend}}'ONSstructureTextures.CoreConstructionRed'		'''Default value, index 0:''' {{cl|FinalBlend}}'ONSstructureTextures.CoreConstructionRed'
Line 240:		Line 247:
	'''Type:''' {{cl|ONSFreeRoamingEnergyEffect}}		'''Type:''' {{cl|ONSFreeRoamingEnergyEffect}}
−	<!-- enter variable description -->	+	The emitter effect on available neutral nodes.
	====SeveredDamagePerSecond====		====SeveredDamagePerSecond====
	'''Type:''' [[float]]		'''Type:''' [[float]]
−	<!-- enter variable description -->	+	How much damage the node takes when it is active, but no longer directly connected to the owning team's power core.
	'''Default value:''' 30.0		'''Default value:''' 30.0
Line 252:		Line 259:
	'''Type:''' {{cl|ONSPowerCoreShield}}		'''Type:''' {{cl|ONSPowerCoreShield}}
−	<!-- enter variable description -->	+	The shield around nodes or cores not attackable by the enemy team.
	====ShieldClass====		====ShieldClass====
	'''Type:''' [[class]]<{{cl|ONSPowerCoreShield}}>		'''Type:''' [[class]]<{{cl|ONSPowerCoreShield}}>
−	<!-- enter variable description -->	+	The shield class to use for this node or core.
	'''Default value:''' [[Types#Class|Class]]'{{cl|ONSPowerCoreShield|Onslaught}}'		'''Default value:''' [[Types#Class|Class]]'{{cl|ONSPowerCoreShield|Onslaught}}'
Line 264:		Line 271:
	'''Type:''' {{tl|Vector|Object|structs}}		'''Type:''' {{tl|Vector|Object|structs}}
−	<!-- enter variable description -->	+	Where the shield should be placed in relation to the node or core location
	====TeleportPads====		====TeleportPads====
	'''Type:''' [[array]]<{{cl|ONSTeleportPad}}>		'''Type:''' [[array]]<{{cl|ONSTeleportPad}}>
−	<!-- enter variable description -->	+	Teleporter pads associated with this power node or core.
	====TeleportTrigger====		====TeleportTrigger====
	'''Type:''' {{cl|Triggers}}		'''Type:''' {{cl|Triggers}}
−	<!-- enter variable description -->	+	A trigger actor at the power core that allows teleporting to other nodes. Power nodes don't use this because players can stand on the node to teleport.

---

Revision as of 11:21, 3 July 2010

;Other member categories for this class::instance functions

Please help improve this article or section by expanding it.

Internal variables

BlueActiveSkins

Type: array<Material>

Skins for when the core/node is active and owned by the blue team.

Default value, index 0: Material'ONSstructureTextures.CoreGroup.COREDiffTEX'

Default value, index 1: Material'ONSstructureTextures.CoreGroup.CoreLightShader'

BlueConstructingSkins

Type: array<Material>

Skins for when the core/node is being built by the blue team.

Default value, index 0: FinalBlend'ONSstructureTextures.CoreConstructionBlue'

Default value, index 1: FinalBlend'ONSstructureTextures.CoreGroup.InvisibleFinal'

bOldUnderAttack

Type: bool

Whether the core or node was previously under attack.

bPoweredByBlue

Type: bool

Whether the blue team built a link chain from their core to this node.

bPoweredByRed

Type: bool

Whether the red team built a link chain from their core to this node.

bSevered

Type: bool

Whether the node has a link chain to its owning team's core. Nodes owned by a team, but not linked to that teams power core will take damage while they are isolated.

bShowNodeBeams

Type: bool

Modifiers: globalconfig

Whether to show sky beams above nodes that can be attacked by the enemy team.

Default value: True

bUnderAttack

Type: bool

Whether this node or core is currently under attack by the enemy team.

CloseActors

Type: array<Actor>

A list of actors specifically associated with this node or core. Only contains actors of type PlayerStart, ONSVehicleFactory, ONSStationaryWeaponPawn and xTeamBanner. Clientsidely only team banners are in this list.

ConstructedEvent

Type: string

Array size: 2

This event is triggered when the node has been successfully constructed.

Default value, index 0: "red_powercore_constructed"

Default value, index 1: "blue_powercore_constructed"

ConstructionTimeElapsed

Type: float

How much time it took to construct the node. This value isn't actually used anywhere in the code, except that it is set to zero at the start of the construction process and updated until the node is either built or destroyed.

Constructor

Type: Controller

The player who initially started construction by touching the node.

CoreStage

Type: byte

The current status of the power core or node.

0 - active

This node can unlock neutral or enemy nodes for attack or capture by the owning team

1 - destroyed

This node or core was just destroyed. Power nodes will switch to the neutral stage after a short delay. A destroyed power core obviously ends the round.

2 - constructing

This node is currently being constructed. It is owned by the constructing team, but does not power any of its associated actors or linked nodes yet.

4 - neutral

The node is not owned by any team.

5 - taken

Temporary stage right after a player touched an available neutral node. The node will switch to the constructing stage after a short delay.

250 - invalid

An impossible CoreStage values used only in the LastCoreStage variable to be different from any initial core stage.

255 - disabled

This node is currently disabled because it is not linked to any other cores or nodes. Disabled nodes do not show up in the level or on the radar map, except for the link designer.

DestroyedEvent

Type: string

Array size: 4

This event is triggered when the core or node is destroyed. As the default values suggest, index 0 and 1 apply to active nodes or cores, while index 2 and 3 apply to constructing power nodes.

Default value, index 0: "red_powercore_destroyed"

Default value, index 1: "blue_powercore_destroyed"

Default value, index 2: "red_constructing_powercore_destroyed"

Default value, index 3: "blue_constructing_powercore_destroyed"

DestructionMessageIndex

Type: int

Message switch for ONSOnslaughtMessage when the core or node is destroyed. The team index is added to this number to get the actual message switch.

Default value: 14

ExplosionEffect

Type: Emitter

FinalCoreDistance

Type: byte

Array size: 2

The link distance to the power cores of both teams. This is used to determine the best power node to spawn from if the player didn't select any specific node.

Default value, index 0: 255

Default value, index 1: 255

HealingTime

Type: float

The last time when someone healed this node.

LastAttackAnnouncementTime

Type: float

The last time an attack on this node or core was announced. Audio announcements for attacks on the same node or core are only played every 10 seconds.

LastAttacker

Type: Pawn

The player who last damaged this node or core. Used by the AI.

LastAttackExpirationTime

Type: float

How long to consider the node or core as "under attack". Players may not respawn at nodes under attack.

Default value: 5.0

LastAttackMessageTime

Type: float

The last time the attack message was sent. The message is sent only once every second for attacks on the same node or core.

LastAttackTime

Type: float

The last time someone damaged this node or core.

LastCoreStage

Type: byte

The previous CoreStage. Used only in PostNetReceive() to detect clientside core stage changes.

Default value: 250

LastDamagedBy

Type: PlayerReplicationInfo

The last player who damaged this node.

LastDefenderTeamIndex

Type: byte

Last value of DefenderTeamIndex. Used only in PostNetReceive() to detect team changes clientsidely.

Default value: 2

LastHealedBy

Type: Controller

Last player who healed this power node.

LinkedNodes

Type: array<name>

The names of power nodes or cores this node or core is linked to in the power link setup.

NextCore

Type: ONSPowerCore

Next item in the circular linked list of all power nodes and cores.

NodeBeamEffect

Type: Emitter

The sky beam effect emitter.

NodeHealEffect

Type: ONSNodeHealEffect

The node heal effect emitter.

NodeNum

Type: int

This power node's unique number in the level.

PowerLinks

Type: array<ONSPowerCore>

Power nodes and cores this node or core is linked to via the power link setup.

RedActiveSkins

Type: array<Material>

Skins for when the core/node is active and owned by the red team.

Default value, index 0: Material'ONSstructureTextures.CoreGroup.COREDiffTEX'

Default value, index 1: Material'ONSstructureTextures.CoreGroup.CoreLightShader'

RedConstructingSkins

Type: array<Material>

Skins for when the core/node is being built by the red team.

Default value, index 0: FinalBlend'ONSstructureTextures.CoreConstructionRed'

Default value, index 1: FinalBlend'ONSstructureTextures.CoreGroup.InvisibleFinal'

RoamingEnergy

Type: ONSFreeRoamingEnergyEffect

The emitter effect on available neutral nodes.

SeveredDamagePerSecond

Type: float

How much damage the node takes when it is active, but no longer directly connected to the owning team's power core.

Default value: 30.0

Shield

Type: ONSPowerCoreShield

The shield around nodes or cores not attackable by the enemy team.

ShieldClass

Type: class<ONSPowerCoreShield>

The shield class to use for this node or core.

Default value: Class'Onslaught.ONSPowerCoreShield'

ShieldOffset

Type: Object.Vector

Where the shield should be placed in relation to the node or core location

TeleportPads

Type: array<ONSTeleportPad>

Teleporter pads associated with this power node or core.

TeleportTrigger

Type: Triggers

A trigger actor at the power core that allows teleporting to other nodes. Power nodes don't use this because players can stand on the node to teleport.