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

237 lines
6.1 KiB
YAML
Raw Normal View History

2025-04-16 19:20:36 -04:00
### YamlMime:ManagedReference
items:
2025-04-16 19:57:54 -04:00
- uid: Player.Punch
commentId: T:Player.Punch
2025-04-16 19:20:36 -04:00
id: Punch
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.Punch.cancelable
- Player.Punch.DisableCancellation
- Player.Punch.DisableHurtbox
- Player.Punch.EnableCancellation
- Player.Punch.EnableHurtbox
- Player.Punch.ReturnToMaxSpeed
2025-04-16 19:20:36 -04:00
langs:
- csharp
- vb
name: Punch
nameWithType: Punch
2025-04-16 19:57:54 -04:00
fullName: Player.Punch
2025-04-16 19:20:36 -04:00
type: Class
source:
id: Punch
path: ''
2025-04-19 12:59:07 -04:00
startLine: 3471
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 the punching mechanic for the player, including triggering animations,\nenabling and disabling the hurtbox, and managing player speed during a punch.\n"
example: []
2025-04-16 19:20:36 -04:00
syntax:
content: 'public class Punch : MonoBehaviour'
content.vb: Public Class Punch Inherits MonoBehaviour
inheritance:
- System.Object
2025-04-16 19:57:54 -04:00
- uid: Player.Punch.cancelable
commentId: F:Player.Punch.cancelable
2025-04-16 19:20:36 -04:00
id: cancelable
2025-04-16 19:57:54 -04:00
parent: Player.Punch
2025-04-16 19:20:36 -04:00
langs:
- csharp
- vb
name: cancelable
nameWithType: Punch.cancelable
2025-04-16 19:57:54 -04:00
fullName: Player.Punch.cancelable
2025-04-16 19:20:36 -04:00
type: Field
source:
id: cancelable
path: ''
2025-04-19 12:59:07 -04:00
startLine: 3478
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 the player can cancel their punch action.\n"
example: []
2025-04-16 19:20:36 -04:00
syntax:
content: public bool cancelable
return:
type: System.Boolean
content.vb: Public cancelable As Boolean
2025-04-16 19:57:54 -04:00
- uid: Player.Punch.EnableHurtbox
commentId: M:Player.Punch.EnableHurtbox
2025-04-16 19:20:36 -04:00
id: EnableHurtbox
2025-04-16 19:57:54 -04:00
parent: Player.Punch
2025-04-16 19:20:36 -04:00
langs:
- csharp
- vb
name: EnableHurtbox()
nameWithType: Punch.EnableHurtbox()
2025-04-16 19:57:54 -04:00
fullName: Player.Punch.EnableHurtbox()
2025-04-16 19:20:36 -04:00
type: Method
source:
id: EnableHurtbox
path: ''
2025-04-19 12:59:07 -04:00
startLine: 3529
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: "\nEnables the hurtbox, allowing the punch to interact with other objects.\n"
example: []
2025-04-16 19:20:36 -04:00
syntax:
content: public void EnableHurtbox()
content.vb: Public Sub EnableHurtbox()
2025-04-16 19:57:54 -04:00
overload: Player.Punch.EnableHurtbox*
- uid: Player.Punch.DisableHurtbox
commentId: M:Player.Punch.DisableHurtbox
2025-04-16 19:20:36 -04:00
id: DisableHurtbox
2025-04-16 19:57:54 -04:00
parent: Player.Punch
2025-04-16 19:20:36 -04:00
langs:
- csharp
- vb
name: DisableHurtbox()
nameWithType: Punch.DisableHurtbox()
2025-04-16 19:57:54 -04:00
fullName: Player.Punch.DisableHurtbox()
2025-04-16 19:20:36 -04:00
type: Method
source:
id: DisableHurtbox
path: ''
2025-04-19 12:59:07 -04:00
startLine: 3537
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: "\nDisables the hurtbox, preventing the punch from interacting with other objects.\n"
example: []
2025-04-16 19:20:36 -04:00
syntax:
content: public void DisableHurtbox()
content.vb: Public Sub DisableHurtbox()
2025-04-16 19:57:54 -04:00
overload: Player.Punch.DisableHurtbox*
- uid: Player.Punch.DisableCancellation
commentId: M:Player.Punch.DisableCancellation
2025-04-16 19:20:36 -04:00
id: DisableCancellation
2025-04-16 19:57:54 -04:00
parent: Player.Punch
2025-04-16 19:20:36 -04:00
langs:
- csharp
- vb
name: DisableCancellation()
nameWithType: Punch.DisableCancellation()
2025-04-16 19:57:54 -04:00
fullName: Player.Punch.DisableCancellation()
2025-04-16 19:20:36 -04:00
type: Method
source:
id: DisableCancellation
path: ''
2025-04-19 12:59:07 -04:00
startLine: 3545
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: "\nDisables the ability to cancel the punch action.\n"
example: []
2025-04-16 19:20:36 -04:00
syntax:
content: public void DisableCancellation()
content.vb: Public Sub DisableCancellation()
2025-04-16 19:57:54 -04:00
overload: Player.Punch.DisableCancellation*
- uid: Player.Punch.EnableCancellation
commentId: M:Player.Punch.EnableCancellation
2025-04-16 19:20:36 -04:00
id: EnableCancellation
2025-04-16 19:57:54 -04:00
parent: Player.Punch
2025-04-16 19:20:36 -04:00
langs:
- csharp
- vb
name: EnableCancellation()
nameWithType: Punch.EnableCancellation()
2025-04-16 19:57:54 -04:00
fullName: Player.Punch.EnableCancellation()
2025-04-16 19:20:36 -04:00
type: Method
source:
id: EnableCancellation
path: ''
2025-04-19 12:59:07 -04:00
startLine: 3553
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: "\nEnables the ability to cancel the punch action.\n"
example: []
2025-04-16 19:20:36 -04:00
syntax:
content: public void EnableCancellation()
content.vb: Public Sub EnableCancellation()
2025-04-16 19:57:54 -04:00
overload: Player.Punch.EnableCancellation*
- uid: Player.Punch.ReturnToMaxSpeed
commentId: M:Player.Punch.ReturnToMaxSpeed
2025-04-16 19:20:36 -04:00
id: ReturnToMaxSpeed
2025-04-16 19:57:54 -04:00
parent: Player.Punch
2025-04-16 19:20:36 -04:00
langs:
- csharp
- vb
name: ReturnToMaxSpeed()
nameWithType: Punch.ReturnToMaxSpeed()
2025-04-16 19:57:54 -04:00
fullName: Player.Punch.ReturnToMaxSpeed()
2025-04-16 19:20:36 -04:00
type: Method
source:
id: ReturnToMaxSpeed
path: ''
2025-04-19 12:59:07 -04:00
startLine: 3561
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: "\nResets the player's movement speed to its maximum value after the punch is complete.\n"
example: []
2025-04-16 19:20:36 -04:00
syntax:
content: public void ReturnToMaxSpeed()
content.vb: Public Sub ReturnToMaxSpeed()
2025-04-16 19:57:54 -04:00
overload: Player.Punch.ReturnToMaxSpeed*
2025-04-16 19:20:36 -04:00
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: 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
2025-04-16 19:57:54 -04:00
- uid: Player.Punch.EnableHurtbox*
commentId: Overload:Player.Punch.EnableHurtbox
2025-04-16 19:20:36 -04:00
name: EnableHurtbox
nameWithType: Punch.EnableHurtbox
2025-04-16 19:57:54 -04:00
fullName: Player.Punch.EnableHurtbox
- uid: Player.Punch.DisableHurtbox*
commentId: Overload:Player.Punch.DisableHurtbox
2025-04-16 19:20:36 -04:00
name: DisableHurtbox
nameWithType: Punch.DisableHurtbox
2025-04-16 19:57:54 -04:00
fullName: Player.Punch.DisableHurtbox
- uid: Player.Punch.DisableCancellation*
commentId: Overload:Player.Punch.DisableCancellation
2025-04-16 19:20:36 -04:00
name: DisableCancellation
nameWithType: Punch.DisableCancellation
2025-04-16 19:57:54 -04:00
fullName: Player.Punch.DisableCancellation
- uid: Player.Punch.EnableCancellation*
commentId: Overload:Player.Punch.EnableCancellation
2025-04-16 19:20:36 -04:00
name: EnableCancellation
nameWithType: Punch.EnableCancellation
2025-04-16 19:57:54 -04:00
fullName: Player.Punch.EnableCancellation
- uid: Player.Punch.ReturnToMaxSpeed*
commentId: Overload:Player.Punch.ReturnToMaxSpeed
2025-04-16 19:20:36 -04:00
name: ReturnToMaxSpeed
nameWithType: Punch.ReturnToMaxSpeed
2025-04-16 19:57:54 -04:00
fullName: Player.Punch.ReturnToMaxSpeed