Files
Crash-Course/Documentation/api/Player.TeleportPlatform.yml

180 lines
4.4 KiB
YAML
Raw Permalink Normal View History

2025-04-16 19:20:36 -04:00
### YamlMime:ManagedReference
items:
2025-04-16 19:57:54 -04:00
- uid: Player.TeleportPlatform
commentId: T:Player.TeleportPlatform
2025-04-16 19:20:36 -04:00
id: TeleportPlatform
2025-04-16 19:57:54 -04:00
parent: Player
2025-04-16 19:20:36 -04:00
children:
2025-04-16 19:57:54 -04:00
- Player.TeleportPlatform.isPlatform
- Player.TeleportPlatform.playerTag
- Player.TeleportPlatform.teleportPoint
- Player.TeleportPlatform.teleportTag
2025-04-16 19:20:36 -04:00
langs:
- csharp
- vb
name: TeleportPlatform
nameWithType: TeleportPlatform
2025-04-16 19:57:54 -04:00
fullName: Player.TeleportPlatform
2025-04-16 19:20:36 -04:00
type: Class
source:
id: TeleportPlatform
path: ''
2025-04-19 12:59:07 -04:00
startLine: 3579
2025-04-16 19:20:36 -04:00
assemblies:
- cs.temp.dll
2025-04-16 19:57:54 -04:00
namespace: Player
2025-04-18 20:11:19 -04:00
summary: "\nThis class handles teleportation for platforms and players when they collide with the teleport trigger.\nIt can teleport either the platform itself or a player to a specified location.\n"
example: []
2025-04-16 19:20:36 -04:00
syntax:
content: 'public class TeleportPlatform : MonoBehaviour'
content.vb: Public Class TeleportPlatform Inherits MonoBehaviour
inheritance:
- System.Object
2025-04-16 19:57:54 -04:00
- uid: Player.TeleportPlatform.teleportPoint
commentId: F:Player.TeleportPlatform.teleportPoint
2025-04-16 19:20:36 -04:00
id: teleportPoint
2025-04-16 19:57:54 -04:00
parent: Player.TeleportPlatform
2025-04-16 19:20:36 -04:00
langs:
- csharp
- vb
name: teleportPoint
nameWithType: TeleportPlatform.teleportPoint
2025-04-16 19:57:54 -04:00
fullName: Player.TeleportPlatform.teleportPoint
2025-04-16 19:20:36 -04:00
type: Field
source:
id: teleportPoint
path: ''
2025-04-19 12:59:07 -04:00
startLine: 3584
2025-04-16 19:20:36 -04:00
assemblies:
- cs.temp.dll
2025-04-16 19:57:54 -04:00
namespace: Player
2025-04-18 20:11:19 -04:00
summary: "\nThe position where the platform or player will be teleported.\n"
example: []
2025-04-16 19:20:36 -04:00
syntax:
content: public Vector2 teleportPoint
return:
type: Global.Vector2
content.vb: Public teleportPoint As Vector2
2025-04-16 19:57:54 -04:00
- uid: Player.TeleportPlatform.teleportTag
commentId: F:Player.TeleportPlatform.teleportTag
2025-04-16 19:20:36 -04:00
id: teleportTag
2025-04-16 19:57:54 -04:00
parent: Player.TeleportPlatform
2025-04-16 19:20:36 -04:00
langs:
- csharp
- vb
name: teleportTag
nameWithType: TeleportPlatform.teleportTag
2025-04-16 19:57:54 -04:00
fullName: Player.TeleportPlatform.teleportTag
2025-04-16 19:20:36 -04:00
type: Field
source:
id: teleportTag
path: ''
2025-04-19 12:59:07 -04:00
startLine: 3589
2025-04-16 19:20:36 -04:00
assemblies:
- cs.temp.dll
2025-04-16 19:57:54 -04:00
namespace: Player
2025-04-18 20:11:19 -04:00
summary: "\nThe tag used to identify objects (e.g., platforms) that can trigger teleportation.\n"
example: []
2025-04-16 19:20:36 -04:00
syntax:
content: public string teleportTag
return:
type: System.String
content.vb: Public teleportTag As String
2025-04-16 19:57:54 -04:00
- uid: Player.TeleportPlatform.playerTag
commentId: F:Player.TeleportPlatform.playerTag
2025-04-16 19:20:36 -04:00
id: playerTag
2025-04-16 19:57:54 -04:00
parent: Player.TeleportPlatform
2025-04-16 19:20:36 -04:00
langs:
- csharp
- vb
name: playerTag
nameWithType: TeleportPlatform.playerTag
2025-04-16 19:57:54 -04:00
fullName: Player.TeleportPlatform.playerTag
2025-04-16 19:20:36 -04:00
type: Field
source:
id: playerTag
path: ''
2025-04-19 12:59:07 -04:00
startLine: 3594
2025-04-16 19:20:36 -04:00
assemblies:
- cs.temp.dll
2025-04-16 19:57:54 -04:00
namespace: Player
2025-04-18 20:11:19 -04:00
summary: "\nThe tag used to identify player objects.\n"
example: []
2025-04-16 19:20:36 -04:00
syntax:
content: public string playerTag
return:
type: System.String
content.vb: Public playerTag As String
2025-04-16 19:57:54 -04:00
- uid: Player.TeleportPlatform.isPlatform
commentId: F:Player.TeleportPlatform.isPlatform
2025-04-16 19:20:36 -04:00
id: isPlatform
2025-04-16 19:57:54 -04:00
parent: Player.TeleportPlatform
2025-04-16 19:20:36 -04:00
langs:
- csharp
- vb
name: isPlatform
nameWithType: TeleportPlatform.isPlatform
2025-04-16 19:57:54 -04:00
fullName: Player.TeleportPlatform.isPlatform
2025-04-16 19:20:36 -04:00
type: Field
source:
id: isPlatform
path: ''
2025-04-19 12:59:07 -04:00
startLine: 3600
2025-04-16 19:20:36 -04:00
assemblies:
- cs.temp.dll
2025-04-16 19:57:54 -04:00
namespace: Player
2025-04-18 20:11:19 -04:00
summary: "\nDetermines whether this script is handling a platform or a player.\nIf true, it teleports players. If false, it teleports the platform itself.\n"
example: []
2025-04-16 19:20:36 -04:00
syntax:
content: public bool isPlatform
return:
type: System.Boolean
content.vb: Public isPlatform As Boolean
references:
2025-04-16 19:57:54 -04:00
- uid: Player
commentId: N:Player
name: Player
nameWithType: Player
fullName: Player
2025-04-16 19:20:36 -04:00
- uid: System.Object
commentId: T:System.Object
parent: System
isExternal: true
name: object
nameWithType: object
fullName: object
nameWithType.vb: Object
fullName.vb: Object
name.vb: Object
- uid: System
commentId: N:System
isExternal: true
name: System
nameWithType: System
fullName: System
- uid: Global.Vector2
isExternal: true
name: Vector2
nameWithType: Vector2
fullName: Vector2
- uid: System.String
commentId: T:System.String
parent: System
isExternal: true
name: string
nameWithType: string
fullName: string
nameWithType.vb: String
fullName.vb: String
name.vb: String
- uid: System.Boolean
commentId: T:System.Boolean
parent: System
isExternal: true
name: bool
nameWithType: bool
fullName: bool
nameWithType.vb: Boolean
fullName.vb: Boolean
name.vb: Boolean