KitStdCharacter
Character utilities.
Functions
Section titled “Functions”getCharacter
Section titled “getCharacter”function KitStdCharacter.getCharacter(): types.CharacterReturns current character if it exists. Otherwise, wait for it to be added.
Returns
Section titled “Returns”types.Character
Section titled “types.Character”`
getHumanoid
Section titled “getHumanoid”function KitStdCharacter.getHumanoid(): HumanoidReturns the character’s Humanoid if it exists. Otherwise, waits for it to be added.
Returns
Section titled “Returns”Humanoid
Section titled “Humanoid”`
getHumanoidRootPart
Section titled “getHumanoidRootPart”function KitStdCharacter.getHumanoidRootPart(): BasePartReturns the character’s HumanoidRootPart if it exists. Otherwise, wait for it to be added.
Returns
Section titled “Returns”BasePart
Section titled “BasePart”`
getMaybeCharacter
Section titled “getMaybeCharacter”function KitStdCharacter.getMaybeCharacter(): types.Character?Returns the local player’s character if it exists
Returns
Section titled “Returns”types.Character?
Section titled “types.Character?”`
getMaybeHumanoid
Section titled “getMaybeHumanoid”function KitStdCharacter.getMaybeHumanoid(): Humanoid?Returns the character’s Humanoid if it exists.
Returns
Section titled “Returns”Humanoid?
Section titled “Humanoid?”`
getMaybeHumanoidRootPart
Section titled “getMaybeHumanoidRootPart”function KitStdCharacter.getMaybeHumanoidRootPart(): BasePart?Returns the character’s HumanoidRootPart if it exists.
Returns
Section titled “Returns”BasePart?
Section titled “BasePart?”`
isCharacter
Section titled “isCharacter”function KitStdCharacter.isCharacter(character: Instance): booleanReturns true if a model is a character
Parameters
Section titled “Parameters”character : Instance
Section titled “character : Instance”Returns
Section titled “Returns”boolean
Section titled “boolean”`
isCharacterAlive
Section titled “isCharacterAlive”function KitStdCharacter.isCharacterAlive(): booleanReturns true if the character is alive.
Returns
Section titled “Returns”boolean
Section titled “boolean”`
isFromCharacter
Section titled “isFromCharacter”function KitStdCharacter.isFromCharacter(instance: Instance): booleanReturns true if the given instance is a descendant of the local character.
Parameters
Section titled “Parameters”instance : Instance
Section titled “instance : Instance”Returns
Section titled “Returns”boolean
Section titled “boolean”`
isFromMaybeCharacter
Section titled “isFromMaybeCharacter”function KitStdCharacter.isFromMaybeCharacter(instance: Instance): booleanReturns true if the character exists and the given instance is a descendant of the local character.
Parameters
Section titled “Parameters”instance : Instance
Section titled “instance : Instance”Returns
Section titled “Returns”boolean
Section titled “boolean”`
isLocalPlayerCharacter
Section titled “isLocalPlayerCharacter”function KitStdCharacter.isLocalPlayerCharacter(character: Instance): booleanReturns true if a model is the local player’s character
Parameters
Section titled “Parameters”character : Instance
Section titled “character : Instance”Returns
Section titled “Returns”boolean
Section titled “boolean”`
waitForCharacter
Section titled “waitForCharacter”function KitStdCharacter.waitForCharacter(): types.CharacterWaits for and returns the local player’s character when it is added
Returns
Section titled “Returns”types.Character
Section titled “types.Character”`