Skip to content
Open
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions yaml/types/NPC.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -130,14 +130,14 @@ Properties:
IsReadOnly: true
IsObsolete: false
IsStatic: false
Description: Indicates if NPC is standing on ground.
Description: Indicates if the NPC is standing on the ground.
- Name: IsOnCeiling
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: true
IsObsolete: false
IsStatic: false
Description: Indicates if NPC is on the ceiling.
Description: Indicates if the NPC is on the ceiling.
- Name: NavDestinationDistance
Type: number
IsAccessibleByScripts: true
Expand Down Expand Up @@ -170,7 +170,7 @@ Methods:
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Move this NPC while respecting collisions.
Description: Moves this NPC while respecting collisions.
- Name: Kill
ReturnType: nil
Parameters: []
Expand All @@ -184,7 +184,7 @@ Methods:
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Try to detect stairs and step up. Returns true if the NPC has stepped up.
Description: Tries to detect stairs and step up. Returns true if the NPC has stepped up.
- Name: Jump
ReturnType: nil
Parameters: []
Expand Down
4 changes: 2 additions & 2 deletions yaml/types/NetworkEvent.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Name: NetworkEvent
Description: NetworkEvents are events that can be called to communicate between
server and client. NetMessages are the class used for sharing data between
server and client. NetMessages are the classes used for sharing data between
Comment thread
thepotato0 marked this conversation as resolved.
Outdated
server and client when sending NetworkEvents.
Category: networking
BaseType: Instance
Expand All @@ -12,7 +12,7 @@ Properties:
IsObsolete: false
IsStatic: false
Description: Determines if this network event should send messages reliably.
Recommended to be off if you're passing lot of data that doesn't need to
Recommended to be off if you're passing a lot of data that doesn't need to
arrive reliably.
Methods:
- Name: InvokeServer
Expand Down
2 changes: 1 addition & 1 deletion yaml/types/NetworkedObject.yaml
Comment thread
thepotato0 marked this conversation as resolved.
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Name: NetworkedObject
Description: NetworkedObject is a base class for all object that's synchronized
Description: NetworkedObject is a base class for every object that is synchronized
by the network.
Category: networking
BaseType: null
Expand Down
2 changes: 1 addition & 1 deletion yaml/types/NewServerRequestData.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Properties:
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: How much player slot should the new server allocates for.
Description: How many player slots the new server should allocate for.
Methods:
- Name: New
ReturnType: NewServerRequestData
Expand Down
12 changes: 6 additions & 6 deletions yaml/types/PTSignal.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Name: PTSignal
Description: A signal which scripts can subscribe to
Description: A signal which scripts can subscribe to.
Category: scripting
BaseType: null
Properties: []
Expand All @@ -14,7 +14,7 @@ Methods:
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Connect a function to this signal
Description: Connects a function to this signal.
- Name: Disconnect
ReturnType: nil
Parameters:
Expand All @@ -25,14 +25,14 @@ Methods:
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Disconnect a function from this signal
Description: Disconnects a function from this signal.
- Name: Wait
ReturnType: any
Parameters: []
IsAsync: true
IsObsolete: false
IsStatic: false
Description: Wait until this signal's emitted
Description: Waits until this signal is emitted.
- Name: Once
ReturnType: nil
Parameters:
Expand All @@ -43,9 +43,9 @@ Methods:
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Listen to this signal only once
Description: Listens to this signal only once.
Events: []
IsStatic: false
IsAbstract: false
IsInstantiable: false
StaticAlias: null
StaticAlias: null
16 changes: 8 additions & 8 deletions yaml/types/Particles.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -59,14 +59,14 @@ Properties:
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determines the velocity direction
Description: Determines the velocity direction.
- Name: InitialVelocity
Type: NumberRange
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determines the initial velocity
Description: Determines the initial velocity.
- Name: StartRotation
Type: NumberRange
IsAccessibleByScripts: true
Expand All @@ -80,28 +80,28 @@ Properties:
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determines the spread angle of the velocity
Description: Determines the spread angle of the velocity.
- Name: Flatness
Type: number
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determines how flat the spread angle should be
Description: Determines how flat the spread angle should be.
- Name: Scale
Type: NumberRange
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determine the initial scale range
Description: Determines the initial scale range.
- Name: HueVariation
Type: NumberRange
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determine the hue variation
Description: Determines the hue variation.
- Name: BlendMode
Type: BlendModeEnum
IsAccessibleByScripts: true
Expand All @@ -122,14 +122,14 @@ Properties:
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determines the emission shape of this particle
Description: Determines the emission shape of this particle.
- Name: EmissionShapeScale
Type: Vector3
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determines the emission shape's scale
Description: Determines the emission shape's scale.
- Name: SimulationSpace
Type: ParticleSimulationSpaceEnum
IsAccessibleByScripts: true
Expand Down
18 changes: 9 additions & 9 deletions yaml/types/Physical.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ Methods:
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Get all objects that's currently in contact with this object.
Description: Get all objects that are currently in contact with this object.
- Name: MovePosition
ReturnType: nil
Parameters:
Expand Down Expand Up @@ -86,7 +86,7 @@ Methods:
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Add force to this physical
Description: Adds force to this physical.
- Name: AddTorque
ReturnType: nil
Parameters:
Expand All @@ -101,7 +101,7 @@ Methods:
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Add torque to this physical
Description: Adds torque to this physical.
- Name: AddForceAtPosition
ReturnType: nil
Parameters:
Expand All @@ -120,7 +120,7 @@ Methods:
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Add force at position to this physical
Description: Adds force at position to this physical.
- Name: AddRelativeForce
ReturnType: nil
Parameters:
Expand All @@ -135,7 +135,7 @@ Methods:
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Add relative force to this physical
Description: Adds relative force to this physical.
- Name: AddRelativeTorque
ReturnType: nil
Parameters:
Expand All @@ -150,15 +150,15 @@ Methods:
IsAsync: false
IsObsolete: false
IsStatic: false
Description: Add relative torque to this physical
Description: Adds relative torque to this physical.
Events:
- Name: Touched
Parameters:
- Name: physical
Type: Physical
IsOptional: false
DefaultValue: null
Description: Fires when this object has collide with other object
Description: Fires when this object has collided with other objects.
Arguments:
Name: hit
Type: Physical
Expand All @@ -168,7 +168,7 @@ Events:
Type: Physical
IsOptional: false
DefaultValue: null
Description: Fires when this object has stopped colliding with other object
Description: Fires when this object has stopped colliding with other objects.
Arguments:
Name: hit
Type: Physical
Expand All @@ -186,7 +186,7 @@ Events:
Type: Player
IsOptional: false
DefaultValue: null
Description: Fires when this object has been clicked by a player
Description: Fires when this object has been clicked by a player.
Arguments:
Name: player
Type: Player
Expand Down
16 changes: 8 additions & 8 deletions yaml/types/Player.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -93,21 +93,21 @@ Properties:
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: If true, animation will not stop when player starts moving
Description: If true, animation will not stop when the player starts moving.
- Name: Team
Type: Team
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Player's assigned team
Description: The player's assigned team.
- Name: MovementMode
Type: PlayerMovementModeEnum
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determine the movement mode for the player.
Description: Determines the movement mode for the player.
- Name: NetworkPing
Type: number
IsAccessibleByScripts: true
Expand Down Expand Up @@ -218,7 +218,7 @@ Events:
Type: string
IsOptional: false
DefaultValue: null
Description: Fires when this player chats
Description: Fires when this player chats.
Arguments:
Name: message
Type: string
Expand All @@ -232,21 +232,21 @@ Events:
Type: any
IsOptional: false
DefaultValue: null
Description: Fires when stat value has changed
Description: Fires when a stat value has changed.
Arguments: ""
- Name: TeamChanged
Parameters:
- Name: team
Type: Team
IsOptional: false
DefaultValue: null
Description: Fires when player has been assigned a team
Description: Fires when a player has been assigned a team.
Arguments: ""
- Name: Respawned
Parameters: null
Description: Fires when this player has respawned
Description: Fires when this player has respawned.
Arguments: ""
IsStatic: false
IsAbstract: false
IsInstantiable: false
StaticAlias: null
StaticAlias: null
13 changes: 5 additions & 8 deletions yaml/types/PlayerDefaults.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
Name: PlayerDefaults
Description: PlayerDefaults is a service used for storing the default values of
the Player when created.
Description: PlayerDefaults is a service used for storing the default values of the Player when created.
Category: game
BaseType: HiddenBase
Properties:
Expand Down Expand Up @@ -115,23 +114,21 @@ Properties:
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determines whether the player's appearance is automatically loaded
by default.
Description: Determines whether the player's appearance is automatically loaded by default.
- Name: LoadAppearanceTools
Type: boolean
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determines whether the player's equippable appearance tool should
be loaded.
Description: Determines whether the player's equippable appearance tool should be loaded.
- Name: MovementMode
Type: PlayerMovementModeEnum
IsAccessibleByScripts: true
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determine the movement mode for the player.
Description: Determines the movement mode for the player.
Methods:
- Name: LoadDefaults
ReturnType: nil
Expand All @@ -144,4 +141,4 @@ Events: []
IsStatic: true
IsAbstract: false
IsInstantiable: false
StaticAlias: PlayerDefaults
StaticAlias: PlayerDefaults
9 changes: 4 additions & 5 deletions yaml/types/Players.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,7 @@ Properties:
IsReadOnly: false
IsObsolete: false
IsStatic: false
Description: Determines whether or not server should trust the client for
adjusting player's properties. Enabling this is recommended.
Description: Determines whether or not the server should trust the client for adjusting the player's properties. Enabling this is recommended.
- Name: PlayersCount
Type: number
IsAccessibleByScripts: true
Expand Down Expand Up @@ -69,7 +68,7 @@ Events:
Type: Player
IsOptional: false
DefaultValue: null
Description: Fires when player has connected
Description: Fires when a player has been connected.
Arguments:
Name: player
Type: Player
Expand All @@ -79,11 +78,11 @@ Events:
Type: Player
IsOptional: false
DefaultValue: null
Description: Fires when player has disconnected
Description: Fires when a player has been disconnected.
Arguments:
Name: player
Type: Player
IsStatic: true
IsAbstract: false
IsInstantiable: false
StaticAlias: Players
StaticAlias: Players
Loading